Crestron SIMPL+ - IsVolume Function

Crestron SIMPL+
®
Software
Language Reference Guide - DOC. 5797G SIMPL+
®
z 157
IsVolume
Name:
IsVolume
Syntax:
INTEGER IsVolume(FILE_INFO info)
Description:
This routine returns whether the specified file is a volume label. Equivalent to
checking attributes in FILE_INFO. Refer to page 135.
Parameters:
INFO – structure containing the information about a found file (refer to "FindFirst"
on page 149 for description).
Return Value:
Returns 1 if file is a volume label and 0 if otherwise.
Example:
(Refer to "File Functions Overview"on page 116)
FILE_INFO FileInfo;
SIGNED_INTEGER Found;
StartFileOperations();
Found = FindFirst(“*.dat”, FileInfo );
WHILE (Found = 0)
{
if (IsVolume(FileInfo))
PRINT( “volume label = %s\n”, FileInfo.Name );
Found = FindNext(FileInfo);
}
IF ( FindClose() < 0 )
PRINT ( “Error in closing find operation\n” );
EndFileOperations();
Version:
SIMPL+ Version 3.00.02 or higher (Pro 2 only)
Control System:
2-Series Only