IDirectPlay8LobbyClient::SetConnectionSettings Method

DirectPlay

 
Microsoft DirectX 9.0 SDK Update (Summer 2003)

IDirectPlay8LobbyClient::SetConnectionSettings Method


Sets the connection settings to be associated with the specified connection. Calling this method will generate a DPL_MSGID_CONNECTION_SETTINGS message to be sent to the client specified by hConnection.

When you set connection settings, the lobby application will add a reference to each of the address objects specified in the call.

Syntax

HRESULT SetConnectionSettings(      
    const DPNHANDLE hConnection,     const DPL_CONNECTION_SETTINGS *const pdplConnectSettings,     const DWORD dwFlags );

Parameters

hConnection
[in] Handle to the connection to set the settings for. You may also specify the following flag.
DPLHANDLE_ALLCONNECTIONS
The connection settings will be updated for all the lobbied applications you are connected to.
pdplConnectSettings
[in] Pointer to a DPL_CONNECTION_SETTINGS structure containing the settings associated with the specified connection.
dwFlags
[in] Reserved, must be 0.

Return Value

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

DPNERR_INVALIDPARAMOne or more of the parameters passed to the method are invalid.
DPNERR_INVALIDOBJECTThe Microsoft® DirectPlay® object pointer is invalid.
DPNERR_INVALIDFLAGSThe flags passed to this method are invalid.



© 2003 Microsoft Corporation. All rights reserved.