OS_CommandPresent

<< Click to Display Table of Contents >>

Navigation:  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

 

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

 

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")