CommandLine (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Windows management functions

Miscellaneous WINDEV functions

BuildAutomationVariant

Calling a DLL written in Visual Basic

Constants for managing the WLanguage types

Constants for sound management

Constants used by ExecutePresetAction

Constants used by the TraceStart function

EndAutomatedProcedure

InAndroidEmulatorMode

InAndroidMode

InAndroidSimulatorMode

InAppleWatchEmulatorMode

InAppleWatchMode

InAppleWatchSimulatorMode

InAutomaticTestMode

InBackgroundMode

InComponentMode

InDelayedProcedureMode

InPocketSimulatorMode

InPrelaunchedSessionMode

InReportsAndQueriesMode

InServiceMode

InSimulatorMode

InStoredProcedureMode

InTSEMode

InTestMode

InUMCMode

InUniversalWindowsAppMode

InUniversalWindowsAppSimulatorMode

InUniversalWindowsPlatformMode

InUniversalWindowsPlatformSimulatorMode

InVGAMode

InWebMode

InWebSocketServerGlobalServiceMode

InWebSocketServerMode

InWindowsPhoneEmulatorMode

InWindowsPhoneMode

InWindowsPhoneSimulatorMode

InWindowsStoreAppMode

InWindowsStoreAppSimulatorMode

StyleDrawCaptionGrayed

Voice commands in your applications

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

CommandLine (Function)

In french: LigneCommande

Identifies and retrieves the different elements of the command line passed as a parameter to the current program.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Example

// The executable is called by the following command line:
// project.exe param1 /opt1=param2 "param31 param32" -opt2="param41 param42"
CommandLine() // Returns the entire command line
CommandLine(1) // Returns 'param1'
CommandLine(2) // Returns '/opt1 = param2'
CommandLine(3) // Returns 'param31 param32'
CommandLine(4) // Returns '-opt2 = "param41 param42"'
CommandLine(5) // Returns ' '
CommandLine("opt1") // Returns 'param2'
CommandLine("opt2") // Returns 'param41 param42'
CommandLine("opt3") // Returns ' '
CommandLine("opt3", "Empty") // Returns 'Empty'

Syntax

Retrieving the entire command line Hide the details

<Result> = CommandLine()

<Result>: Character string

Command line passed to the executable (without the name of the executable itself).

Retrieving the value of Nth parameter in the command line Hide the details

<Result> = CommandLine(<Option subscript>)

<Result>: Character string

Parameter corresponding to the requested subscript.

<Option subscript>: Integer

Subscript of option to retrieve.
Remark: The space character corresponds to the separator.

Retrieving the value of a specific parameter in the command line Hide the details

<Result> = CommandLine(<Option name> , <Default value>)

<Result>: Character string

Value corresponding to the requested parameter.

<Option name>: Character string (with quotes)

Name of option to retrieve. The following syntaxes are accepted:
/<name> = value
-<name> = value
The space character corresponds to the separator. To use a space in the value of a named parameter, the parameter must be enclosed in quotes ("<Parameter with space>").
Example: project.exe param1 /opt1="param2 with spaces".

<Default value>: Character string (with quotes)

Default value returned if the option is not found or does not exist.
By default, the returned value by is an empty string ("").
Example:

CommandLine("select", "False")

Commands:
program.exe -> CommandLine returns "False".
program.exe /select -> CommandLine returns "False".
program.exe /select=abc -> CommandLine returns "abc".

Remarks

In test mode, you can specify the command line in the editor (on the "Project" pane, in the "Test mode" group, expand "Test mode" and select "Configure test mode").
Unlike CommandLine, dbgStandardOutput allows the executable to return a value to the application that started it (write operation in STDOUT).

Business / UI classification: Neutral code

Component: wd260vm.dll