  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
Overview
The GetVolumeFreeSpace function retrieves the amount of free space available on a volume to the user owning the process thread.
Syntax/Parameters
Syntax
qword = GetVolumeFreeSpace ( string volume );
Parameters
volume
A string containing the disk, volume, or UNC designation. If this parameter is a UNC name, it must include a trailing backslash (for example, “\\MyServer\MyShare\”).
Return Value
Returns a qword specifying the space available to the user or zero on failure. Use the GetLastError function to retrieve error information.
Remarks
The volume parameter does not have to specify the root directory on a disk. Any directory on the disk is acceptable. The calling application must have FILE_LIST_DIRECTORY access rights for this directory.
The GetVolumeFreeSpace function returns zero for all CD requests unless the disk is an unwritten CD in a CD-RW drive. When retrieving the volume free space of a network share, the size may be reflected in any number of network shares since it usually is reported as the free space of the volume where the share is located. If per-user quotas are being used, the GetVolumeFreeSpace function may return a value that is less than the total number of free bytes on a disk.
Use the GetLastError function to determine if the disk is full.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| Table of Contents | < < Previous | Next >> |
© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.