GetParametersMultipleElementFlatOutput Function

 

This function operates the same as the GetParametersMultipleElement function, only with one notable difference. The values returned as the output of the function are returned in a single-dimensional vector array, instead of the multi-dimensional array as described in the GetParametersMultipleElement topic. The function returns the parameter values for the device type requested, and the number of values returned depends on the ParamList and any advanced filter that impacts the number of devices returned.

The format of the output array is the following:

 

[errorString, NumberOfObjectsReturned, NumberOfFieldsPerObject, Ob1Fld1, Ob1Fld2, …, Ob(n)Fld(m-1), Ob(n)Fld(m)]

 

The data is thus returned in a single dimension array, where the parameters NumberOfObjectsReturned and NumberOfFieldsPerObject tell you how the rest of the array is populated. Following the NumberOfObjectsReturned parameter is the start of the data. The data is listed as all fields for object 1, then all fields for object 2, and so on. You can parse the array using the NumberOf… parameters for objects and fields.

 

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.)