Structure Response (CIGI Packets)
| Structure Type | N/A | |||
|---|---|---|---|---|
| Packet ID | 211 | |||
| Packet Size (bytes) | 253 | |||
| SpyClient Lookup | N/A | |||
| Parameter | Type | Description | Range | |
| StructureIndex | uint32 | The index in the Global Namespace that the response applies to. | 0, (232 - 1) | |
| DataUsage | uchar | The way the structure data is used. 0 = NA_DATA 1 = CONTROL_DATA 2 = FEEDBACK_DATA 3 = PROPERTIES_DATA | 0 - 3 | |
| TotalSizeInBytes | uchar | Size of structure being described. | If dataUsage == CONTROL_DATA or FEEDBACK_DATA: size of structure, otherwise, 0. | |
| Name | uchar | Name of the queried capability. | ASCII(32 - 126) and NULL terminator | |
| NumFields | uint32 | The number of fields associated with this response. | 0, (232 - 1) | |
| ResponseIndex | uint32 | The index of this packet, out of all packets, in the response to the enumerationIndex. | 0, ((NumFields - 1)/2) | |
| Value0.Type | uint32 | The data type for the field. | Enumerated types, discoverable via introspection. | |
| Value0.Name | uchar | Name of value0. | ASCII(32 - 126) and NULL terminator | |
| Value0.Count | uint16 | The number of repeated instances of this field if type is not BIT. If it is BIT, then it's the number of BITs in the field. | 0, (216 - 1) | |
| Value0.Offset | uint16 | The offset of the field in the structure. If not BIT, the value is in bytes; if BIT, the value is in BITs. | 0, (216 - 1) | |
| Value0.Units | uint32 | The units associated with the field. | Enumerated types, discoverable via introspection if type is not an ENUM. If type is ENUM, then it is the Global Namespace Index for the enumeration that represents the field values. | |
| Value0.Minimum | uint32 | The minimum value for the field, cast appropriately according to type. | Varies | |
| Value0.Maximum | uint32 | The maximum value for the field, cast appropriately according to type. | Varies | |
| Value0.default | uint32 | The default value for the field, cast appropriately according to type. | Varies | |
| Value1.Type | uint32 | The data type for the field. | Enumerated types, discoverable via introspection. | |
| Value1.Name | uchar | Name of value1. | ASCII(32 - 126) and NULL terminator | |
| Value1.Count | uint16 | The number of repeated instances of this field if type is not BIT. If it is BIT, then it's the number of BITs in the field. | 0, (216 - 1) | |
| Value1.Offset | uint16 | The offset of the field in the structure. If not BIT, the value is in bytes; if BIT, the value is in BITs. | 0, (216 - 1) | |
| Value1.Units | uint32 | The units associated with the field. | Enumerated types, discoverable via introspection if type is not an ENUM. If type is ENUM, then it is the Global Namespace Index for the enumeration that represents the field values. | |
| Value1.Minimum | uint32 | The minimum value for the field, cast appropriately according to type. | Varies | |
| Value1.Maximum | uint32 | The maximum value for the field, cast appropriately according to type. | Varies | |
| Value1.default | uint32 | The default value for the field, cast appropriately according to type. | Varies | |