RECEIVEINFO structure

This structure can do either of the following:

Provide information about received messages to the thread.
Return information about the operation just completed.

The precise structure is service-dependent since it contains a control message whose size is determined by the service. In general, the structure takes the form shown below.

Syntax

typedef struct tagReceiveInfo {
    WORD wFlags;
    WORD wStatus;
    WORD wTransID;
    DWORD dwDataSize;
    LPVOID pData;
    WORD _reserved;
    RTHANDLE hForwPort;
    GENADDR LocalAddress;
    GENADDR RemoteAddress;
    WORD wControlMsgLength;
    BYTE byControlMessage[1];
} RECEIVEINFO, *LPRECEIVEINFO;);

Fields

wFlags

Contains type information for the received message:

Data type	Defines the data transmission type: CONTIGUOUS_BUFFER DATA_CHAIN DATA_LIST
Receive type	Identifies the received message type: NORMAL_MESSAGE STATUS_MESSAGE REQUEST_MESSAGE RESPONSE_MESSAGE It also determines the correct interpretation of the status and other receive fields.

wStatus

The send message status.

wTransID

A transaction ID:

`0` (zero)	A new transactionless message has been received.
Non-zero	A request or response message, or a status message indicating an erroneous asynchronous transmission has been received.

dwDataSize

Specifies the received data message's length.

pData

Pointer to the data part of the message, if any.

hForwPort

The destination port's source port, if the destination port is a sink port.

LocalAddress

A GENADDR structure that contains the address at which the message was received.

RemoteAddress

A GENADDR structure that corresponds to the remote address from which the message was received.

wControlMsgLength

The maximum number of bytes in the byControlMessage field.

byControlMessage

The control message received.

Syntax

Fields

See Also