0f365f1a5d
* doc/en/command.txt
* doc/en/datetime.txt
* doc/en/dbdelim.txt
* doc/en/dbsdf.txt
* doc/en/dbstrux.txt
* doc/en/dir.txt
* doc/en/diskspac.txt
* doc/en/eval.txt
* doc/en/garbage.txt
* doc/en/gtslang.txt
* doc/en/hashes.txt
* doc/en/hb_api.txt
* doc/en/hb_apier.txt
* doc/en/hb_apigt.txt
* doc/en/hb_apiit.txt
* doc/en/hb_apiln.txt
* doc/en/hb_apird.txt
* doc/en/hb_compa.txt
* doc/en/hb_date.txt
* doc/en/hb_macro.txt
* doc/en/hb_set.txt
* doc/en/hb_vm.txt
* doc/en/idle.txt
* doc/en/input.txt
* doc/en/lang.txt
* doc/en/macro.txt
* doc/en/math.txt
* doc/en/memo.txt
* doc/en/memvar2.txt
* doc/en/misc.txt
* doc/en/string.txt
* doc/en/var.txt
* fixes
* doc/en/*.txt
* set mime-type to UTF-8
120 lines
3.5 KiB
Plaintext
120 lines
3.5 KiB
Plaintext
/*
|
|
* $Id$
|
|
*/
|
|
|
|
/*
|
|
* The following are Copyright of the individual authors.
|
|
* www - http://harbour-project.org
|
|
*
|
|
* Copyright 2000 Paul Tucker <ptucker@sympatico.ca>
|
|
* Documentation for: DISKSPACE() and related functions
|
|
*
|
|
* See COPYING for licensing terms.
|
|
*
|
|
*/
|
|
|
|
/* $DOC$
|
|
* $TEMPLATE$
|
|
* Function
|
|
* $NAME$
|
|
* DISKSPACE()
|
|
* $CATEGORY$
|
|
* API
|
|
* $SUBCATEGORY$
|
|
* FileSys
|
|
* $ONELINER$
|
|
* 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
|
|
* $STATUS$
|
|
* R
|
|
* $COMPLIANCE$
|
|
* C
|
|
* $PLATFORMS$
|
|
* DOS,Win,OS2
|
|
* $FILES$
|
|
* Library is rtl
|
|
* Header is fileio.ch
|
|
* $END$
|
|
*/
|
|
|
|
/* $DOC$
|
|
* $TEMPLATE$
|
|
* Function
|
|
* $NAME$
|
|
* HB_DISKSPACE()
|
|
* $CATEGORY$
|
|
* API
|
|
* $SUBCATEGORY$
|
|
* FileSys
|
|
* $ONELINER$
|
|
* 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
|
|
* $STATUS$
|
|
* R
|
|
* $COMPLIANCE$
|
|
* H
|
|
* $PLATFORMS$
|
|
* DOS,Win,OS2,Unix
|
|
* $FILES$
|
|
* Library is rtl
|
|
* Header is fileio.ch
|
|
* $END$
|
|
*/
|