Share via

IRTCProfile2::AllowedAuth (Windows Embedded CE 6.0)

  • Article

1/6/2010

Thismethod sets or gets the allowed authentication methods for the profile. When the server issues a challenge to a request from the client (using this profile), the values returned by this method specify the authentication protocols that are allowed for a response to that challenge.

Syntax

HRESULT put_AllowedAuth(
  long lAllowedAuth
);
HRESULT get_AllowedAuth(
  long* plAllowedAuth
);

Parameters

  • lAllowedAuth, plAllowedAuth
    [in, out] The permitted authentication value. The value can be any combination of the RTCAU_ constants.

Return Value

RTC methods can return an RTC_E_ constant. The following table shows additional return values and additional information about specific return values.

Value Meaning

E_POINTER

The plAllowedAuth parameter is not a valid pointer.

E_INVALIDARG

The lAllowedAuth parameter is not in the valid range, or the flags contain the RTCAU_USE_LOGON_CRED flag and none of the Authentication methods is enabled.

RTC_E_UDP_NOT_SUPPORTED

The authentication specified in the lAllowedAuth parameter contains either NTLM, Kerberos, or USE_LOGON_CRED, which are not supported if any of the servers in the profile has specified the UDP transport.

RTC_E_INVALID_REGISTRATION_STATE

The profile is registered such that the allowed authentication schemes cannot be changed. The profile must not be in one of the following three states: RTCRS_REGISTERED, RTCRS_UNREGISTERING, or RTCRS_REGISTERING.

RTC_E_BASIC_AUTH_SET_TLS

The transport must be set to TLS if basic authentication is allowed.

Remarks

The following list provides the transport types that are allowed for each of the supported authentication methods:

  • Basic — Requires the TLS transport. This authentication method will be rejected if TLS is not specified in the profile.
  • Digest — Supported over the TCP, TLS, or UDP transport.
  • Kerberos — Supported over the TCP or TLS transport. This authentication method is rejected if UDP is specified as the transport in the profile.
  • NTLM — Supported over the TCP or TLS transport. This authentication method is rejected if UDP is specified as the transport in the profile.
  • USE_LOGON_CRED — Supported over the TCP or TLS transport. This authentication method is rejected if UDP is specified as the transport in the profile. This authentication method requires that at least one of the other authentication methods be present in the profile; otherwise, E_INVALIDARG is returned.

When setting the authentication methods:

  • If an authentication method is not specified in the plAllowedAuth flag, the RTC Client API does not use that method.
  • If the server does not challenge the client, the plAllowedAuth flag has no effect.

Requirements

Header rtccore.h, rtccore.idl
Library uuid.lib
Windows Embedded CE Windows CE .NET 4.2 and later

See Also

Reference

IRTCProfile2