Execute

<< Click to Display Table of Contents >>

Navigation:  NxLib API > C# Interface / CLI > NxLibCommand >

Execute

Starts the execution of the command given at construction time of the object.

Signatures

Error handling via exception:

void Execute()

void Execute(bool Wait)

void Execute(String^ commandName)

void Execute(String^ commandName, bool wait)

Error handling via return code:

void Execute(Out int returnCode, bool Wait)

void Execute([Out] int% returnCode, String^ commandName)

void Execute([Out] int% returnCode, String^ commandName, bool wait)

Parameters

returnCode

The API return code.

commandName

The command name to execute. This overrides the command name specified in the constructor. It can be used to cancel commands by issuing cmdBreak while a command is running. When commandName is not specified, the command name as given to the constructor is used.

wait

Specifies whether the execution should be carried out synchronously (i.e. the function waits for the execution to finish), or whether the function should return after starting the command execution.

Return Value

none