PC SOFT

ONLINE HELP
 WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
  • Conditions for using HCancelDeclaration
  • HCancelDeclaration and closing the data file
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Used to:
Example
// The Customer data file was declared beforehand in the analysis
// by HDeclareExternal
HClose(Customer)
HCancelDeclaration(Customer)
Syntax
<Result> = HCancelDeclaration([<Data file>])
<Result>: Boolean
  • True if the operation was performed,
  • False if a problem occurs. HError is used to identify the error.
<Data file>: Optional character string
Corresponds to:
  • the name of data file (defined in the analysis). If this name is not specified, HCancelDeclaration handles the last data file used.
  • the name of query or data source associated with a query (when freeing resources once HExecuteQuery or HExecuteSQLQuery has been used).
Remarks

Conditions for using HCancelDeclaration

This function must be used ONLY when the relevant data file (or query) is not used anymore!
In the following example, HCancelDeclaration is used too soon: the content of the Table control will be completely distorted. Indeed, BuildBrowsingTable (used to populate the Table control) is run in background task in a parallel process. Therefore, HCancelDeclaration will be called before the table is entirely filled, making this table unusable.
HExecuteSQLQuery("test", "select * from customer")
BuildBrowsingTable(TABLE_Table1, "test")
HCancelDeclaration("test")
Remark: The problem can also occur with a "data source" variable. A "data source" variable declared locally in a process or event (button click, procedure, method, etc.) ONLY exists while this code is run. For this reason, a "warning" is displayed when you are using this type of data source: "the data source will be destroyed at the end of this code".

HCancelDeclaration and closing the data file

To use HCancelDeclaration on a data file, this data file must be closed.
If a query, a subquery or a view uses the data file, HCancelDeclaration cannot be executed, even after calling HClose. The queries or views that are using the data file must be freed beforehand.
Component: wd270hf.dll
See also
Minimum version required
  • Version 9
This page is also available for…
Comments
How to know when table has loaded.
Is there anyway to know when the browsing table process has completed so it would be safe to do the HCancelDeclaration function?
Alan
13 Jan. 2020