Welcome to
www.tdxlibrary.org
Home of the
the TDx_Library...
"RAD DirectX"
for
C++ Builder
...
|
TDx_Play_Library v2.00 Component Reference
|
|
[ TDx_Play::SetPlayerName() ]
[ next: SetSessionDesc() ]
[ prev: SetPlayerData() ]
public:
virtual bool __fastcall SetPlayerName( DPID pPlayer, TDPName* pPlayerName, dword pFlags );
TDX_PLAY::SETPLAYERNAME()
[ component method ]
- Description
The
SetPlayerName
method
is
used
to
change
or
set
the
name
of
an
existing
player.
Only
the
computer
that
created
the
player
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_INVALIDOBJECT
DPERR_INVALIDPLAYER
- Parameters
Player
The Player parameter identifies the player whose name is to be set.
PlayerName
The PlayerName parameter references a TDPName component holding the new name for the specified player.
Set NULL if the player 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.
DPSET_GUARANTEED
The name is to be propagated with 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.
This is the default value.
- See Also
- Top
If you would like to submit additions or improvements to this page, click: darren_john_dwyer@hotmail.com.
|
|