Microsoft DirectX 9.0 SDK Update (Summer 2003)

IDirectPlay8Client::SetSPCaps Method


Sets the DPN_SP_CAPS structure for the specified service provider.

Syntax

HRESULT SetSPCaps(      

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

Parameters

pguidSP
[in] Pointer to a globally unique identifier (GUID) that specifies the service provider to set information about.
pdpnSPCaps
[in] Pointer to a DPN_SP_CAPS structure to set the information about the specified service provider.
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 sets parameters for the specified service provider. A successful call to IDirectPlay8Client::Initialize must be made before this method can be called. Currently, only the dwSystemBufferSize member can be set by this call. The dwNumThreads member is for legacy support. Microsoft DirectX® 9.0 applications should use the IDirectPlay8ThreadPool::SetThreadCount method to set the number of threads. The other members of the DPN_SP_CAPS structure are get-only or ignored.



© 2003 Microsoft Corporation. All rights reserved.