IRTCSessionStateChangeEvent2::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.
Syntax
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.The method allocates 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 allocates 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 a specific return value.
| Value | Meaning |
|---|---|
E_INVALIDARG |
The pbstrContentType or pbstrDescription parameter is NULL. |
RTC_E_INVALID_SESSION_STATE |
The session is not in the connected or incoming state. |
Remarks
This method is used for sessions that have their media disabled.
The application calls this method to get the remote session description before it answers the session with the IRTCSession2::AnswerWithSessionDescription method.
The session description retrieved from this method might have been set by the remote client by means of the IRTCClient2::CreateSessionWithDescription method.
If this method is called on a session in the IRTCSS_CONNECTED state, the application retrieves the session description that was set by the remote client by calling the AnswerWithSessionDescription method.
Requirements
| Header | rtccore.h, rtccore.idl |
| Library | uuid.lib |
| Windows Embedded CE | Windows CE .NET 4.2 and later |
See Also
Reference
IRTCSessionStateChangeEvent2
IRTCClient2::CreateSessionWithDescription
IRTCSession2::AnswerWithSessionDescription