Platform SDK: DirectX

IDirectPlay4::GetPlayerFlags

The IDirectPlay4::GetPlayerFlags method returns the flags describing the player.

HRESULT GetPlayerFlags(
  DPID idPlayer,
  LPDWORD lpdwFlags
);

Parameters

idPlayer
ID of the player whose flag settings are to be retrieved.
lpdwFlags
Pointer to a DWORD to be set to the player's flag settings. Can be one or more of the following:
DPPLAYER_LOCAL
The player was created by this application. If this flag is not specified, the player is a remote player.
DPPLAYER_SERVERPLAYER
The player is a server player for client/server communications.
DPPLAYER_SPECTATOR
The player was created as a spectator.

Return Values

Returns DP_OK if successful, or one of the following error values otherwise:

DPERR_INVALIDPARAMS
DPERR_INVALIDPLAYER

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in dplay.h.
  Import Library: Use dplayx.lib.

See Also

IDirectPlay4::CreatePlayer