Programmer Guide/Command Reference/DRIVE: Difference between revisions

From STX Wiki
Jump to navigationJump to search
No edit summary
No edit summary
Line 9: Line 9:


;<var>driveLetter</var>
;<var>driveLetter</var>
:The drive letter to query (e.g. A) or the file path (e.g. c:\files\test.txt) where the first letter is used.
:The drive letter to query (e.g. A) or a file path (e.g. "c:\files\test.txt") whose first letter will be interpreted as a drive letter.


;<var>sizeUnit</var>
;<var>sizeUnit</var>

Revision as of 18:21, 23 March 2011

Without an argument, the DRIVE command retrieves list of available drive letters, separated by blanks:

var := DRIVE [ /Silent ]

Supplied with a drive letter as its argument, the DRIVE command will return the disk label of the respective drive:

var := DRIVE driveLetter [ sizeUnit ] [ /Silent ]

If sizeUnit is specified, the size of the drive, the free space and the space available to the user are also returned in the format drivelabel ; size freeall freeuser

driveLetter
The drive letter to query (e.g. A) or a file path (e.g. "c:\files\test.txt") whose first letter will be interpreted as a drive letter.
sizeUnit
The possible values are B (byte), KB (kilobyte), MB (megabyte), and GB (gigabyte).
/Silent
If specified, errors will generate warning messages rather than error messages. See The Silent Flag for details.

See the script file drive_example.sts for a working example.

Navigation menu

Personal tools