IRTCReInviteEvent::GetRemoteSessionDescription

The method retrieves the session description from the remote client.

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

Parameters

  • pbstrContentType
    [out] Pointer to a BSTR containing the content type for the session description. The caller is responsible for freeing this memory with SysFreeString.
  • pbstrDescription
    [out] Pointer to a BSTR containing the session description. The caller is responsible for freeing this memory with SysFreeString.

Return Values

RTC methods may return an RTC_E_ constant.

Value Meaning
E_INVALIDARG The pbstrContentType or pbstrDescription parameter is NULL.
RTC_E_MEDIA_ENABLED The media is enabled.
RTC_E_INVALID_SESSION_STATE The session is not in the connected or incoming state.
RTC_E_PLATFORM_NOT_SUPPORTED The platform must be Windows 2000 or above.

Remarks

This method is used for sessions of type RTCST_APPLICATION only. A call to this method for any other type of session will fail. This method should be called when the Reinvite event state is RTCIN_INCOMING. The session description retrieved from this method was created by the remote client using the IRTCSession2::ReInviteWithSessionDescription method. The application calls this method before answering the incoming Reinvite with the IRTCReInviteEvent::Accept method.

Requirements

Redistributable: Requires Rtcdll.dll on Windows 2000, Windows XP, and Windows Server 2003.
Header: Declared in Rtccore.h.
Library: Included as a resource in Rtcdll.dll.
GUID: IID_IRTCReInviteEvent is defined as 11558D84-204C-43e7-99B0-2034E9417F7D.

See Also

IRTCReInviteEvent, Session Negotiation