GetParametersSingleElement Function

 

The GetParametersSingleElement function is used to request the values of specified fields for a particular object in the load flow case. For returning field values for multiple objects, you can use a loop to make repeated calls to the GetParametersSingleElement function, and pass the object and desired field information for each object. This function is identical in setup to the ChangeParameters function, with the exception that the Values array will be updated with the values for the field variables defined in ParamList.

 

Function Prototype

GetParametersSingleElement(ObjectType, ParamList, Values)

 

Parameter Definitions

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

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 Fields. The ParamList must contain the key field variables or label for the specific device, or the device cannot be identified. The remaining field variables in the array define which values to retrieve from Simulator.

Values : Variant A variant array storing variants. This array can store any type of information (integer, string, etc.) in each array position. Values must be passed for the key field variables in ParamList, in the same array position. The remaining field positions in the Values array should be set to zero.

 

Output

The output is a variant array:

Output(0) — error string

Output(1) — one-dimensional array containing the values corresponding to the fields specified in ParamList

 

Output Structure

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