GetParameterOptions()

Gets the available options for the value of the specified System Coupling parameter (setting) and returns them as a tuple.

If called for a non-string valued parameter or a parameter that does not have a finite set of available options defined, then an empty tuple is returned.

This query should be used only for parameters that are known to exist in the data model state.

Essential Keyword Arguments

ObjectPath : string

Path of the object under which the specified parameter is defined.

Name : string

String indicating the internal name of the parameter for which a list of options is returned.

Return Type

Tuple

Examples

Example 34: Get possible options for a given parameter

 
 
GetParameterOptions(ObjectPath='/SystemCoupling/AnalysisControl', Name='PartitioningAlgorithm')

('SharedAllocateMachines', 'SharedAllocateCores', 'DistributedAllocateCores', 'DistributedAllocateMachines')