DirChange()

DIRCHANGE()

Changes the directory

Syntax

      DIRCHANGE( <cDirectory> ) --> nError

Arguments

<cDirectory> The name of the directory you want do change into.

Returns

<nError> 0 if directory was successfully changed, otherwise the number of the last error.

Description

This function attempt to change the current directory to the one specified in <cDirectory>. If this function fails, it will return the last OS error code number. See FERROR() function for the description of the error.

Examples

      IF DirChange( "\temp" ) == 0
         ? "Change to diretory was successfull"
      ENDIF

Tests

      See examples

Compliance

This function is CA-Cl*pper 5.3 compliant

Platforms

All

Files

Library is rtl

Seealso

MAKEDIR(), DIRREMOVE(), ISDISK(), DISKCHANGE(), DISKNAME(), FERROR()

C5_DIRREMOVE

 DIRREMOVE()
 Remove a directory
------------------------------------------------------------------------------
 Syntax

     DIRREMOVE(<cDirName>) --> nSuccess

 Arguments

     <cDirName> is the name of the directory to erase, including an
     optional drive.  If you do not specify a drive, the current one is used.

 Returns

     DIRREMOVE() returns 0 if successful; -1 if there is an argument error.
     Otherwise, DIRREMOVE returns the DOS error code.

 Description

     DIRREMOVE() removes a specified directory.  Note that you must first
     have sufficient rights to delete a directory.  A directory must be empty
     in order to be deleted.  Therefore, to delete a directory that contains
     subdirectories, you must first delete the subdirectories (see example
     below).

 Examples

     .  This example uses DIRREMOVE() to delete a subdirectory named
        C:\TEST\ONE, which only contains an empty subdirectory named
        C:\TEST\ONE\TWO:

        DIRREMOVE("c:\test\one\two")        // First delete lowest dir
        nResult := DIRREMOVE("c:\test\one")  // Then delete higher dir
        IF nResult != 0
           ? "Cannot remove directory, DOS error ", siResult
           BREAK
        ENDIF

 Files   Library is EXTEND.LIB.

See Also: DIRCHANGE() DIRMAKE()

 

C5_DIRCHANGE

 DIRCHANGE()
 Change the current DOS directory
------------------------------------------------------------------------------
 Syntax

     DIRCHANGE(<cDir>) --> nSuccess

 Arguments

     <cDir> is the name of the directory to change to, including the
     drive.

 Returns

     DIRCHANGE() returns 0 if successful; -1 if there is an argument error.
     Otherwise, DIRCHANGE() returns the DOS error code.

 Description

     DIRCHANGE() changes the current DOS directory.  This function may also
     be used to determine whether or not a directory exists.

 Examples

     .  The following example attempts to change to the "c:\dos"
        directory.  If it is unsuccessful, an error message is displayed.

        nResult :=  DIRCHANGE("c:\dos")

        IF nResult != 0
           ? "Cannot change directory. "
           DO CASE
              CASE nResult == 3
                 ?? "Directory does not exist."
              CASE nResult == 5
                 ?? "Access to directory denied."
           END
           BREAK
        ENDIF

       You may also use something like this:

        DIRCHANGE( "..\..\test" )

 Files   Library is EXTEND.LIB.

See Also: CURDIR(), DIR*, DIRMAKE(), DIRREMOVE(), DIRCHANGE()

CT_DIRREMOVE

DIRREMOVE()

 Removes a directory
------------------------------------------------------------------------------
 Syntax

     DIRREMOVE(<cDirectory>) --> nErrorCode

 Argument

     <cDirectory>  Designates which directory name to remove.

 Returns

     DIRREMOVE() returns a 0 when the designated directory is successfully
     removed; otherwise, an error code is returned.  The codes are defined as
     follows:

     Table 7-4:  DIRREMOVE() Error Code
     ------------------------------------------------------------------------
     Code    Definition
     ------------------------------------------------------------------------
      0      Directory has been successfully removed.
     -3      Access path not found or directory not empty.
     -5      Access denied (e.g., in a network)
     -16     Current directory (cannot be removed)
     ------------------------------------------------------------------------

 Description

     DIRREMOVE() removes a designated directory.  This frees up the memory
     disk that an empty subdirectory occupies.

 Notes

     .  Use a drive designator and access path with <cDirectory>,
        wildcards are not permitted.

     .  The directory must be empty before you can remove it.

 Examples

     Remove the "\DATA" directory:

     IF DIRREMOVE("\DATA") == 0
        ? "Directory deleted."
     ENDIF

See Also: DIRCHANGE() DIRMAKE() DIRNAME()

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