HOnError (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / Managing databases / HFSQL / HFSQL functions

Operating mode of custom errors
Using a class method to customize the errors
Customizing the default error windows
Customizing default error pages

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HOnError (Function)

In french: HSurErreur

Not available with this kind of connection

Customizes the management of HFSQL errors.

WINDEV, WEBDEV and WINDEV Mobile propose an automatic management of errors. The automatic management of errors can be disabled or enabled for one or more data files, for one or more types of errors. To do so, use HOnError and specify an empty string for the name of window, page or procedure. For more details, see HFSQL error handling help.

The automatic management of errors is not available for the stored procedures.

HOnError can be used to manage the error in a stored procedure.

Onlu the loss of connection can be customized.

Example

See additional examples

// Personnalisation des erreurs de blocages
// La procédure SurErreurBlocage est appelée 
// en cas d'erreur de blocage pour tous les fichiers de données
HOnError("*", hErrLock, "SurErreurBlocage")

// Ré-activation générale de la gestion automatique
// de toutes les erreurs sur tous les fichiers de données
HOnError("*", hErrAll)

// Ré-activation générale de la gestion automatique
// des erreurs de blocage sur le fichier de données Client
HOnError("Client", hErrLock)

Syntax

<Result> = HOnError(<Data file> , <Type of error> [, <Procedure/window/page>])

<Result>: Boolean

True if the operation was successfully performed,
False otherwise. HError returns more details about the problem.

<Data file>: Character string

Name of the data file used. If this parameter is equal to "*" the customization will be applied to all data files found in the analysis or defined programmatically.

<Type of error>: Constant or combination of constants

Type of error to configure.
hErrAll Configure all previous errors (except hErrIndex).
This constant is not available.
hErrConnectionLoss Configure the errors caused by a loss of connection with the HFSQL server.
hErrDatabaseAccess Configures the access errors to an HFSQL Client/Server database (access forbidden by HNoDatabaseAccess).
This constant is not available.
hErrDuplicates Configure duplicate errors.
This constant is not available.
hErrIndex Configures indexing errors (reindexing in progress during the file access).
This constant is not available.
hErrIntegrity Configure integrity errors.
This constant is not available.
hErrLock Configure lock errors.
This constant is not available.
hErrModify Configure a modification conflict.
This constant is not available.
hErrNeedValue Configure errors caused by a required value that has not been specified (OLE DB and some Native Connectors).
This constant is not available.
hErrPassword Configure password errors (wrong password).
This constant is not available.

<Procedure/window/page>: Optional character string

Corresponds to:
Name of window or procedure to call when a <Type of error> error occurs.
Name of page or procedure to call when a <Type of error> error occurs.
Name of object method if HOnError is called in a method of this object.
Name of procedure to call when a <Type of error> error occurs.
Parameter not specified. If "Enable the automatic HFSQL help" is checked in the project, the default window or page for automatic management of errors is used for the specified type of error and for the specified data file.
Empty string. In this case, the automatic management of errors will be disabled.
Note: To disable automatic error handling, you can also uncheck the project option "Enable HFSQL automatic assistance".
Note: In some cases (e.g. lost connection errors), the procedure/window/page will only be executed on the next call to the WLanguage function following the event causing the error.
Only some of the windows/pages for the automatic management of errors are available. The automatic management of errors is disabled for these errors.

Special case: using a Component window, page or Procedure The following syntax must be used:
Procedure:
HOnError(<Data file>, <Type>, ...
"<Component>.<Name of set of procedures>.<Procedure name>")

Window:
HOnError(<Data file>, <Type>, "<Component>.<Window name>")

Page:
HOnError(<Data file>, <Type>, "<Component>.<Page name>")
If a loss of connection occurs, to ask for reconnection, this procedure must call HReconnect.

Remarks

Operating mode of custom errors

The procedure, window or page used to customize the error must return one of the following constants:


opCancel	The function that triggered the error returns an error as if the assisted management was disabled. Note For loss-of-connection errors, the error is fatal.
opEndProcess	The function that triggered the error returns an error and the current process stops. Equivalent to the following line of code: IF NOT <HFSQL function> THEN SetFocusAndReturnToUserInput() This constant is not available.
opEndProgram	The function that triggered the error returns an error and the program stops. Equivalent to the following line of code: IF NOT <HFSQL function> THEN EndProgram()
opRelaunchProgram	The program stops and the application is automatically restarted. This constant is not available.
opRetry	The function that triggered the error is re-run.

If a loss of connection occurs, to ask for reconnection, HReconnect must be used in the procedure called by HOnError.

Using a class method to customize the errors

<Name of procedure or window> can also correspond to a method of an object if HOnError is called in a method of this object. All you have to do is specify the name of the method to use (without using the object name as prefix).

A fatal error occurs if the object used in the call to HOnError is no longer allocated when the HFSQL engine calls the method

Customizing the default error windows

The default error windows and their WLanguage code are available in the "\Programs\Data\Preset Windows\EN\HyperFileSQL - Automatic Help Windows" directory.

These windows can be customized, included in your projects, and passed as parameters to HOnError.

For more details, see HFSQL error handling help.

Customizing default error pages

The default error pages and their WLanguage code are available in the "\Programs\Data\Preset Pages\EN\HyperFileSQL - Automatic Help Pages" directory.

These pages can be customized, included in your projects, and passed as parameters to HOnError.

For more details, see HFSQL error handling help.

Related Examples:

Training (WINDEV): WD Managing HFSQL Errors

[ + ] The "WD Managing HFSQL Errors" example presents the management of HFSQL errors (duplicate, integrity).
This example explains how to customize the process when an error occurs.

Component: wd300hf.dll