IRTCSession::Terminate
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 terminates a session. The method can be called on a session that is in any state except RTCSS_DISCONNECTED.
Syntax
HRESULT Terminate(
RTC_TERMINATE_REASON enReason
);
Parameters
- enReason
[in] An RTC_TERMINATE_REASON enumeration value specifying the reason for session termination.
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 | Description |
|---|---|
E_INVALIDARG |
Invalid terminate reason. |
RTC_E_INVALID_SESSION_STATE |
An idle session cannot be terminated. In addition, the enReason parameter must be either RTCTR_NORMAL or RTCTR_SHUTDOWN if the session is not in the RTCSS_INCOMING state. If the enReason parameter contains any other value and the session is not in the incoming state, this error is returned. |
Remarks
This method does the following:
- Disconnects an RTCSS_CONNECTED session
- Rejects an RTCSS_INCOMING session
- Withdraws an RTCSS_INPROGRESS or RTCSS_ANSWERING session
.gif "Aa923496.security(en-us,MSDN.10).gif") Security Note: |
|---|
| This method can send data over the network in unencrypted form. Therefore, someone eavesdropping on the network might be able to read the data. Before using this method in an unencrypted session, consider the security risk of sending the data in clear text. The application can encrypt an RTC session by specifying TLS in the profile used for the session. |
Requirements
| Header | rtccore.h, rtccore.idl |
| Library | uuid.lib |
| Windows Embedded CE | Windows CE .NET 4.0 and later |