ITSdp::get_Description method

[ 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_Description method gets the session description (BSTR). This has to be an ASCII convertible string if the character set is ASCII. (Otherwise, it can be any BSTR string.)

Syntax

HRESULT get_Description(
  [out] BSTR *ppDescription
);

Parameters

ppDescription [out]

Pointer to a BSTR containing the session description.

Return value

This method can return one of these values.

Return code Description
S_OK
Method succeeded.
E_POINTER
The ppDescription parameter is not a valid pointer.
E_OUTOFMEMORY
Insufficient memory exists to perform the operation.
E_FAIL
Unspecified error.
E_NOTIMPL
This method is not yet implemented.

Remarks

The application must use SysFreeString to free the ppDescription parameter.

Requirements

Requirement Value
TAPI version
Requires TAPI 3.0 or later
Header
Sdpblb.h
Library
Uuid.lib
DLL
Sdpblb.dll

See also

ITSdp

ITSdp::put_Description