Programmer Guide/Command Reference/DRIVE: Difference between revisions
From STX Wiki
Jump to navigationJump to search
(→DRIVE) |
No edit summary |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:{{SUBPAGENAME}}}} | {{DISPLAYTITLE:{{SUBPAGENAME}}}} | ||
Without an argument, the <code>DRIVE</command | Without an argument, the <code>DRIVE</code> command retrieves a list of available drive letters, separated by blanks: | ||
var := DRIVE [ [[Programmer_Guide/Command_Reference_Options/Silent|/Silent]] ] | var := DRIVE [ [[Programmer_Guide/Command_Reference_Options/Silent|/Silent]] ] | ||
| Line 9: | Line 9: | ||
;<var>driveLetter</var> | ;<var>driveLetter</var> | ||
:The drive letter to query (e.g. A) or | :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> | ||
Latest revision as of 17:16, 24 April 2014
Without an argument, the DRIVE command retrieves a 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), andGB(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.
