HDeleteFile (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / Managing databases / HFSQL / HFSQL Client/Server functions

Deleting a data file
Names of files and directories on the LINUX server

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HDeleteFile (Function)

In french: HSupprimeFichier

Available only with this kind of connection

Deletes the HFSQL data files (.fic, .ndx, .ftx and .mmo files if they exist) from the server.

Example

MyConnection is Connection

// Deletes data files from the server
HDeleteFile(MyConnection, ".\backup\customerfile_bck.fic")

Ct_test is Connection

IF HDeleteFile(Ct_test, ".\Customer.FIC") = False THEN
Error(HErrorInfo())
END

Syntax

<Result> = HDeleteFile(<Connection> , <Data file path> [, <Options>])

<Result>: Boolean

True if the data file was deleted,
False if an error occurred (the data file does not exist on the server for example). HError is used to identify the error.

<Connection>: Character string or Connection variable

Connection in which the data file must be deleted. This connection corresponds to:
the name of the connection defined in the data model editor or with HDescribeConnection or HOpenConnection.
the name of a variable of type Connection.

<Data file path>: Character string

Physical name and path of the data file to delete. The path is relative to the database: the name of the database must not be specified in the path. The ".fic" extension of the data file must be specified.

<Options>: Optional Integer constant (or combination of constants)

By default, when deleting a data file:
the files corresponding to the logs are not deleted,
the files corresponding to the transactions are deleted.
This parameter is used to modify this behavior:
hDeleteLog Deletes the Log file and all the logged operations associated with the deleted data file.
hDestroyLink Deletes all links related to the deleted data file.
hKeepTRS Keeps the transaction file associated with the deleted data file.

Remarks

Deleting a data file

The data file can be deleted only if it is not currently used (which means if it is not used by a query, a view, another window, a thread or a component with independent HFSQL context).

The data file is automatically closed in the HFSQL context that calls HDeleteFile. A WLanguage error occurs if the data file is used in a context or by an application.

Names of files and directories on the LINUX server

On a LINUX server, the name of data files (.fic, .ftx, .ndx and .mmo files if they exist) must be written in lowercase and they must not contain any accented characters.

Component: wd280hf.dll