Help file: OS_CommandPresent

[Petr Schreiber]

My proposal for documentation enhancement of thinBasic Modules > OS (Operating System) > OS_CommandPresent

Description
Checks command line for presence of specified parameter and in case it is found, returns its position.

Syntax
nPosition = OS_CommandPresent(parameterName)

Returns
One based index of the parameter position.
In case the parameter isn't found, zero is returned.

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
OS_GetCommand
OS_GetCommands

Examples
' -- Returns position of -force parameter on the command line
' -- In case it is not found, zero is returned
n = OS_CommandPresent("-force")