Platform SDK: DirectX

IDirectPlay4::GetCaps

The IDirectPlay4::GetCaps method obtains the capabilities of this DirectPlay object.

HRESULT GetCaps(
  LPDPCAPS lpDPCaps,
  DWORD dwFlags
);

Parameters

lpDPCaps
Pointer to a DPCAPS structure that will be filled with the capabilities of the DirectPlay object. The dwSize member of the DPCAPS structure must be filled in before using IDirectPlay4::GetCaps.
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

Remarks

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

Note that capabilities indicating which aspects of SendEx are supported are not available until after the session has been opened. If the application hosting the session has specified the DPSESSION_DIRECTPLAYPROTOCOL flag in the DPSESSIONDESC2 structure, then all the SendEx options are supported.

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::GetPlayerCaps, IDirectPlay4::Send