IRTCReInviteEvent::GetRemoteSessionDescription
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This method retrieves the session description from the remote client. The session description is created by the remote client using the IRTCSession2::ReInviteWithSessionDescription method.
Syntax
HRESULT GetRemoteSessionDescription(
BSTR* pbstrContentType,
BSTR* pbstrSessionDescription
);
Parameters
pbstrContentType
[out] Pointer to a BSTR that is filled with the content type for the session description.The method is responsible for allocating the buffer.
The caller is responsible for releasing this memory with SysFreeString.
pbstrSessionDescription
[out] Pointer to a BSTR that is filled with the session description.The method is responsible for allocating the buffer.
The caller is responsible for releasing this memory with SysFreeString.
Return Value
This method can return an RTC_E_ constant.
The following table shows an additional return value and additional information about specific return values.
| 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. |
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 RTCRIN_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 an incoming REINVITE request with IRTCReInviteEvent::Accept method.
Requirements
| Header | rtccore.h, rtccore.idl |
| Library | uuid.lib |
| Windows Embedded CE | Windows CE .NET 4.2 and later |
See Also
Reference
IRTCReInviteEvent
IRTCReInviteEvent::Accept
IRTCSession
IRTCSession2::ReInviteWithSessionDescription
RTC_REINVITE_STATE