Files
harbour-core/doc/en/diskspac.txt
Viktor Szakats 03ac58b17b 2017-09-08 18:22 UTC Viktor Szakats (vszakats users.noreply.github.com)
* bin/commit.hb
  * config/detect.mk
  * config/detfun.mk
  * config/detplat.mk
  * config/dir.mk
  * config/dirsh.mk
  * config/global.mk
  * config/globsh.mk
  * config/instsh.mk
  * config/lang.hb
  * config/lang2po.hb
  * config/po2lang.hb
  * config/postinst.hb
  * contrib/hbexpat/tests/tohash.prg
  * contrib/hbformat/utils/hbformat.ini
  * contrib/hbmisc/hbedit.prg
  * contrib/hbmxml/tests/testmxml.prg
  * contrib/hbnetio/utils/hbnetio/_console.prg
  * contrib/hbnetio/utils/hbnetio/_winsvc.prg
  * contrib/hbnetio/utils/hbnetio/hbnetio.prg
  * contrib/hbnetio/utils/hbnetio/netiomgm.hb
  * contrib/hbwin/tests/ole.prg
  * contrib/hbwin/tests/oletst2.js
  * contrib/hbwin/tests/oletst2.vbs
  * contrib/hbxpp/doc/en/binnumx.txt
  * contrib/hbxpp/doc/en/dbcmdx.txt
  * contrib/xhb/htmutil.prg
  * contrib/xhb/tfile.prg
  * contrib/xhb/tframe.prg
  * contrib/xhb/thtm.prg
  * ChangeLog.txt
  * debian/copyright
  * doc/class_tp.txt
  * doc/hdr_tpl.txt
  * doc/xhb-diff.txt
  * LICENSE.txt
  * package/harbour-wce.spec.in
  * package/harbour-win.spec.in
  * package/harbour.spec
  * package/mpkg_rpm_wce.sh
  * package/mpkg_rpm_win.sh
  * package/mpkg_rpm.sh
  * package/mpkg_src.sh
  * package/mpkg_ver.sh
  * src/rtl/achoice.prg
  * src/rtl/getsys53.prg
  * src/rtl/tgetlist.prg
  * src/rtl/tlabel.prg
  * src/rtl/tmenusys.prg
  * tests/hbdoc.prg
  * tests/langmsg.prg
  * tests/rto_get.prg
  * tests/rto_tb.prg
  + doc/en/ati.txt
  + doc/en/dirdrive.txt
  + doc/en/hashfunc.txt
  + doc/en/hbtoken.txt
  + doc/en/left.txt
  + doc/en/proc.txt
  + doc/en/strtran.txt
  + doc/en/transfrm.txt
  + doc/en/typefile.txt
  * doc/en/*
    * more partial sync with 3.4 fork
2017-09-08 18:25:11 +00:00

110 lines
3.1 KiB
Plaintext

/* $DOC$
$AUTHOR$
Copyright 2000 Paul Tucker <ptucker@sympatico.ca>
$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"
// See tests/diskspac.prg for another example
$STATUS$
R
$COMPLIANCE$
C
$PLATFORMS$
All
$FILES$
Library is core
Header is fileio.ch
$END$
*/
/* $DOC$
$AUTHOR$
Copyright 2000 Paul Tucker <ptucker@sympatico.ca>
$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_DISK_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_DISK_FREE The actual amount of free disk space on the drive.
HB_DISK_USED The number of bytes in use on the disk.
HB_DISK_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( , HB_DISK_TOTAL ) )
// See tests/diskspac.prg for another example
$STATUS$
R
$COMPLIANCE$
H
$PLATFORMS$
All
$FILES$
Library is core
Header is fileio.ch
$END$
*/