Commands

Navigation:  NxLib API >

Commands

Previous pageReturn to chapter overviewNext page

The item /Execute at the root tree level provides a flexible interface for the execution of predefined library functions.

Note: You might look at the HowTo section to see some C++ code fragments explaining how to perform basic tasks.

To execute a command you might first need to write parameters into the /Execute/Parameters node. Then you can start the execution by writing the command name into the /Execute/Command node. After the command has been executed, the Function subnode will be reset to Null. You can thus wait for the execution to complete by waiting for Command node to become Null again. If the execution was not successful, the it will leave an ErrorSymbol and ErrorText node under the Result subnode. Some commands might also return result values, these will be placed under the Result node. The exact format of the returned result is laid out in the description of the corresponding command.

Common Error Symbols

CommandUnknown

Cause:
The given command is not a valid command name.
Solution:
Specify a valid command name. Command names are also case sensitive.

ParametersInvalid

Cause:
The combination of parameters given is not allowed for the executed command.
Solution:
Refer to the description of the comands parameters to find out about accepted combinations and values.

OperationCanceled

The command was interupted by the execution of the Break command.