Microsoft DirectX 9.0 SDK Update (Summer 2003)

IDirectPlay8Client::GetCaps Method


Retrieves the DPN_CAPS or DPN_CAPS_EX structure for the current interface.

Syntax

HRESULT GetCaps(      

    DPN_CAPS *const pdpnCaps,     const DWORD dwFlags );

Parameters

pdpnCaps
[out] Pointer to a DPN_CAPS or DPN_CAPS_EX structure to receive caps information. You must set the dwSize member of this structure to an appropriate value.
dwFlags
[in] Reserved. Must be 0.

Return Value

Returns S_OK if successful, or one of the following error values.

DPNERR_INVALIDOBJECTThe Microsoft® DirectPlay® object pointer is invalid.
DPNERR_INVALIDPARAMOne or more of the parameters passed to the method are invalid.
DPNERR_INVALIDPOINTERPointer specified as a parameter is invalid.
DPNERR_UNINITIALIZEDThe requested object has not been initialized.


Remarks

A successful call to IDirectPlay8Client::Initialize must be made before this method can be called.

DirectPlay will determine whether DPN_CAPS or DPN_CAPS_EX is being used, based on the size of the structure referenced by pdpnCaps.



© 2003 Microsoft Corporation. All rights reserved.