The SIMCONNECT_RECV_SIMOBJECT_DATA structure will be received by the client after a successful call to SimConnect_RequestDataOnSimObject or SimConnect_RequestDataOnSimObjectType.

 

Syntax
struct SIMCONNECT_RECV_SIMOBJECT_DATA : public SIMCONNECT_RECV {
    DWORD  dwRequestID;
    DWORD  dwObjectID;
    DWORD  dwDefineID;
    DWORD  dwFlags;
    DWORD  dwentrynumber;
    DWORD  dwoutof;
    DWORD  dwDefineCount;
    DWORD  dwData;
    };

 

Members
MemberDescription
dwRequestIDThe ID of the client defined request.
dwObjectID

The ID of the client defined object.

dwDefineIDThe ID of the client defined data definition.
dwFlagsThe flags that were set for this data request, see SimConnect_RequestDataOnSimObject for a description of the flags. This parameter will always be set to zero if the call was SimConnect_RequestDataOnSimObjectType.
dwentrynumberIf multiple objects are being returned, this is the index number of this object out of a total of dwoutof. This will always be 1 if the call was SimConnect_RequestDataOnSimObject, and can be 0 or more if the call was SimConnect_RequestDataOnSimObjectType.
dwoutofThe total number of objects being returned. Note that dwentrynumber and dwoutof start with 1 not 0, so if two objects are being returned dwentrynumber and dwoutof pairs will be 1,2 and 2,2 for the two objects. This will always be 1 if the call was SimConnect_RequestDataOnSimObject, and can be 0 or more if the call was SimConnect_RequestDataOnSimObjectType.
dwDefineCountThe number of 8-byte elements in the dwData array.
dwData

A data array containing information on a specified object in 8-byte (double word) elements. The length of the array is dwDefineCount.

The format of this buffer will depend of presence (or absence) of the SIMCONNECT_DATA_REQUEST_FLAG_TAGGED flag sent with the SimConnect_RequestDataOnSimObject.

SIMCONNECT_DATA_REQUEST_FLAG_TAGGED disabled:

  1. The various elements of the data definition are stored right next to each other, with no padding.
  2. Data will look like: DATA_0 DATA_1 DATA_2...

SIMCONNECT_DATA_REQUEST_FLAG_TAGGED enabled:

  1. Before each element of the data, the index of the elements will be stored as a DWORD. Then the actual data will be stored with no padding.
  2. Data will look like: DWORD_0 DATA_0 DWORD_1 DATA_1 DWORD_2 DATA_2...

 

Remarks

 

This structure inherits the SIMCONNECT_RECV structure and is returned when the dwID parameter of SIMCONNECT_RECV is set to SIMCONNECT_RECV_ID_SIMOBJECT_DATA.