BluetoothAuthenticateDevice 関数 (bluetoothapis.h)

[アーティクル]
02/26/2024

BluetoothAuthenticateDevice 関数は、リモート Bluetooth デバイスに認証要求を送信します。

メモ Windows Vista SP2 および Windows 7 用に開発する場合は、 BluetoothAuthenticateDeviceEx を使用することをお勧めします。

構文

DWORD BluetoothAuthenticateDevice(
  HWND                  hwndParent,
  HANDLE                hRadio,
  BLUETOOTH_DEVICE_INFO *pbtbi,
  PWSTR                 pszPasskey,
  ULONG                 ulPasskeyLength
);

パラメーター

hwndParent

認証ウィザードの親となるウィンドウ。 NULL に設定すると、ウィザードはデスクトップから削除されます。

hRadio

有効なローカル無線ハンドル、または NULL。 NULL の場合、すべてのローカル無線で認証が試行されます。無線が成功した場合、関数呼び出しは成功します。

pbtbi

認証する Bluetooth デバイスのレコードを含む BLUETOOTH_DEVICE_INFO 型の構造体。

pszPasskey

デバイス認証に使用する個人識別番号 (PIN)。 NULL に設定されている場合、ユーザーインターフェイスが表示され、ユーザーはユーザーインターフェイスで提供される認証プロセスに従う必要があります。 pszPasskey が NULL でない場合、ユーザーインターフェイスは表示されません。パスキーが NULL でない場合は、 NULL で終わる文字列である必要があります。詳細については、「解説」を参照してください。

ulPasskeyLength

pszPasskey のサイズ (文字単位)。 pszPasskey のサイズは、BLUETOOTH_MAX_PASSKEY_SIZE以下である必要があります。

戻り値

正常に完了 したときにERROR_SUCCESS を返します。

一般的なエラーを次の表に示します。

リターンコード	説明
ERROR_CANCELLED	ユーザーが操作を取り消しました。
ERROR_INVALID_PARAMETER	pbtdi パラメーターのデバイス構造が無効です。
ERROR_NO_MORE_ITEMS	pbtdi が指すデバイスは、既に認証済みとしてマークされています。

注釈

一部のリモート Bluetooth デバイスでは、数値のパスキーのみを受け取ることができます。事前に数値パスキーのみを受け入れるデバイスを識別する方法はありません。

Bluetooth 認証プロセスには、ウィザードモードと透過モードの 2 つのモードがあります。

pszPasskey が NULL に設定され、Bluetooth 接続ウィザードが開始されると、ウィザードモードが開始されます。ユーザーは、ウィザードの手順としてパスキーを入力するように求められます。その後、認証要求が送信されます。ユーザーインターフェイスは、認証の試行が成功したか失敗したかを表示し、失敗した認証を再試行する機会をユーザーに提供します。

トランスペアレントモードは、 pszPasskey が NULL でない場合に開始されます。 Transparent モードでは、認証要求は、ユーザーインターフェイスを表示せずにリモート Bluetooth デバイスに送信されます。 Transparent モードでは、Bluetooth 状態コードは Win32 エラーコードにマップされます。次の表に、このマッピング情報を示します。

Bluetooth 状態コード	Win32 エラーコード
BTH_ERROR_SUCCESS	ERROR_SUCCESS
BTH_ERROR_NO_CONNECTION	ERROR_DEVICE_NOT_CONNECTED
BTH_ERROR_PAGE_TIMEOUT	WAIT_TIMEOUT
BTH_ERROR_HARDWARE_FAILURE	ERROR_GEN_FAILURE
BTH_ERROR_AUTHENTICATION_FAILURE	ERROR_NOT_AUTHENTICATED
BTH_ERROR_MEMORY_FULL	ERROR_NOT_ENOUGH_MEMORY
BTH_ERROR_CONNECTION_TIMEOUT	WAIT_TIMEOUT
BTH_ERROR_LMP_RESPONSE_TIMEOUT	WAIT_TIMEOUT
BTH_ERROR_MAX_NUMBER_OF_CONNECTIONS	ERROR_REQ_NOT_ACCEP
BTH_ERROR_PAIRING_NOT_ALLOWED	ERROR_ACCESS_DENIED
BTH_ERROR_UNSPECIFIED_ERROR	ERROR_NOT_READY
BTH_ERROR_LOCAL_HOST_TERMINATED_CONNECTION	ERROR_VC_DISCONNECTED

要件

要件	値
サポートされている最小のクライアント	Windows Vista、SP2 を使用した Windows XP [デスクトップアプリのみ]
サポートされている最小のサーバー	サポートなし
対象プラットフォーム	Windows
ヘッダー	bluetoothapis.h (Bthsdpdef.h、BluetoothAPIs.h を含む)
Library	Bthprops.lib
[DLL]	bthprops.cpl