IRTCSessionOperationCompleteEvent2::GetRemoteSessionDescription

  • Article

This method retrieves the session description from the remote client. The application uses the method to retrieve the session description that was set with the IRTCReInviteEvent::Accept method. 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

For incoming calls, the application should call this method on the session in the RTCSS_INCOMING state before the session is answered. The application can then call the IRTCSessionStateChangeEvent interface to set the local session description before answering the call.

For outgoing calls, the application should call this method on a session in the RTCSS_CONNECTED state. as soon as the session is connected.

Note   The content type is application-specific. The application 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

IRTCReInviteEvent::Accept | IRTCSession | IRTCSessionOperationCompleteEvent2 | SysFreeString

 Last updated on Saturday, April 10, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.