fivedev/harbour-core
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated to cap requested type to be within allowable range

Browse Source
This commit is contained in:
Paul Tucker
2000-03-23 00:45:51 +00:00
parent beb3471ec8
commit eebd87c2b6
4 changed files with 33 additions and 131 deletions
Download Patch File Download Diff File Expand all files Collapse all files

129
harbour/doc/en/diskspac.txt
View File

@@ -26,12 +26,12 @@
* <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
* <nType> The type of space being requested. The default is HB_FS_AVAIL.
* <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 amount of
* 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.
*
@@ -44,11 +44,12 @@
* 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 size of 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 removeable disk that is not available,
* the O/S may request that a disk be inserted in the drive, otherwise the
* return value will be 0.
* If information is requested on a disk that is not available, a runtime
* error 2018 will be raised.
* $EXAMPLES$
* ? "You can use : " +Str( DiskSpace() ) + " bytes " +;
* "Out of a total of " + Str( DiskSpace(0,HB_FS_TOTAL) )
@@ -56,120 +57,10 @@
* R
* $COMPLIANCE$
* CA-Clipper will return an integer value which limits it's usefulness to
* drives less than 2 gigabytes. The Harbour version returns a floating
* point value with 0 decimals if the disk is > 2 gigabytes.
* drives less than 2 gigabytes. The Harbour version will return a
* floating point value with 0 decimals if the disk is > 2 gigabytes.
* <nType> is a Harbour extension.
* $SEEALSO$
* DISKFREE(),DISKUSED(),DISKFULL(),tests\tstdspac.prg
* tests\tstdspac.prg
* $END$
*/
/* $DOC$
* $FUNCNAME$
* DISKFREE()
* $CATEGORY$
* Low level disk information
* $ONELINER$
* Get the amount of space on a disk
* $SYNTAX$
* DISKFREE( [<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, DiskFree will operate on the current
* drive. The default is 0
* $RETURNS$
* <nDiskBytes> The number of bytes of space available on the requested
* disk
* $DESCRIPTION$
* This function will return the number of bytes of free space on the
* current, or requested drive.
*
* Using DiskFree(0) is the same as calling DiskSpace(0,HB_FS_FREE)
*
* If information is requested on a removeable disk that is not available,
* the O/S may request that a disk be inserted in the drive, otherwise the
* return value will be 0
* $EXAMPLES$
* ? "There is : " +Str( DiskFree() ) + " bytes " +;
* "Out of a total of " + Str( DiskSpace(0,HB_FS_TOTAL) )
* $STATUS$
* R
* $COMPLIANCE$
* - unknown -
* $SEEALSO$
* DISKSPACE(),DISKUSED(),DISKFULL(),tests\tstdspac.prg
* $END$
*/
/* $DOC$
* $FUNCNAME$
* DISKUSED()
* $CATEGORY$
* Low level disk information
* $ONELINER$
* Get the amount of space in use on a disk
* $SYNTAX$
* DISKUSED( [<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, DiskUsed will operate on the current
* drive. The default is 0
* $RETURNS$
* <nDiskBytes> The number of bytes in use on the requested disk
* $DESCRIPTION$
* This function will return the number of bytes in use on the
* current, or requested drive.
*
* Using DiskUsed(0) is the same as calling DiskSpace(0,HB_FS_USED)
*
* If information is requested on a removeable disk that is not available,
* the O/S may request that a disk be inserted in the drive, otherwise the
* return value will be 0
* $EXAMPLES$
* ? "There is : " +Str( DiskUsed() ) + " bytes " +;
* "Out of a total of " + Str( DiskSpace(0,HB_FS_USED) )
* $STATUS$
* R
* $COMPLIANCE$
* - unknown -
* $SEEALSO$
* DISKSPACE(),DISKFREE(),DISKFULL(),tests\tstdspac.prg
* $END$
*/
/* $DOC$
* $FUNCNAME$
* DISKFULL()
* $CATEGORY$
* Low level disk information
* $ONELINER$
* Get the total amount of space on a disk
* $SYNTAX$
* DISKFULL( [<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, DiskUsed will operate on the current
* drive. The default is 0
* $RETURNS$
* <nDiskBytes> The total number of bytes on the requested disk
* $DESCRIPTION$
* This function will return the number of bytes on the
* current, or requested drive.
*
* Using DiskFull(0) is the same as calling DiskSpace(0,HB_FS_TOTAL)
*
* If information is requested on a removeable disk that is not available,
* the O/S may request that a disk be inserted in the drive, otherwise the
* return value will be 0
* $EXAMPLES$
* ? "There is : " +Str( DiskUsed() ) + " bytes " +;
* "Out of a total of " + Str( DiskFull() )
* $STATUS$
* R
* $COMPLIANCE$
* - unknown -
* $SEEALSO$
* DISKSPACE(),DISKFREE(),DISKUSED(),tests\tstdspac.prg
* $END$
*/