IRTCSessionStateChangeEvent2::GetRemoteSessionDescription

  • Article

This method retrieves the session description from the remote client. This method is used for sessions of type RTCST_APPLICATION only. A call to this method for any other type of session will fail.

HRESULT GetRemoteSessionDescription(
  BSTR* pbstrContentType,
  BSTR* pbstrSessionDescription
);

Parameters

  • pbstrContentType
    [out] Pointer to a BSTR that will be filled with the content type for the session description, or an empty string if there is no entry. The method allocates the buffer. The caller is responsible for releasing this memory with SysFreeString.
  • pbstrSessionDescription
    [out] Pointer to a BSTR that will be filled with the session description, or an empty string if there is no entry. The method allocates the buffer. The caller is responsible for releasing this memory with SysFreeString.

Return Values

This method can return an RTC_E_ constant.

Remarks

This method is called for sessions in the RTCSS_CONNECTED or RTCSS_INCOMING state only. The application calls this method on sessions in the RTCSS_INCOMING state to get the remote session description before it answers the session with the IRTCSession2::AnswerWithSessionDescription method.

For incoming calls, this method should be called on the session in the RTCSS_INCOMING state before the session is answered.

Note   The content type is application-specific. Applications should ensure that the called party is able to decipher the content type of the session description.

Requirements

OS Versions: Windows CE .NET 4.2 and later.
Header: Rtccore.h, Rtccore.idl.
Link Library: Uuid.lib.

See Also

IRTCClient2::CreateSessionWithDescription | IRTCSession2::AnswerWithSessionDescription | IRTCSessionStateChangeEvent2 | SysFreeString

 Last updated on Saturday, April 10, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.