IDirectPlay8AddressIP::BuildFromSockAddr Method

Builds a remote Microsoft® DirectPlay®   Internet Protocol (IP) address from a valid SOCKADDR structure.

Syntax

HRESULT BuildFromSockAddr(      
    const SOCKADDR *const pSockAddr
);

Parameters

pSockAddr

[in] Valid User Datagram Protocol (UDP) address specified in SOCKADDR form.

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_INVALIDPOINTER	Pointer specified as a parameter is invalid.
DPNERR_NOTALLOWED	This function is not allowed on this object.

Remarks

The SOCKADDR structure must specify an IP address. If the address is not in the correct format, DPNERR_INVALIDPARAM is returned.

The result of a successful call is a valid remote address with the following elements.

• DPNA_KEY_PROVIDER = CLSID_DP8SP_TCPIP
• DPNA_KEY_HOSTNAME = specified host name
• DPNA_KEY_PORT = specified port

All addressing information contained in the object before the call is erased.