ITMedia::put_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 put_MediaTitle method sets 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 put_MediaTitle(
  [in] BSTR pMediaTitle
);

Parameters

pMediaTitle [in]

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 pMediaTitle parameter is not a valid pointer.
E_INVALIDARG
The pMediaTitle parameter is not valid.
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 SysAllocString to allocate memory for the pMediaTitle parameter and use SysFreeString to free the memory when the variable is no longer needed.

This function may send data over the wire in unencrypted form; therefore, someone eavesdropping on the network may be able to read the data. The security risk of sending the data in clear text should be considered before using this method.

Requirements

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

See also

ITMedia

ITMedia::get_MediaTitle