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.
Remark: If the alias file is open, it is automatically closed during the cancelation.
// Create 2 aliases on the CUSTOMER data file
HAlias(CUSTOMER, CUSTOMER1)
HAlias(CUSTOMER, CUSTOMER2)
// Cancel the first alias
HCancelAlias(CUSTOMER1)
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.