Vicon Shogun banner

Description

This command returns a string that contains the expression used by the subject static parameter. The string is empty if no expression is in use. It is valid for static parameters only, as only static parameters can have expressions. If used on a dynamic parameter, the command will produce an error stating this.

Functional area

Parameters

Command syntax

Syntax

getParameterExpression parameterName [-onMod string] [-solving]

Arguments

NameTypeRequiredComments
parameterNamestringyesThe name of the static parameter whose expression you want to obtain

Flags

NameFlag argumentsArgument typeExclusive toComments
onMod1stringThe character that owns the parameter must be selected. If not, you can use the onMod flag to specify it.
solving


By default, the command operates on labeling setup parameters. For solving setup parameters, use the solving flag.

Return value

string