SelectListObjectValues method
Makes single selections in dimensions.
This method applies to list objects only.
The member Change returns the handles of the objects that are updated following the selections.
qSuccess is set to true if the selections are successful and is set to false in the following cases:
- The object contains some invalid fields (fields that are not in the data model).
- The selection applies to a locked field.
- A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.
Parameters
| Name | Description | Mandatory | Type |
|---|---|---|---|
| qPath | Path to the definition of the object to be selected. For example, /qListObjectDef . |
Yes | String |
| qValues | Element numbers to select. You can select multiple values; the separator is the comma. |
Yes | Array of Integers |
| qToggleMode | Set to true to toggle. |
Yes | Boolean |
| qSoftLock | Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. |
No | Boolean |
Returns
| Name | Description | Type |
|---|---|---|
| qSuccess | true/false |
Boolean |