ListOfDevicesFlatOutput Function

 

This function operates the same as the ListOfDevices 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 ListOfDevices topic. The function returns the key field values for the device, typically in the order of bus number 1, bus number 2 (where applicable), and circuit identifier (where applicable). These are the most common key fields, but some object types do have other key fields as well.

 

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.