GetParametersMultipleElementRect Function

 

The GetParametersMultipleElementRect function is used to request the values of specified fields for a set of objects in the case. The function can return values for all devices of a particular type, or can return values for only a list of devices of a particular type based on a filter defined for the loaded case. This function is similar to the GetParametersMultipleElement function but has the advantages of being much faster and the output structure being easier to process in most programming languages.

 

Function Prototype

GetParametersMultipleElementRect(ObjectType, ParamList, Filter)

 

Parameter Definitions

ObjectType : String The type of object for which parameters are being retrieved

ParamList : Variant A variant array storing strings. This array stores a list of PowerWorldâ object field variables, as defined in the section on PowerWorld Object Variables, for the values to retrieve from Simulator.

Filter : String The name of an advanced filter, a device filter, or a single-condition filter. If no filter is desired, simply pass an empty string. An error will be returned if a named filter cannot be found, device cannot be found for a device filter, or a single-condition filter is in the wrong format.

 

Output

When Difference Case Tools and DiffCaseMode = Change, then using the various get parameters calls will only return objects that have input parameters specified that have at least one non-key field that has changed (this was added in Version 23 patch on June 25, 2024.)

The output is a variant array:

Output(0) — error string

Output(1) — Two-dimensional variant array containing variants with each row representing an object and the corresponding columns representing each field in ParamList for that object.

 

Output Structure

The Output structure of GetParametersMultipleElementRect is shown in the following figure: