Edit

Share via

IMcastAddressAllocation::RequestAddress method (mdhcp.h)

  • Article

[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 RequestAddress method obtains a new lease for one or more multicast addresses. The EnumerateScopes or get_Scopes method must be called first.

Syntax

HRESULT RequestAddress(
  [in]  IMcastScope     *pScope,
  [in]  DATE            LeaseStartTime,
  [in]  DATE            LeaseStopTime,
  [in]  long            NumAddresses,
  [out] IMcastLeaseInfo **ppLeaseResponse
);

Parameters

[in] pScope

Identifies the multicast scope from which the application needs an address. The application first calls get_Scopes or EnumerateScopes to obtain a list of available scopes.

[in] LeaseStartTime

Requested time for the lease on these addresses to start. The start time that is actually granted may be different.

[in] LeaseStopTime

Requested time for the lease on these addresses to stop. The stop time that is actually granted may be different.

[in] NumAddresses

The number of addresses requested. Fewer addresses may actually be granted.

[out] ppLeaseResponse

Pointer to an interface pointer that will be set to point to a new IMcastLeaseInfo object. This interface can then be used to discover the actual attributes of the granted lease. See IMcastScope for more information.

Return value

This method can return one of these values.

Value Meaning
S_OK
 Method succeeded.
E_POINTER
 The caller passed in an invalid pointer argument.
E_OUTOFMEMORY
 Not enough memory exists to create the required objects.
E_INVALIDARG
 Requested stop time is prior to requested stop time.

Remarks

Although these COM interfaces and their implementation support allocation of multiple addresses at a time, multiple allocation is not currently supported by the underlying function calls. You may need to use a loop for multiple address allocation.

TAPI calls the AddRef method on the IMcastLeaseInfo interface returned by IMcastAddressAllocation::RequestAddress. The application must call Release on the IMcastLeaseInfo interface to free resources associated with it.

Requirements

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

See also

IMcastAddressAllocation