ITMedia::get_MediaTitle 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_MediaTitle method retrieves a textual title for the media that the application can use for informational or display purposes. This must be an ASCII convertible string if the character set is ASCII. Otherwise, it can be any BSTR string.

Syntax

HRESULT get_MediaTitle(
  [out] BSTR *ppMediaTitle
);

Parameters

ppMediaTitle [out]

Pointer to a BSTR containing the title of the media.

Return value

This method can return one of these values.

Return code Description
S_OK
Method succeeded.
E_POINTER
The ppMediaTitle 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 memory allocated for the ppMediaTitle parameter.

Requirements

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

See also

ITMedia

ITMedia::Put_MediaTitle