IDirectPlay8LobbyClient::GetConnectionSettings Method

Retrieves the set of connection settings for the specified connection. These settings can be set through a call to the IDirectPlay8LobbyClient::ConnectApplication, IDirectPlay8LobbyClient::SetConnectionSettings, or IDirectPlay8LobbiedApplication::SetConnectionSettings method.

When you get connection settings, a reference will be added for each address object that is returned to the user. Therefore, users must be sure to call Release on each address object when they are finished with the structure.

Syntax

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

Parameters

hConnection

[in] Handle to the connection for which to retrieve the settings.

pdplConnectSettings

[out] Pointer to a buffer to receive the connection settings for the specified connection.

pdwDataSize

[in, out] Pointer to a DWORD containing the size, in bytes, of the buffer specified in the pdplConnectSettings structure. If the buffer is not large enough to hold the connection settings, DPNERR_BUFFERTOOSMALL is returned and this value is set to the required buffer size. On success, this value contains the number of bytes written to the specified buffer.

dwFlags

[in] Reserved, must be 0.

Return Value

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

DPNERR_INVALIDPARAM	One or more of the parameters passed to the method are invalid.
DPNERR_BUFFERTOOSMALL	The supplied buffer is not large enough to contain the requested data.
DPNERR_INVALIDOBJECT	The Microsoft® DirectPlay® object pointer is invalid.
DPNERR_INVALIDFLAGS	The flags passed to this method are invalid.