Welcome to
www.tdxlibrary.org
Home of the
the TDx_Library...
"RAD DirectX"
for
C++ Builder
...
- Description
The GetPlayerData method will retrieve application specific data previously associated with the player by TDx_Play::SetPlayerData().
Local data is set by this TDx_Play component using DPSET_LOCAL, while remote data may have been set by any application in the session using DPSET_REMOTE.
Error values that can be generated are:
DPERR_BUFFERTOOSMALL
DPERR_INVALIDFLAGS
DPERR_INVALIDOBJECT
DPERR_INVALIDPLAYER
- Parameters
Player
The Player parameter identifies the player for which the data is to be retrieved.
Data
The Data parameter references a buffer for holding the retrieved data if this method returns successfully.
Set NULL to allocate appropriate memory to hold the data, the DataSize parameter will be set to the size of the data.
If previously allocated memory is used and the retrieved 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 Data when the method returns.
Flags
The Flags parameter defines flags indicating which data type is to be retrieved.
The described effect applies when the flag is set.
The default setting of zero is equivilent to DPGET_REMOTE.
-
DPGET_LOCAL
The local data that was set by this application will be retrieved.
DPGET_REMOTE
The current data of the remote shared data space will be retrieved.
- See Also
- Top
TDx_Play_Library v2.00 Component Reference
|
|
|
[ TDx_Play::GetPlayerData() ] [ next: GetPlayerFlags() ] [ prev: GetPlayerCaps() ] public:
virtual bool __fastcall GetPlayerData( DPID pPlayer, void* pData, dword* pDataSize, dword pFlags );
TDX_PLAY::GETPLAYERDATA()
[ component method ]
If you would like to submit additions or improvements to this page, click: darren_john_dwyer@hotmail.com. |
|