Company Events Academic NI Developer Zone Support Solutions Products & Services Contact NI MyNI

Get Volume Info Function

NI LabVIEW 8.6 Help
June 2008

NI Part Number:
371361E-01

»View Product Info

Owning Palette: Advanced File VIs and Functions

Installed With: Base Package

Returns information about the volume containing the file or directory specified by path, including the total storage space provided by the volume and the amount free in bytes.

Details  

path specifies the absolute path to the file or directory whose volume attributes you want to determine. If you specify an empty or relative path, this function returns an error.
error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use exception control to treat what is normally an error as no error or to treat a warning as an error. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
volume path is a new path that specifies the volume on which the specified file or directory resides.
path out returns path unchanged.
size (bytes) indicates the amount of storage, in bytes, provided by the specified volume.
free (bytes) indicates the amount of storage, in bytes, available on the specified volume.
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.
sector size (bytes) indicates the size, in bytes, of the smallest physical storage unit on disk. If you open a file without buffering, you must make the size of the data in that file a multiple of the given sector size.

Get Volume Info Details

The volume where the file is located determines the sector size.


Resources


 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit