Platform SDK: DirectX

IDirectPlay4::GetPlayerCaps

The IDirectPlay4::GetPlayerCaps method retrieves the current capabilities of a specified player.

HRESULT GetPlayerCaps(
  DPID idPlayer,
  LPDPCAPS lpPlayerCaps,
  DWORD dwFlags
);

Parameters

idPlayer
Player ID for which the capabilities should be computed.
lpPlayerCaps
Pointer to a DPCAPS structure that will be filled with the capabilities. The dwSize member of the DPCAPS structure must be filled in before using IDirectPlay4::GetPlayerCaps.
dwFlags
If this parameter is set to 0, the capabilities will be computed for nonguaranteed messaging.
DPGETCAPS_GUARANTEED
Retrieves the capabilities for a guaranteed message delivery.

Return Values

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

DPERR_INVALIDOBJECT
DPERR_INVALIDPARAMS
DPERR_INVALIDPLAYER

Remarks

This method returns the capabilities of the requested player, while the IDirectPlay4::GetCaps method returns the capabilities of the current session.

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

DPCAPS, IDirectPlay4::GetCaps, IDirectPlay4::Send