Microsoft DirectX 9.0 SDK Update (Summer 2003) |
IDirectPlay8Server::GetClientAddress Method
Retrieves the address for the specified player in the session.
Syntax
HRESULT GetClientAddress(
const DPNID dpnid, IDirectPlay8Address **const pAddress, const DWORD dwFlags );
Parameters
- dpnid
- [in] Variable of type DPNID specifying the identification of the player.
- pAddress
- [out] Address of a pointer to an IDirectPlay8Address object that specifies the address of the client. You must release this object when you no longer need it.
- dwFlags
- [in] Reserved. Must be 0.
Return Value
Returns S_OK if successful, or one of the following error values.
DPNERR_INVALIDOBJECT The Microsoft® DirectPlay® object pointer is invalid. DPNERR_INVALIDPARAM One or more of the parameters passed to the method are invalid. DPNERR_INVALIDPLAYER The player ID is not recognized as a valid player ID for this game session. DPNERR_INVALIDPOINTER Pointer specified as a parameter is invalid. DPNERR_UNINITIALIZED The requested object has not been initialized.
Remarks
Use the IDirectPlay8Server::GetLocalHostAddresses method to retrieve addresses that can be used to connect to the session.