Skip to main content Skip to complementary content

SelectListObjectValues method

Makes single selections in dimensions.

Information note

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 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 Integer
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

See also

Select values in a list object

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!