IRTCSession2::IsSecurityEnabled

The IsSecurityEnabled method returns whether a specified security type has been enabled for the session.

HRESULT IsSecurityEnabled(RTC_SECURITY_TYPEenSecurityType,
VARIANT_BOOL*pfSecurityEnabled);

Parameters

  • enSecurityType
    [in] An RTC_SECURITY_TYPE enumeration containing the security type.
  • pfSecurityEnabled
    [out] Pointer to a VARIANT_BOOL specifying whether the security type is enabled.

Return Values

RTC methods may return an RTC_E_ constant.

Value Meaning
RTC_E_INVALID_SESSION_TYPE The session is not in the connected state.
E_POINTER The pfSecurityEnabled parameter is not a valid pointer.

Remarks

The application can use the IsSecurityEnabled method to query the session for the supported security levels for each security type in the session. This method returns TRUE, FALSE, or Undefined, based on the security level for the session. Undefined is returned when the security type specified is not part of the session.

The security levels are set as a result of negotiations between the participants in the session. This method can be called only from the RTCSS_CONNECTED session state.

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_IRTCSession2 is defined as 17D7CDFC-B007-484c-99D2-86A8A820991D.

See Also

IRTCSession2, RTC_SECURITY_TYPE, Security, Set the Security Level for the Client Object