Welcome to
www.tdxlibrary.org
Home of the
the TDx_Library...
"RAD DirectX"
for
C++ Builder
...
- Description
The ReceiveEx method will retrieve one message from the incoming message queue.
Error values that can be generated are:
DPERR_BUFFERTOOSMALL
DPERR_GENERIC
DPERR_INVALIDOBJECT
DPERR_INVALIDPARAMS
DPERR_INVALIDPLAYER
DPERR_NOMESSAGES
- Parameters
From
The From parameter will identify the player that sent the message if this method returns successfully.
When DPRECEIVE_FROMPLAYER is set, you must identify the sending player in this parameter.
To
The To parameter will identify the player receiving the message if this method return successfully.
When DPRECEIVE_TOPLAYER is set, you must identify the receiving player in this parameter.
Flags
The Flags parameter defines flags indicating how a message is to be retrieved and treated.
The described effect applies when the flag is set.
The default setting of zero is equivalent to DPRECEIVE_ALL.
-
DPRECEIVE_ALL
The first relevent message in the queue will be retrieved.
DPRECEIVE_FROMPLAYER
Retrieve only the messages sent from the player identified by the From parameter.
DPRECEIVE_PEEK
Retrieves a message defined by the other flag settings without removing the message from the queue.
This flag should be set when the Data parameter is NULL.
DPRECEIVE_TOPLAYER
Retrieve only the messages sent to the player identified by the To parameter.
The Data parameter references a buffer for holding the message data if this method returns successfully.
Set NULL to allocate appropriate memory to hold the message data, the DataSize parameter will be set to the size of the data.
If previously allocated memory is used and the message data requires more memory than the amount specified by the DataSize initial value, the memory will be released and replaced with the required memory block.
DataSize
The DataSize parameter references the size, in bytes, of the Data buffer.
This parameter will be set to the size of the message data when the method returns.
- See Also
- Top
TDx_Play_Library v2.00 Component Reference
|
|
|
[ TDx_Play::Receive() ] [ next: ReceiveEx() ] [ prev: Open() ] public:
virtual HRESULT __fastcall Receive( DPID* pFrom, DPID* pTo, dword pFlags, void* pData, dword* pDataSize );
TDX_PLAY::RECEIVE()
[ component method ]
If you would like to submit additions or improvements to this page, click: darren_john_dwyer@hotmail.com. |
|