Welcome to
www.tdxlibrary.org
Home of the
the TDx_Library...
"RAD DirectX"
for
C++ Builder
...
- Description
The SetGroupData method will associate application specific data with the specified group.
There are two types of group data, local and remote. Local data is only available to the local computer, while remote data is propogated to all applications in the session via a DPMSG_SETPLAYERORGROUPDATA message.
Only the computer that created the group may modify its data.
To update real time information, TDx_Play::Send() or TDx_Play::SendEx() should be used, this method is more appropriate for sharing information that does not change rapidly.
Error values that can be generated are:
DPERR_BUFFERTOOSMALL
DPERR_INVALIDGROUP
DPERR_INVALIDOBJECT
DPERR_INVALIDPARAMS
DPERR_INVALIDPLAYER
- Parameters
Group
The Group parameter identifies the group with which the data is to be associated.
Data
The Data parameter references the data to be associated with the specified Group.
Set NULL to clear any data already associated with the specified group.
DataSize
The DataSize parameter defines the size of the Data buffer.
When Data is NULL, this parameter must be zero.
Flags
The Flags parameter defines flags indicating how to propagate the data.
The described effect applies when the flag is set.
The default value of zero will result in remote data being propagated with non-guaranteed messaging.
-
DPSET_GUARANTEED
The remote data is to be propagated with guaranteed messaging.
DPSET_REMOTE must also be set.
DPSET_LOCAL
The data is to be used locally and will not be propagated.
DPSET_REMOTE
The data will be propagated to all the applications in the session.
The group must be owned by the local session for this flag to be set.
- See Also
- Top
TDx_Play_Library v2.00 Component Reference
|
|
|
[ TDx_Play::SetGroupData() ] [ next: SetGroupName() ] [ prev: SetGroupConnectionSettings() ] public:
virtual bool __fastcall SetGroupData( DPID pGroup, void* pData, dword pDataSize, dword pFlags );
TDX_PLAY::SETGROUPDATA()
[ component method ]
If you would like to submit additions or improvements to this page, click: darren_john_dwyer@hotmail.com. |
|