DeleteFile

DeleteFile

Deletes an error-tolerant file

Syntax

      DeleteFile(<cFileName>) --> <nErrorCode>

Argument

<cFileName> : file name to delete

Returns

<nErrorCod> : Result of delete operation

          DeleteFile() result Codes
          ------------------------------------------------------------------------
          Code    Symb. constants     Definition
          ------------------------------------------------------------------------
           0      NO_DISK_ERR         No error occurs
          -2      ER_FILE_NOT_FOUND   File not found
          -3      ER_PATH_NOT_FOUND   Path not found
          -5      ER_ACCESS_DENIED    Access denied (e.g., file is read-only)
          ------------------------------------------------------------------------

Description

In contrast to FileDelete(), which permits to specify file groups with wildcards, DeleteFile() only accepts specific file names. However, the function avoids all DOS error messages and returns an error code directly to the calling program. This makes error-tolerant erasures in networks possible.

Note

. You can use a drive designator and path name, but no wildcards.

Examples

      .  How NOT to delete a file in a network environment:

      IF FILE ("TEST.DBF")
         * Is it actually possible to delete the file?
         DELETE FILE TEST.DBF
      ENDIF

      .  This is a better way:

      nStatus  :=  DeleteFile("TEST.DBF")
      IF nStatus == 0
         ? "File deleted."
      ELSE
         IF nStatus == -5
            ? "ACCESS DENIED!"
            ? "File in use elsewhere!"
         ENDIF
      ENDIF

Seealso

FileDelete(), RenameFile()

CT_FILEDELETE

FILEDELETE()
 Deletes file(s) by name and attribute
------------------------------------------------------------------------------
 Syntax

     FILEDELETE(<cFileMask>, [<nFileAttr>]) --> lDeleted

 Arguments

     <cFileMask>  Designates the file or files to delete.

     <nFileAttr>  Designates one of the following file attributes.  The
     default value is 32.

     Table 7-13:  File Attribute Coding
     ------------------------------------------------------------------------
     Value     Symb. constants   Definition
     ------------------------------------------------------------------------
     0         FA_NORMAL
     1         FA_READONLY       Read-only
     2         FA_HIDDEN         HIDDEN (Concealed files)
     4         FA_SYSTEM         SYSTEM (System files)
     8         FA_VOLUME         VOLUME (Name of floppy/hard disk)
     32        FA_ARCHIVE        ARCHIVE (Changed since last backup)
     63        Everything
     ------------------------------------------------------------------------

 Returns

     FILEDELETE() returns .T. when at least one or more files are deleted;
     otherwise, .F. is returned.

 Description

     ERASE command and FErase() function doesn't support "wildcard" ( "*" / "?" ) 
     characters in file specification. FileDelete() function of tools library does.
     Occasionally, you will need to clean up a floppy or a hard disk or
     delete whole file groups.  This function deletes entire file groups with
     a function call, without using the RUN command.

 Notes

     Warning!  FILEDELETE() can also delete system files.

     .  The default standard attribute is archive (32).  Drive and
        path designations, and wildcards are permitted.

     .  Subdirectories must be deleted with the help of the
        DIRREMOVE() function.

 Example

     Attempt to delete all index files, then display the completion status:

     IF FILEDELETE("*.NDX")
        ? "Files deleted."
     ELSE
        ? "No files found."
     ENDIF

See Also: DELETEFILE()

Tools — Disk Utilities

Introduction Disk Utilities
DELETEFILE() Deletes an error-tolerant file
DIRCHANGE()  Changes the current directory
DIRMAKE()    Creates a directory
DIRNAME()    Determines the name of the current directory
DIRREMOVE()  Removes a directory
DISKCHANGE() Changes the current disk drive
DISKCHECK()  Creates a checksum for a disk
DISKFORMAT() Formats disks, controlled through a UDF
DISKFREE()   Determines the space available on a floppy or hard disk
DISKNAME()   Determines the drive designator for the current drive
DISKREADY()  Tests to see if a disk drive is ready
DISKREADYW() Queries whether you can write to a drive
DISKSPEED()  Determines a comparison value for the drive speed
DISKSTAT()   Determines the status of a drive.
DISKTOTAL()  Determines the total capacity of a floppy or hard disk
DISKTYPE()   Determines the type of data carrier
DRIVETYPE()  Determines the drive type
FILEAPPEND() Appends data to a file
FILEATTR()   Determines a file's attributes
FILECCLOSE() Closes a file after backup mode
FILECCONT()  Copies sections of a file in backup mode
FILECDATI()  Determines which date the target file contains with FILECOPY()
FILECHECK()  Calculates/computes/determines a checksum for a file
FILECOPEN()  Tests to see if the file is still open in the backup mode
FILECOPY()   Copies files normally or in backup mode
FILEDATE()   Determines the file date
FILEDELETE() Deletes file(s) by name and attribute
FILEMOVE()   Moves files to another directory
FILESEEK()   Searches for files by name and attribute
FILESIZE()   Determines the size of a file
FILESTR()    Reads a portion of a file into a string
FILETIME()   Determines a file's time
FILEVALID()  Tests whether a string has a valid file name
FLOPPYTYPE() Determines the exact type of floppy drive
GETSHARE()   Determines the file open (share) mode
NUMDISKF()   Determines the number of installed disk drives
NUMDISKH()   Determines the number of hard disks
NUMDISKL()   Determines the number of available logical drives
RENAMEFILE() Fault tolerant renaming of a file.
RESTFSEEK()  Restores the FILESEEK environment
SAVEFSEEK()  Saves the current FILESEEK environment
SETFATTR()   Sets a file's attributes
SETFCREATE() Default attribute for creating with CA-Clipper Tools functions
SETFDATI()   Sets the date and time of a file
SETSHARE()   Sets default opening mode for CA-Clipper Tools file functions
STRFILE()    Writes a string to a file
TEMPFILE()   Creates a file for temporary use
TRUENAME()   Standardizes the path designation
VOLSERIAL()  Determines the DOS disk serial number
VOLUME()     Establishes a volume label for a floppy or hard disk