PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US

  • 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/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
Used to:
Versions 15 and later
Android This function is now available for the Android applications.
New in version 15
Android This function is now available for the Android applications.
Android This function is now available for the Android applications.
Versions 17 and later
iPhone/iPad This function is now available for the iPhone/iPad applications.
New in version 17
iPhone/iPad This function is now available for the iPhone/iPad applications.
iPhone/iPad This function is now available for the iPhone/iPad applications.
Versions 18 and later
Android Widget This function is now available in Android Widget mode.
Universal Windows 10 App This function is now available in Windows Store apps mode.
New in version 18
Android Widget This function is now available in Android Widget mode.
Universal Windows 10 App This function is now available in Windows Store apps mode.
Android Widget This function is now available in Android Widget mode.
Universal Windows 10 App This function is now available in Windows Store apps mode.
Versions 21 and later
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
New in version 21
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Note: From version 19, HFSQL is the new name of HyperFileSQL.
// The Customer file was declared beforehand in the analysis
// by HDeclareExternal
HClose(Customer)
HCancelDeclaration(Customer)
Syntax
<Result> = HCancelDeclaration([<File Name>])
<Result>: Boolean
  • True if the operation was performed,
  • False if a problem occurred. HError is used to identify the error.
<File Name>: Optional character string (with or without quotes)
Corresponds to:
  • the name of data file (defined in the analysis). If this name is not specified, HCancelDeclaration refers to 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 table will be completely wrong. Indeed, BuildBrowsingTable (used to fill the table) is run in background task in a parallel process. Therefore, HCancelDeclaration will operate before the table is entirely filled, making this table unusable.
HExecuteSQLQuery("test", "select * from customer")
BuildBrowsingTable(TABLE_Table1, "test")
HCancelDeclaration("test")
Note: The problem can also occur with a "data source" variable. A "data source" variable declared locally in a process (button click, procedure, method, ...) ONLY exists during the execution of this code. 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 sub-query or a view is using the data file, HCancelDeclaration cannot be run even after a call to HClose. The queries or views that are using the data file must be freed beforehand.
Components
WINDEVWEBDEV - Server codeReports and Queries wd230hf.dll
Windows Mobile wp230hf.dll
Java wd230java.jar
Linux wd230hf.so
Android wd230android.jar
Minimum required version
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment