/
getParameterUserValue
getParameterUserValue
Description
This command gets the user value of the subject static parameter. It takes one argument, which is a string, and must be the name of the parameter whose user value you want to obtain. It is valid for static parameters only, as only static parameters can have user values. If used on a dynamic parameter, the command will produce an error stating this.
Functional area
Parameters
Command syntax
Syntax
getParameterUserValue parameterName [-onMod string] [-solving] |
Arguments
Name | Type | Required | Comments |
---|---|---|---|
parameterName | string | yes | The name of the static parameter whose user value you want to obtain |
Flags
Name | Flag arguments | Argument type | Exclusive to | Comments |
---|---|---|---|---|
onMod | 1 | string | — | The 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
float
, multiple selections available,
Related content
setStaticParameterUserValue
setStaticParameterUserValue
More like this
getParameterExpression
getParameterExpression
More like this
setStaticParameterExpression
setStaticParameterExpression
More like this
setStaticParameterExpression
setStaticParameterExpression
More like this
getParameterPriorValue
getParameterPriorValue
More like this
getParameters
getParameters
More like this