PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN

This content has been translated automatically. Click here to view the French version.
  • Conditions for using <Source>.CancelDeclaration
  • <Source>.CancelDeclaration 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:
Versions 15 and later
Android This function is now available for Android applications.
New in version 15
Android This function is now available for Android applications.
Android This function is now available for Android applications.
Versions 17 and later
iPhone/iPad This function is now available for iPhone/iPad applications.
New in version 17
iPhone/iPad This function is now available for iPhone/iPad applications.
iPhone/iPad This function is now available for 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.
Remark: From version 19, HFSQL is the new name of HyperFileSQL.
Example
// The Customer data file was declared beforehand in the analysis
// by HDeclareExternal
Customer.Close()
Customer.CancelDeclaration()
Syntax
<Result> = <Source>.CancelDeclaration()
<Result>: Boolean
  • True if the operation was performed,
  • False if a problem occurred. HError is used to identify the error.
<Source>: Type corresponding to the specified source
Corresponds to:
  • the name of data file (defined in the analysis). If this name is not specified, <Source>.CancelDeclaration 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 <Source>.CancelDeclaration

This function must be used ONLY when the relevant data file (or query) is not used anymore!
In the following example, <Source>.CancelDeclaration is used too soon: the content of the Table control will be completely distorted. Indeed, BuildBrowsingTable (used to fill the Table control) is run in background task in a parallel process. Therefore, <Source>.CancelDeclaration 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".

<Source>.CancelDeclaration and closing the data file

To use <Source>.CancelDeclaration on a data file, this data file must be closed.
If a query, a subquery or a view uses the data file, <Source>.CancelDeclaration cannot be executed, even after calling <Source>.Close. The queries or views that are using the data file must be freed beforehand.
Component: wd270hf.dll
Minimum version required
  • Version 25
This page is also available for…
Comments
Click [Add] to post a comment