Previous Topic: External Agent Socket API Response MessageNext Topic: External Agent Socket API Response Data Elements

External Socket Agent API › Socket Agent › External Agent Socket API Messages › External Agent Socket API Response Message › External Agent Response Data Header

External Agent Response Data Header

The External Agent Socket API Response Data Header is at the beginning of the data packet.

Bytes

Field Name

Type

Description

Mandatory?

1 – 4

Completion ID

UINT4
Big-endian.

A non-zero number, returned by the External Agent that is used to uniquely identify the message.

Yes

5-8

Process Result

HRESULT

This field contains the HRESULT of processing the message. This is the same process result as may be found on the secondary header.

Yes

9 – 12

Element Count

UINT4
Big-endian

Number of Data Elements.

Yes

13 – 16

Reserved 1

UINT4
Big-endian.

Reserved.

No