IMcastLeaseInfo::get_ServerAddress method (mdhcp.h)

[Rendezvous IP Telephony Conferencing controls and interfaces are not available for use in Windows Vista, Windows Server 2008, and subsequent versions of the operating system. The RTC Client API provides similar functionality.]

The get_ServerAddress method obtains a string representing the address of the multicast server granting this lease.

Syntax

HRESULT get_ServerAddress(
  [out] BSTR *ppAddress
);

Parameters

[out] ppAddress

Pointer to a BSTR that will receive a string representation of the address of the server granting this request or renewal.

Return value

This method can return one of these values.

Return code Description
S_OK
Method succeeded.
S_FALSE
Server address unspecified.
E_POINTER
The caller passed in an invalid pointer argument.
E_OUTOFMEMORY
Not enough memory exists to allocate the string.

Remarks

The BSTR string ppAddress is an IP version 4 address in dotted quad notation (for example, 10.111.222.111). If a lease information object does not describe a granted lease (for example, it was not returned by IMcastAddressAllocation::RequestAddress or IMcastAddressAllocation::RenewAddress), the address is reported as the string "Unspecified".

The application must use SysFreeString to free the memory allocated for the ppAddress parameter.

This function may send data over the wire in unencrypted form; therefore, someone eavesdropping on the network may be able to read the data. The security risk of sending the data in clear text should be considered before using this method.

Requirements

Requirement Value
Target Platform Windows
Header mdhcp.h
Library Uuid.lib
DLL Mdhcp.dll

See also

IMcastLeaseInfo