Welcome to
www.tdxlibrary.org
Home of the
the TDx_Library...
"RAD DirectX"
for
C++ Builder
...
- Description
The GetMessageQueue method retrieves how many messages are on the local send or receive queues for the session.
On slower networks, this information can be used to regulate network usage.
These message queues are for all local players in the session, not neccessarily individual players.
Error values that can be generated are:
DPERR_INVALIDFLAGS
DPERR_INVALIDPARAMS
DPERR_INVALIDPLAYER
DPERR_UNSUPPORTED
- Parameters
From
The From parameter identifies the player who has sent the messages.
Setting zero obtains the number of messages recieved from all players.
To
The To parameter identifies the player who is to receive the messages.
Setting zero obtains the number of messages sent to all players.
Flags
The Flags parameter defines flags indicating which queue's information is the be retrieved.
The default value of zero is equivilent to DPMESSAGEQUEUE_SEND.
-
DPMESSAGEQUEUE_RECEIVE
Retrieve receive queue information.
DPMESSAGEQUEUE_SEND should not also be set.
DPMESSAGEQUEUE_SEND
Retrieve send queue information.
DPMESSAGEQUEUE_RECEIVE should not also be set.
The NumMsgs parameter will reference the number of messages in the requested queue.
Set NULL if the number of messages is not required.
NumBytes
The NumMsgs parameter will reference the number of bytes in the requested queue.
Set NULL if the queue size is not required.
- See Also
- Top
TDx_Play_Library v2.00 Component Reference
|
|
|
[ TDx_Play::GetMessageQueue() ] [ next: GetPlayerAccount() ] [ prev: GetMessageCount() ] public:
virtual bool __fastcall GetMessageQueue( DPID pFrom, DPID pTo, dword pFlags, dword* pNumMsgs, dword* pNumBytes );
TDX_PLAY::GETMESSAGEQUEUE()
[ component method ]
If you would like to submit additions or improvements to this page, click: darren_john_dwyer@hotmail.com. |
|