GetParamsTypedCols Function

 

The GetParamsTypedCols function is used to request the values of specified fields of a specified type for a set of objects in the case. The fields that are returned must all be convertible to the specified type. This function is similar to the GetParamsRectTyped function but has the advantage of being able to specify the data type of each different returned field. The structure of the output is similar to GetParametersMultipleElement.

 

Function Prototype

GetParametersTypedCols(ObjectType, ParamList, Filter, ColTypes)

 

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.

ColTypes : VARENUM type or Array of VARENUM types VARENUM type is an enumerated type representing supported variant types: VT_I2, VT_I4, VT_R4, VT_R8, VT_BSTR, and VT_VARIANT. If all fields to be returned are of the same type, only a single VARENUM value may be specified. If each field is of a different type, pass an array of the same dimension as ParamList with the specified type index corresponding to the field index in the ParamList for the desired field type. The values for all fields must be convertible to the specified type. For example it is invalid to retrieve a branch status field as an integer or float, but it is valid to retrieve a numerical field into a string or variant array.

If the type is specified as VT_VARIANT, the resulting value array will contain variants of VT_I4, VT_R8, or VT_BSTR depending on whether the column is an integer field, a floating point field, or a field of any other type represented by a string.

 

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.

The output is a variant array:

Output(0) — error string

Output(1) — set of nested arrays containing the parameter values for the device type requested. The number of arrays of values returned depends on the number of fields in ParamList. The values will be returned as the specified ColTypes.

 

Output Structure

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