C$DELETE

C$DELETE deletes the indicated file.

Usage

CALL "C$DELETE" 
    USING FILE-NAME, FILE-TYPE,
    GIVING STATUS

Parameters

FILE-NAME PIC X(n)

Contains the name of the file to be deleted. This should either be a full path name or a name relative to the current directory.

The "@[DISPLAY]:" for Thin Client support is allowed. For example:

C$DELETE "@[DISPLAY]:C:\path\filename"

If the file name on the client starts with special directory specifiers, the thin client attempts to locate those files in special Windows directories. The special directory names are as follows:

Identifier	Directory
<APPDATA>	C:\Documents and Settings\<user>\Application Data
<COMMON_APPDATA>	C:\Documents and Settings\All Users\Application Data
<COMMON_DOCUMENTS>	C:\Documents and Settings\All Users\Documents
<DESKTOP>	C:\Documents and Settings\<user>\Desktop
<LOCAL_APPDATA>	C:\Documents and Settings\<user>\Local Settings\Application Data
<MYDOCUMENTS>	C:\Documents and Settings\<user>\My Documents

Note that these directories are not necessarily the same for all versions of Windows, and may in fact be on network drives.

FILE-TYPE PIC X (optional)

Indicates the file type. If the FILE-TYPE parameter is supplied, it must be either "S", "R", or "I" indicating that the source file is a sequential, relative, or indexed file. This can be useful in cases where the original file is held in more than one physical disk file (for example, C-ISAM indexed files and Vision 4 and 5 files are physically held in two separate files). If the FILE-TYPE parameter is omitted, then only the single physical file named in FILE-NAME is deleted.

If you use the "@[DISPLAY]:" prefix, you may not use the FILE-TYPE parameter. Only the single, specified source file is deleted.

STATUS PIC 9(n)

Returns 0 if successful, or 1 if not.

The behavior of this routine is affected by the FILENAME_SPACES configuration variable. The value of FILENAME_SPACES determines whether spaces are allowed in a file name. See the entry for FILENAME_SPACES in Appendix H for more information.