IMsgrSession::LocalAddress Property

  • Article

Deprecated. Sets or retrieves the Internet Protocol (IP) address of the session.

Syntax

HRESULT IMsgrSession::get_LocalAddress(BSTR *pbstrLocalAddress);
HRESULT IMsgrSession::put_LocalAddress(BSTR bstrLocalAddress);

Parameters

  • pbstrLocalAddress
    Pointer to a variable of type BSTR that receives the local IP address of the session.
  • bstrLocalAddress
    BSTR that specifies the local IP address of the session. This address can be no longer than 30 characters.

Return Value

Returns S_OK if successful, or an error value otherwise.

Remarks

Setting this property does not change the physical IP address of the computer. Instead, it modifies a data member within the MsgrSession object.

The following table lists the error codes returned by this property.

Error Code Meaning
E_INVALIDARG The parameter passed to the property was not valid.
E_OUTOFMEMORY The local address is too long.

Important  IMsgrSession::LocalAddress is no longer available in Windows Vista. See Windows Messenger for more information.

See Also

MsgrSession, Messenger Session Invite and Messenger Private APIs, Messenger Lock and Key API