BthReadAuthenticationEnable
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 function reads 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_GET_AUTHN_ENABLE as the optname value in getsockopt.
Syntax
int BthReadAuthenticationEnable(
unsigned char* pae
);
Parameters
pae
[in] Pointer to the value that indicates 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 Value
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.
For more information about this function, see the Read_Authentication_Enable part of the Bluetooth Core Specification.
Requirements
| Header | bt_api.h |
| Library | Btdrt.lib |
| Windows Embedded CE | Windows CE .NET 4.2 and later |