Platform SDK: TAPI

IMcastLeaseInfo::get_RequestID

The get_RequestID method obtains the request ID for a lease. The primary purpose of this method is to allow you to save the request ID after your application exits, so that you can call IMcastAddressAllocation::CreateLeaseInfo to re-create the lease information object during a subsequent run. This allows you to renew or release a lease after the instance of your program that originally requested the lease has exited.

HRESULT get_RequestID(
  BSTR *ppRequestID
);

Parameters

ppRequestID: [out] Pointer to a BSTR that will receive the request ID for this lease. The request ID uniquely identifies this lease request to the server.

Return Values

Value	Meaning
S_OK	Method succeeded.
S_FAIL	The lease information object contains an invalid request ID.
E_POINTER	The caller passed in an invalid pointer argument.
E_OUTOFMEMORY	Not enough memory to allocate the BSTR.

Remarks

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

Requirements

  Windows NT/2000: Requires Windows 2000.
  Version: Requires TAPI 3.0 or later.
  Header: Declared in Mdhcp.h.
  Library: Use Mdhcpid.lib.

IMcastLeaseInfo::get_RequestID

Parameters

Return Values

Remarks

Requirements

See Also