Edit

Share via

IMcastScope::get_ScopeDescription 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 get_ScopeDescription method obtains a textual description associated with this scope. The description is used only for clarifying the purpose or meaning of a scope and is not needed for any subsequent calls.

Syntax

HRESULT get_ScopeDescription(
  [out] BSTR *ppDescription
);

Parameters

[out] ppDescription

Pointer to a BSTR that will receive a description of this scope. The description was established when this scope was configured on the multicast server.

Return value

This method can return one of these values.

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

Remarks

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

Requirements

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

See also

IMcastScope