<Connection variable>.DeleteFile (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

HFSQL Client/Server functions

Names of files and directories on the LINUX server

See also

ActivateServerTrigger

AddGroup

AddLink

AddScheduledBackup

AddScheduledOptimization

DeactivateServerTrigger

DeleteScheduledBackup

DeleteScheduledOptimization

DescribeServerTrigger

ExecuteScheduledBackup

ListScheduledOptimization

ModifyDatabaseProperty

ModifyScheduledBackup

ModifyScheduledOptimization

NotifAddEmailRecipient

NotifConfigure

NotifDeleteCCRecipient

NotifDeleteEmailRecipient

NotifListCCRecipient

NotifListEmailRecipient

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

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Connection variable>.DeleteFile (Function)

In french: <Variable Connexion>.SupprimeFichier

Available only with this kind of connection

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

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Windows Store apps mode.

Remark: From version 19, HFSQL is the new name of HyperFileSQL.

Versions 19 and later

This function is now available for Android applications.

This function is now available in Android Widget mode.

This function is now available for Java applications.

New in version 19

This function is now available for Android applications.

This function is now available in Android Widget mode.

This function is now available for Java applications.

This function is now available for Android applications.

This function is now available in Android Widget mode.

This function is now available for Java applications.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Example

MyConnection is Connection

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

Ct_test is Connection

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

Syntax

<Result> = <Connection>.DeleteFile(<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>: Connection variable

Name of the Connection variable that describes the connection in which the data file must be deleted.

<Data file path>: Character string (with quotes)

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:
hKeepTRS Keeps the transaction file associated with the deleted data file.
hDestroyLink Deletes all links related to the deleted data file.
hDeleteLog Deletes the Log file and all the logged operations 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 <Connection variable>.DeleteFile. 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: wd260hf.dll