IRTCSession2::IsSecurityEnabled
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 returns whether a specified security type has been enabled for the session. This method can be called only from the RTCSS_CONNECTED session state.
Syntax
HRESULT IsSecurityEnabled(
RTC_SECURITY_TYPE enSecurityType,
VARIANT_BOOL* pfSecurityEnabled
);
Parameters
- enSecurityType
[in] An RTC_SECURITY_TYPE enumeration value specifying the security type.
pfSecurityEnabled
[out] Pointer to VARIANT_TRUE if the security type is enabled, and to VARIANT_FALSE if the security type is not enabled.An undefined value is retrieved when the media type specified is not part of the session.
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_POINTER |
The pfSecurityEnabled parameter is not valid. |
RTC_E_INVALID_SESSION_TYPE |
The session is not in the connected state. |
Remarks
The application can use this method to query the session for the supported security level for each security type in the session.
The security levels are set as a result of negotiations between the participants in the session.
Requirements
| Header | rtccore.h, rtccore.idl |
| Library | uuid.lib |
| Windows Embedded CE | Windows CE .NET 4.2 and later |