GetSpecificFieldList Function

 

The GetSpecificFieldList function is used to return identifying information about specific fields used by an object type.

 

Function Prototype

GetSpecificFieldList(ObjectType, FieldList)

 

Parameter Definitions

ObjectType : String The type of object for which fields are requested.

FieldList : Variant A variant array storing strings. This array stores a list of object field variables, as defined in the section on PowerWorld Object Fields. Specific variablenames along with location numbers can be specified. To return all fields using the same variablename, use "variablename:ALL" instead of the location number that would normally appear after the colon. If all fields should be returned, a single parameter of "ALL" can be used instead of specific variablenames.

 

Output

GetSpecificFieldList returns a two dimensional variant array. The first dimension, Output(0) contains the error string. The second dimension, Output(1), is a rectangular array indexed from 0 with a size of n x 5 where n is the number of fields that are returned. The specific information that is returned is as follows:

Output(1)(n,0) - variablename:location (this will either be the legacy or concise variablename depending on option settings)

Output(1)(n,1) - field (this is the identifier that is displayed when looking through the list of available fields for an object in a case information display in the GUI)

Output(1)(n,2) - column header (this is the column header that appears in a case information display in the GUI)

Output(1)(n,3) - field description

Output(1)(n,4) - enterable (will be blank if the field is not enterable, Yes if enterable, or will contain an explanation if conditionally enterable) Added in version 22, build on November 19, 2021