Welcome to
www.tdxlibrary.org
Home of the
the TDx_Library...
"RAD DirectX"
for
C++ Builder
...
- Description
The SetGroupName method is used to change or set the name of an existing group.
Only the computer that created the group may modify its name.
All other players will receive a DPMSG_SETPLAYERORGROUPNAME, provided DPSESSION_NODATAMESSAGES has not been set in the session description.
Error values that can be generated are:
DPERR_CONNECTIONLOST
DPERR_INVALIDGROUP
DPERR_INVALIDOBJECT
DPERR_INVALIDPARAMS
DPERR_INVALIDPLAYER
- Parameters
Group
The Group parameter identifies the group whose name is to be set.
GroupName
The GroupName parameter references a TDPName component holding the new name for the specified Group.
Set NULL if the group has no name information.
Flags
The Flags parameter defines flags indicating how to propagate the name.
The described effect applies when the flag is set.
The default setting of zero will result in the name being propagated to all the remote systems in the local session using nonguaranteed messaging.
The default can only be used for groups owned by the local session.
-
DPSET_GUARANTEED
The name is to be propagated to remote applications using guaranteed messaging.
DPSET_REMOTE must also be set.
DPSET_LOCAL
The name is to be used locally and will not be propagated.
DPSET_REMOTE
The name 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::SetGroupName() ] [ next: SetGroupOwner() ] [ prev: SetGroupData() ] public:
virtual bool __fastcall SetGroupName( DPID pGroup, TDPName* pGroupName, dword pFlags );
TDX_PLAY::SETGROUPNAME()
[ component method ]
If you would like to submit additions or improvements to this page, click: darren_john_dwyer@hotmail.com. |
|