Platform SDK: TAPI

IMcastScope::get_ScopeDescription

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.

HRESULT get_ScopeDescription(
  BSTR *ppDescription
);

Parameters

ppDescription
[out] 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 Values

Value Meaning
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

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

See Also

IMcastScope