dbAppend()
dbClearFilter()
dbCloseAll()
dbCloseArea()
dbCommit()
dbCommitAll()
dbCreate()
dbDelete()
dbEval()
dbF()
dbFilter()
dbGoBottom()
dbGoTo()
dbGoTop()
dbReCall()
dbRLock()
dbRLockList()
dbRUnlock()
dbSeek()
dbSelectArea()
dbSetDriver()
dbSetFilter()
dbSkip()
dbSkipper()
dbStruct()
dbUnlock()
dbUnlockAll()
dbUseArea()
DecToBin()
DecToHexa()
DecToOctal()
Deleted()
Descend()
DevOutPict()
DirChange()
DirRemove()
DiskSpace()
Returns the size of a single record in an active database.
Syntax
RECSIZE() --> nBytes
Arguments
(This function has no arguments)
Returns
<nBytes> The record size.
Description
This function returns the number os bytes used by a single record in the currently selected or designated database file. If no database is in use in this work area, the return value from this function will be 0.
Examples
USE tests NEW
DBGOTOP()
RECSIZE() // Returns 1
DBGOTO( 50 )
RECSIZE()
Compliance
Clipper
Files
Library is rdd
Seealso
DISKSPACE(), FIELDNAME(), HEADER(), LASTREC()
Return the length of a database file header
Syntax
HEADER() --> nBytes
Returns
<nBytes> The numeric size of a database file header in bytes
Description
This function returns the number of bytes in the header of the selected database ot the database in the designated work area.
If used in conjunction with the LASTREC(), RECSIZE() and DISKSPACE() functions, this functions is capable of implementing a backup and restore routine.
Examples
USE tests NEW
? Header()
Compliance
Clipper
Files
Library is rdd
Seealso
DISKSPACE(), LASTREC(), RECSIZE()
Get the amount of space available on a disk
Syntax
HB_DISKSPACE( [<cDrive>] [, <nType>] ) --> nDiskbytes
Arguments
<cDrive> The drive letter you are requesting info on. The default is A:
<nType> The type of space being requested. The default is HB_DISK_AVAIL.
Returns
<nDiskBytes> The number of bytes on the requested disk that match the requested type.
Description
By default, this function will return the number of bytes of free space on the current drive that is available to the user requesting the information.
There are 4 types of information available:
HB_FS_AVAIL The amount of space available to the user making the request. This value could be less than HB_FS_FREE if disk quotas are supported by the O/S in use at runtime, and disk quotas are in effect. Otherwise, the value will be equal to that returned for HB_FS_FREE.
HB_FS_FREE The actual amount of free diskspace on the drive.
HB_FS_USED The number of bytes in use on the disk.
HB_FS_TOTAL The total amount of space allocated for the user if disk quotas are in effect, otherwise, the actual size of the drive.
If information is requested on a disk that is not available, a runtime error 2018 will be raised.
Examples
#include "fileio.ch"
? "You can use : " + hb_ntos( hb_DiskSpace() ) + " bytes " +;
"Out of a total of " + hb_ntos( hb_DiskSpace( "C:", HB_FS_TOTAL ) )
Note: See tests\tstdspac.prg for another example
Compliance
Harbour
Platforms
DOS, Win, OS2, Unix
Files
Library is rtl Header is fileio.ch
Get the amount of space available on a disk
Syntax
DISKSPACE( [<nDrive>] ) --> nDiskbytes
Arguments
<nDrive> The number of the drive you are requesting info on where 1 = A, 2 = B, etc. For 0 or no parameter, DiskSpace will operate on the current drive. The default is 0
Returns
<nDiskBytes> The number of bytes on the requested disk that match the requested type.
Description
By default, this function will return the number of bytes of free space on the current drive that is available to the user requesting the information.
If information is requested on a disk that is not available, a runtime error 2018 will be raised.
Examples
? "You can use : " + hb_ntos( DiskSpace() ) + " bytes "
Note: See tests\tstdspac.prg for another example
Compliance
Clipper
Platforms
DOS, Win, OS2
Files
Library is rtl Header is fileio.ch
DISKSPACE()
Return the space available on a specified disk
------------------------------------------------------------------------------
Syntax
DISKSPACE([<nDrive>]) --> nBytes
Arguments
<nDrive> is the number of the drive to query, where one is drive A,
two is B, three is C, etc. The default is the current DOS drive if
<nDrive> is omitted or specified as zero.
Returns
DISKSPACE() returns the number of bytes of empty space on the specified
disk drive as an integer numeric value.
Description
DISKSPACE() is an environment function that determines the number of
available bytes remaining on the specified disk drive. It is useful
when COPYing or SORTing to another drive to determine if there is enough
space available before initiating the operation. You may also use
DISKSPACE() with RECSIZE() and RECCOUNT() to create a procedure to back
up database files.
DISKSPACE() ignores the SET DEFAULT drive setting.
Examples
. This example is a user-defined function that demonstrates the
use of DISKSPACE() to back up a database file to another drive:
FUNCTION BackUp( cTargetFile, cTargetDrive )
LOCAL nSpaceNeeded, nTargetDrive
//
nSpaceNeeded := INT((RECSIZE() * ;
LASTREC()) + HEADER() + 1)
nTargetDrive := ASC(UPPER(cTargetDrive)) - 64
//
IF DISKSPACE(nTargetDrive) < nSpaceNeeded
RETURN .F.
ENDIF
COPY TO (cTargetDrive + ":" + cTargetFile)
//
RETURN .T.
Files Library is EXTEND.LIB.
See Also: LASTREC() LUPDATE() RECSIZE()
Fill a series of arrays with directory information
ADIR( [ <cFilespec> ],
[ <aFilenames> ],
[ <aSizes> ],
[ <aDates> ],
[ <aTimes> ],
[ <aAttributes> ] ) --> nFiles
Close a specific set of files
CLOSE [ <idAlias> | ALL | ALTERNATE | DATABASES | FORMAT |INDEXES ]
Copy a file to a new file
COPY FILE <xcSourceFile> TO <xcTargetFile> | <xcDevice>
Return the current DOS directory
CURDIR( [ <cDrivespec> ] ) --> cDirectory
Remove a file from disk
DELETE FILE | ERASE <xcFile>
Display a listing of files from a specified path
DIR [ <xcFileSpec> ]
Change the current DOS directory
DIRCHANGE(<cDir>) --> nSuccess
Create an array of directory and file information
DIRECTORY( <cDirSpec>, [ <cAttributes> ] ) --> aDirectory
Create a directory
DIRMAKE(<cNewDir>) --> nSuccess
Remove a directory
DIRREMOVE(<cDirName>) --> nSuccess
Change the current DOS disk drive
DISKCHANGE(<cDrive>) --> lSuccess
Return the current DOS drive
DISKNAME() --> cDrive
Return the space available on a specified disk
DISKSPACE( [ <nDrive> ] ) --> nBytes
Remove a file from disk
ERASE | DELETE FILE <xcFile>
Determine if files exist in the default directory or path
FILE( <cFilespec> ) --> lExists
Change the name of a file
RENAME <xcOldFile> TO <xcNewFile>
Echo console output to a text file
SET ALTERNATE TO [ <xcFile> [ADDITIVE]] SET ALTERNATE on | OFF | <xlToggle>
Set the CA-Clipper default drive and directory
SET DEFAULT TO [ <xcPathspec> ]
Specify the CA-Clipper search path for opening files
SET PATH TO [ <xcPathspec list> ]
Display the contents of a text file
TYPE <xcFile> [TO PRINTER] [TO FILE <xcOutFile> ]
Close an open binary file and write DOS buffers to disk
FCLOSE( <nHandle> ) --> lError
Create and/or truncate a binary file to zero length
FCREATE( <cFile>, [ <nAttribute> ] ) --> nHandle
Delete a file from disk
FERASE( <cFile> ) --> nSuccess
Test for errors after a binary file operation
FERROR() --> nErrorCode
Open a binary file
FOPEN( <cFile>, [ <nMode> ] ) --> nHandle
Read characters from a binary file into a buffer variable
FREAD( <nHandle>, @<cBufferVar>, <nBytes> ) --> nBytes
Read characters from a binary file
FREADSTR( <nHandle>, <nBytes> ) --> cString
Change the name of a file
FRENAME( <cOldFile>, <cNewFile> ) --> nSuccess
Set a binary file pointer to a new position
FSEEK( <nHandle>, <nOffset>, [ <nOrigin> ] ) --> nPosition
Write to an open binary file
FWRITE( <nHandle>, <cBuffer>, [ <nBytes> ] )
--> nBytesWritten
Return the current database file header length
HEADER() --> nBytes
Toggle automatic sounding of the bell during full-screen operations
SET BELL on | OFF | <xlToggle>
Define screen colors
SET COLOR | COLOUR TO [ [<standard>]
[, <enhanced>] [, <border>] [, <background> ]
[, <unselected>]] | ( <cColorString> )
Set the default drive and directory
SET DEFAULT TO [ <xcPathspec> ]
Assign a character string to a function key
SET FUNCTION <nFunctionKey> TO <cString>
Set the size of the keyboard buffer
SET TYPEAHEAD TO <nKeyboardSize>
Return the current DOS directory
CURDIR( [ <cDrivespec> ] ) --> cDirectory
Return the space available on a specified disk
DISKSPACE( [ <nDrive> ] ) --> nBytes
Return function key name
FKLABEL( <nFunctionKey> ) --> cKeyLabel
Return number of function keys as a constant
FKMAX() --> nFunctionKeys
Retrieve the contents of a DOS environment variable
GETENV( <cEnvironmentVariable> ) --> cString
Determine if the current computer has color compatibility
ISCOLOR() | ISCOLOUR() --> lBoolean
Determine the maximum visible screen row
MAXROW() --> nRow
Determine the maximum visible screen column
MAXCOL() --> nColumn
Determine the amount of available free pool memory
MEMORY( <nMemoryType> ) --> nKbytes
Toggle snow position
NOSNOW( <lToggle> ) --> NIL
Return the operating system name
OS() --> cOSName
Inspect or change a global setting
SET( <nSpecifier>, [<expNewSetting>], [<lOpenMode> ] )
--> CurrentSetting
Sound a speaker tone for a specified frequency and duration
TONE( <nFrequency>, <nDuration> ) --> NIL
Returns Clipper Compiler version
VERSION() --> cVersion
