Share via

IRTCSession::Terminate

  • Article

This method terminates a session. The method can be called on a session that is in any state except RTCSS_DISCONNECTED.

HRESULT Terminate(
  RTC_TERMINATE_REASON enReason
);

Parameters

  • enReason
    [in] An RTC_TERMINATE_REASON enumeration value specifying the reason for session termination.

Return Values

This method can return an RTC_E_ constant. The following table shows the possible return values.

Value Description
E_INVALIDARG Invalid terminate reason.
RTC_E_INVALID_SESSION_STATE An idle session cannot be terminated.

Remarks

This method will disconnect an RTCSS_CONNECTED session, reject an RTCSS_INCOMING session, and withdraw an RTCSS_INPROGRESS or RTCSS_ANSWERING session.

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

OS Versions: Windows CE .NET 4.0 and later.
Header: Rtccore.h, Rtccore.idl.
Link Library: Uuid.lib.

See Also

IRTCSession::Answer | RTC_TERMINATE_REASON

 Last updated on Saturday, April 10, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.