* * HELP & MANUAL PREMIUM PACK 4 DEMO VERSION * *
This documentation was styled with a demo skin from the Premium Pack 4 add-on for Help & Manual. The contents of the skin are encrypted and not configurable. You can only publish HM projects with this skin. You cannot edit it or change it.
This version is copyright and may only be used for local testing purposes. It may not be distributed.
Please purchase the full version of the Premium Pack to get the configurable skins and remove this notice. The package will also include the Toolbox configuration utility for Premium Pack skins.
Description
Returns the value specified at "CommandNumber" position in script command line.
Syntax
s = OS_GetCommand(CommandNumber)
Returns
String.
Parameters
Name |
Type |
Optional |
Meaning |
CommandNumber |
Numeric |
No |
The command option number you want return |
Remarks
At position 0 there is always the full command line.
At position 1 there is always the full path of the script file.
Real commands start at position 2.
Restrictions
Any of the following chars are used as default command separators: " =- (double quote, space, equal, minus).
Use OS_CommandsSetSep function to set a different set of chars.
See also
Examples
uses "console", "os"
Long NumberOfCommands, Count
'---Returns the number of commands specified
NumberOfCommands = OS_GetCommands
'---Some header
Console_Write("The following are the passed parameters (param 1 is always script name):" & $CRLF)
Console_Write(Repeat$(79, "-") & $CRLF)
'---Show all parameters
For Count = 0 To NumberOfCommands
console_Write( Format$(Count, "00") & " " & OS_GetCommand(Count) & $CRLF)
Next
Console_Waitkey
