C5 File Management Commands and Functions
High Level :
ADIR()* :
Fill a series of arrays with directory information
ADIR( [ <cFilespec> ],
[ <aFilenames> ],
[ <aSizes> ],
[ <aDates> ],
[ <aTimes> ],
[ <aAttributes> ] ) --> nFiles
CLOSE :
Close a specific set of files
CLOSE [ <idAlias> | ALL | ALTERNATE | DATABASES | FORMAT |INDEXES ]
COPY FILE :
Copy a file to a new file
COPY FILE <xcSourceFile> TO <xcTargetFile> | <xcDevice>
CURDIR() :
Return the current DOS directory
CURDIR( [ <cDrivespec> ] ) --> cDirectory
DELETE FILE :
Remove a file from disk
DELETE FILE | ERASE <xcFile>
DIR* :
Display a listing of files from a specified path
DIR [ <xcFileSpec> ]
DIRCHANGE() :
Change the current DOS directory
DIRCHANGE(<cDir>) --> nSuccess
DIRECTORY() :
Create an array of directory and file information
DIRECTORY( <cDirSpec>, [ <cAttributes> ] ) --> aDirectory
DIRMAKE()
Create a directory
DIRMAKE(<cNewDir>) --> nSuccess
DIRREMOVE() :
Remove a directory
DIRREMOVE(<cDirName>) --> nSuccess
DISKCHANGE() :
Change the current DOS disk drive
DISKCHANGE(<cDrive>) --> lSuccess
DISKNAME() :
Return the current DOS drive
DISKNAME() --> cDrive
DISKSPACE() :
Return the space available on a specified disk
DISKSPACE( [ <nDrive> ] ) --> nBytes
ERASE :
Remove a file from disk
ERASE | DELETE FILE <xcFile>
FILE() :
Determine if files exist in the default directory or path
FILE( <cFilespec> ) --> lExists
RENAME :
Change the name of a file
RENAME <xcOldFile> TO <xcNewFile>
SET ALTERNATE :
Echo console output to a text file
SET ALTERNATE TO [ <xcFile> [ADDITIVE]] SET ALTERNATE on | OFF | <xlToggle>
SET DEFAULT :
Set the CA-Clipper default drive and directory
SET DEFAULT TO [ <xcPathspec> ]
SET PATH :
Specify the CA-Clipper search path for opening files
SET PATH TO [ <xcPathspec list> ]
TYPE :
Display the contents of a text file
TYPE <xcFile> [TO PRINTER] [TO FILE <xcOutFile> ]
Low-level :
FCLOSE() :
Close an open binary file and write DOS buffers to disk
FCLOSE( <nHandle> ) --> lError
FCREATE() :
Create and/or truncate a binary file to zero length
FCREATE( <cFile>, [ <nAttribute> ] ) --> nHandle
FERASE() :
Delete a file from disk
FERASE( <cFile> ) --> nSuccess
FERROR() :
Test for errors after a binary file operation
FERROR() --> nErrorCode
FOPEN() :
Open a binary file
FOPEN( <cFile>, [ <nMode> ] ) --> nHandle
FREAD() :
Read characters from a binary file into a buffer variable
FREAD( <nHandle>, @<cBufferVar>, <nBytes> ) --> nBytes
FREADSTR() :
Read characters from a binary file
FREADSTR( <nHandle>, <nBytes> ) --> cString
FRENAME() :
Change the name of a file
FRENAME( <cOldFile>, <cNewFile> ) --> nSuccess
FSEEK() :
Set a binary file pointer to a new position
FSEEK( <nHandle>, <nOffset>, [ <nOrigin> ] ) --> nPosition
FWRITE() :
Write to an open binary file
FWRITE( <nHandle>, <cBuffer>, [ <nBytes> ] )
--> nBytesWritten
HEADER() :
Return the current database file header length
HEADER() --> nBytes
