IDirectPlay8Peer::GetConnectionInfo Method

DirectPlay

 
Microsoft DirectX 9.0 SDK Update (Summer 2003)

IDirectPlay8Peer::GetConnectionInfo Method


Retrieves statistical information about the connection between the local application and the specified remote player.

Syntax

HRESULT GetConnectionInfo(      
    const DPNID dpnidEndPoint,     DPN_CONNECTION_INFO *const pdnConnectInfo,     const DWORD dwFlags );

Parameters

dpnidEndPoint
[in] The DPNID of the remote player whose connection information will be retrieved.
pdnConnectInfo
[out] Pointer to a DPN_CONNECTION_INFO structure to retrieve information about the specified connection. The dwSize member of this structure must be set to the size of a DPN_CONNECTION_INFO structure.
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.
DPNERR_INVALIDPLAYERThe player ID is not recognized as a valid player ID for this game session.

Remarks

This method can be called only after a successful IDirectPlay8Peer::Host or IDirectPlay8Peer::Connect call has completed.



© 2003 Microsoft Corporation. All rights reserved.