Welcome to
www.tdxlibrary.org
Home of the
the TDx_Library...
"RAD DirectX"
for
C++ Builder
...
- Description
The ReceiveEx method retrieves one message from the incoming message queue, determines what type of message it is, converts data as necessary and triggers a corresponding TDx_Play event, one of :-
TDx_Play::OnCreatePlayerOrGroup()
TDx_Play::OnDestroyPlayerOrGroup()
TDx_Play::OnAddPlayerToGroup()
TDx_Play::OnDeletePlayerFromGroup()
TDx_Play::OnSessionLost()
TDx_Play::OnHost()
TDx_Play::OnSetPlayerOrGroupData()
TDx_Play::OnSetPlayerOrGroupName()
TDx_Play::OnAddGroupToGroup()
TDx_Play::OnDeleteGroupFromGroup()
TDx_Play::OnChat()
TDx_Play::OnSecureMessage()
TDx_Play::OnSendComplete()
TDx_Play::OnSetGroupOwner()
TDx_Play::OnSetSessionDesc()
TDx_Play::OnStartSession()
TDx_Play::OnGeneric()
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.
- See Also
TDx_Play
TDx_Play::OnCreatePlayerOrGroup()
TDx_Play::OnDestroyPlayerOrGroup()
TDx_Play::OnAddPlayerToGroup()
TDx_Play::OnDeletePlayerFromGroup()
TDx_Play::OnSessionLost()
TDx_Play::OnHost()
TDx_Play::OnSetPlayerOrGroupData()
TDx_Play::OnSetPlayerOrGroupName()
TDx_Play::OnAddGroupToGroup()
TDx_Play::OnDeleteGroupFromGroup()
TDx_Play::OnChat()
TDx_Play::OnSecureMessage()
TDx_Play::OnSendComplete()
TDx_Play::OnSetGroupOwner()
TDx_Play::OnSetSessionDesc()
TDx_Play::OnStartSession()
TDx_Play::OnGeneric()
- Top
TDx_Play_Library v2.00 Component Reference
|
|
|
[ TDx_Play::ReceiveEx() ] [ next: SecureOpen() ] [ prev: Receive() ] public:
virtual HRESULT __fastcall ReceiveEx( LPDPID pFrom, LPDPID pTo, DWORD pFlags );
TDX_PLAY::RECEIVEEX()
[ component method ]
If you would like to submit additions or improvements to this page, click: darren_john_dwyer@hotmail.com. |
|