Share via

BthWriteAuthenticationEnable

  • Article

This function sets the value for the authentication setting.

Note   To preserve Win32 compatibility, consider using the Winsock equivalent of this function. To do so, pass SO_BTH_SET_AUTHN_ENABLE as the optname value in setsockopt.

int BthWriteAuthenticationEnable(
  unsigned char ae
);

Parameters

  • ae
    [in] Specifies whether authentication is enabled or disabled:
    • A value of 0x00 indicates that authentication is disabled.
    • A value of 0x01 indicates that authentication is enabled for all connections.

Return Values

This function returns ERROR_SUCCESS when it completes successfully. A return value of ERROR_SERVICE_NOT_ACTIVE indicates that the hardware is not inserted or that the Bluetooth stack is not present.

Other standard error codes may be returned as appropriate.

Remarks

The authentication setting controls whether the local device is required to authenticate at the remote device when setting up the connection. The authentication occurs between the request for, or acceptance of, a connection and the completion of connection setup.

Authentication setting is not persistent. It reverts to the default setting when the adapter is reinitialized, for example, when it is reinserted or the device is powered down.

For more information about this function, see the Write_Authentication_Enable part of the Bluetooth Core Specification.

Requirements

OS Versions: Windows CE .NET 4.2 and later.
Header: Bt_api.h.
Link Library: Btdrt.lib.

See Also

Bluetooth Platform Development Functions | Bluetooth

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.