Microsoft DirectX 9.0 SDK Update (Summer 2003)

IDirectPlay8Server::GetSPCaps Method


Retrieves the DPN_SP_CAPS structure for the specified service provider.

Syntax

HRESULT GetSPCaps(      

    const GUID *const pguidSP,     DPN_SP_CAPS *const pdpnSPCaps,     const DWORD dwFlags );

Parameters

pguidSP
[in] Pointer to a globally unique identifier (GUID) specifying the service provider you want to get information about.
pdpnSPCaps
[out] Pointer to a DPN_SP_CAPS structure to receive the information about the specified service provider. You must set the pdpnSPCaps.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

This method retrieves information about the specified service provider. A successful call to IDirectPlay8Server::Initialize must be made before this method can be called.



© 2003 Microsoft Corporation. All rights reserved.