* * 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
Checks command line for presence of specified parameter and in case it is found, returns its position.
Syntax
nPosition = OS_CommandPresent(parameterName)
Returns
Number.
One based index of the parameter position.
In case the parameter isn't found, zero is returned.
Parameters
Name |
Type |
Optional |
Meaning |
parameterName |
String |
No |
Command string to check for |
Remarks
The position will differ when running the script from ThinAir and from shell.
Use Script/Command line... option in ThinAir to test command line parameters for scripts launched from the IDE.
Restrictions
The parameterName cannot be prefixed with "--".
See also
Examples
' -- Returns position of -force parameter on the command line
' -- In case it is not found, zero is returned
n = OS_CommandPresent("-force")
