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::DestroyPlayer() ]
[ next: EnumConnections() ]
[ prev: DestroyGroup() ]
public:
virtual bool __fastcall DestroyPlayer( DPID pPlayer );
TDX_PLAY::DESTROYPLAYER()
[ component method ]
- Description
The
DestroyPlayer
method
will
destroy
a
specified
player
within
the
session.
The
player
is
removed
from
any
groups,
and
all
messages
for
the
player
are
removed
from
the
queue.
Any
messages
in
the
players
asynchronous
queue
must
be
cancelled
or
sent
prior
to
this
method
call.
The
player
ID
will
not
be
reused
during
the
session.
The
player
is
usually
only
destroyed
by
the
creating
application,
but
the
the
session
host
may
destroy
any
player
in
the
session.
A
DPMSG_DELETEPLAYERFROMGROUP
message
is
generated
for
each
group
the
player
was
in,
followed
by
a
DPMSG_DESTROYPLAYERORGROUP
message.
Error
values
that
can
be
generated
are:
DPERR_ACCESSDENIED
DPERR_CONNECTIONLOST
DPERR_INVALIDOBJECT
DPERR_INVALIDPLAYER
DPERR_UNAVAILABLE
- Parameters
Player
The Player parameter identifies the player to be destroyed.
- See Also
- Top
If you would like to submit additions or improvements to this page, click: darren_john_dwyer@hotmail.com.
|
|