HCancelAlias (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

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HCancelAlias (Function)

In french: HAnnuleAlias

Not available with this kind of connection

Cancels an alias previously declared with HAlias. After this operation, the data file associated with the alias is no longer recognized by the HFSQL engine.

Note If the alias file is open, it is automatically closed when you cancel.

Example

// Crée 2 alias sur le fichier de données CLIENT
HAlias(CLIENT, CLIENT1)
HAlias(CLIENT, CLIENT2)
// Annule le premier alias
HCancelAlias(CLIENT1)

Syntax

<Result> = HCancelAlias(<Alias file>)

<Result>: Boolean

True if the operation was performed,
False if a problem occurs. HError is used to identify the error.

<Alias file>: Character string

Name of the alias file to cancel. A non-fatal WLanguage error occurs if the alias file does not exist.

Remarks

When cancelling an alias (HCancelAlias):

modifications made with HChangeName and HChangeDir are not cancelled. If the alias is described again, these parameters are stored and re-applied.
if a data file has been created with a name given by HChangeName and a location given by HChangeDir, the data file is not physically deleted.
- To delete a data file created from an alias, use HDeleteFile.
- To delete a folder created from an alias, use HDeleteDirectory.

Component: wd300hf.dll