ホーム › Devices.Bluetooth › BluetoothEnableDiscovery

BluetoothEnableDiscovery

関数

ローカルラジオの検出可能状態を有効または無効にする。

DLLBluetoothApis.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// BluetoothApis.dll
#include <windows.h>

BOOL BluetoothEnableDiscovery(
    HANDLE hRadio,   // optional
    BOOL fEnabled
);

パラメーター

名前	型	方向	説明
hRadio	HANDLE	inoptional	有効なローカルラジオのハンドル、または NULL。NULL の場合、すべてのローカルラジオの検出可能状態が変更されます。呼び出しによっていずれかのラジオが変更された場合、この関数呼び出しは成功します。
fEnabled	BOOL	in	検出を有効にするか無効にするかを指定するフラグ。検出を有効にするには TRUE、無効にするには FALSE を設定します。

戻り値の型: BOOL

公式ドキュメント

BluetoothEnableDiscovery 関数は、ローカルの Bluetooth ラジオ (1 台または複数) の検出可能状態を変更します。

戻り値

検出可能状態が正常に変更された場合は TRUE を返します。hRadio が NULL の場合、戻り値 TRUE は少なくとも 1 台のローカルラジオの状態が正常に変更されたことを示します。検出可能状態が変更されなかった場合は FALSE を返します。hRadio が NULL であった場合は、どのラジオも状態の変更を受け入れなかったことを意味します。

解説(Remarks)

Bluetooth ラジオの現在の状態を確認するには、BluetoothIsDiscoverable 関数を使用します。 Windows は、検出可能なシステムが接続可能であることを保証します。そのため、ラジオを検出可能にする前に、そのラジオが着信接続を許可している必要があります。着信接続を許可していない場合、BluetoothEnableDiscovery 関数の呼び出しは失敗します。

BluetoothEnableDiscovery が検出可能状態を変更した場合、新しい状態は呼び出し元アプリケーションの存続期間中有効です。また、この関数で検出可能にした Bluetooth ラジオが、アプリケーションによって無効化された後に再度有効化された場合、検出可能な状態は維持されません。呼び出し元アプリケーションが終了すると、指定した Bluetooth ラジオの検出可能状態は、BluetoothEnableDiscovery が呼び出される前の状態に戻ります。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// BluetoothApis.dll
#include <windows.h>

BOOL BluetoothEnableDiscovery(
    HANDLE hRadio,   // optional
    BOOL fEnabled
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("BluetoothApis.dll", ExactSpelling = true)]
static extern bool BluetoothEnableDiscovery(
    IntPtr hRadio,   // HANDLE optional
    bool fEnabled   // BOOL
);

<DllImport("BluetoothApis.dll", ExactSpelling:=True)>
Public Shared Function BluetoothEnableDiscovery(
    hRadio As IntPtr,   ' HANDLE optional
    fEnabled As Boolean   ' BOOL
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hRadio : HANDLE optional
' fEnabled : BOOL
Declare PtrSafe Function BluetoothEnableDiscovery Lib "bluetoothapis" ( _
    ByVal hRadio As LongPtr, _
    ByVal fEnabled As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

BluetoothEnableDiscovery = ctypes.windll.bluetoothapis.BluetoothEnableDiscovery
BluetoothEnableDiscovery.restype = wintypes.BOOL
BluetoothEnableDiscovery.argtypes = [
    wintypes.HANDLE,  # hRadio : HANDLE optional
    wintypes.BOOL,  # fEnabled : BOOL
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('BluetoothApis.dll')
BluetoothEnableDiscovery = Fiddle::Function.new(
  lib['BluetoothEnableDiscovery'],
  [
    Fiddle::TYPE_VOIDP,  # hRadio : HANDLE optional
    Fiddle::TYPE_INT,  # fEnabled : BOOL
  ],
  Fiddle::TYPE_INT)

#[link(name = "bluetoothapis")]
extern "system" {
    fn BluetoothEnableDiscovery(
        hRadio: *mut core::ffi::c_void,  // HANDLE optional
        fEnabled: i32  // BOOL
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("BluetoothApis.dll")]
public static extern bool BluetoothEnableDiscovery(IntPtr hRadio, bool fEnabled);
"@
$api = Add-Type -MemberDefinition $sig -Name 'BluetoothApis_BluetoothEnableDiscovery' -Namespace Win32 -PassThru
# $api::BluetoothEnableDiscovery(hRadio, fEnabled)

#uselib "BluetoothApis.dll"
#func global BluetoothEnableDiscovery "BluetoothEnableDiscovery" sptr, sptr
; BluetoothEnableDiscovery hRadio, fEnabled   ; 戻り値は stat
; hRadio : HANDLE optional -> "sptr"
; fEnabled : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

#uselib "BluetoothApis.dll"
#cfunc global BluetoothEnableDiscovery "BluetoothEnableDiscovery" sptr, int
; res = BluetoothEnableDiscovery(hRadio, fEnabled)
; hRadio : HANDLE optional -> "sptr"
; fEnabled : BOOL -> "int"

; BOOL BluetoothEnableDiscovery(HANDLE hRadio, BOOL fEnabled)
#uselib "BluetoothApis.dll"
#cfunc global BluetoothEnableDiscovery "BluetoothEnableDiscovery" intptr, int
; res = BluetoothEnableDiscovery(hRadio, fEnabled)
; hRadio : HANDLE optional -> "intptr"
; fEnabled : BOOL -> "int"

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	bluetoothapis = windows.NewLazySystemDLL("BluetoothApis.dll")
	procBluetoothEnableDiscovery = bluetoothapis.NewProc("BluetoothEnableDiscovery")
)

// hRadio (HANDLE optional), fEnabled (BOOL)
r1, _, err := procBluetoothEnableDiscovery.Call(
	uintptr(hRadio),
	uintptr(fEnabled),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function BluetoothEnableDiscovery(
  hRadio: THandle;   // HANDLE optional
  fEnabled: BOOL   // BOOL
): BOOL; stdcall;
  external 'BluetoothApis.dll' name 'BluetoothEnableDiscovery';

result := DllCall("BluetoothApis\BluetoothEnableDiscovery"
    , "Ptr", hRadio   ; HANDLE optional
    , "Int", fEnabled   ; BOOL
    , "Int")   ; return: BOOL

●BluetoothEnableDiscovery(hRadio, fEnabled) = DLL("BluetoothApis.dll", "bool BluetoothEnableDiscovery(void*, bool)")
# 呼び出し: BluetoothEnableDiscovery(hRadio, fEnabled)
# hRadio : HANDLE optional -> "void*"
# fEnabled : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "bluetoothapis" fn BluetoothEnableDiscovery(
    hRadio: ?*anyopaque, // HANDLE optional
    fEnabled: i32 // BOOL
) callconv(std.os.windows.WINAPI) i32;

proc BluetoothEnableDiscovery(
    hRadio: pointer,  # HANDLE optional
    fEnabled: int32  # BOOL
): int32 {.importc: "BluetoothEnableDiscovery", stdcall, dynlib: "BluetoothApis.dll".}

pragma(lib, "bluetoothapis");
extern(Windows)
int BluetoothEnableDiscovery(
    void* hRadio,   // HANDLE optional
    int fEnabled   // BOOL
);

ccall((:BluetoothEnableDiscovery, "BluetoothApis.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Int32),
      hRadio, fEnabled)
# hRadio : HANDLE optional -> Ptr{Cvoid}
# fEnabled : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
int32_t BluetoothEnableDiscovery(
    void* hRadio,
    int32_t fEnabled);
]]
local bluetoothapis = ffi.load("bluetoothapis")
-- bluetoothapis.BluetoothEnableDiscovery(hRadio, fEnabled)
-- hRadio : HANDLE optional
-- fEnabled : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('BluetoothApis.dll');
const BluetoothEnableDiscovery = lib.func('__stdcall', 'BluetoothEnableDiscovery', 'int32_t', ['void *', 'int32_t']);
// BluetoothEnableDiscovery(hRadio, fEnabled)
// hRadio : HANDLE optional -> 'void *'
// fEnabled : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("BluetoothApis.dll", {
  BluetoothEnableDiscovery: { parameters: ["pointer", "i32"], result: "i32" },
});
// lib.symbols.BluetoothEnableDiscovery(hRadio, fEnabled)
// hRadio : HANDLE optional -> "pointer"
// fEnabled : BOOL -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t BluetoothEnableDiscovery(
    void* hRadio,
    int32_t fEnabled);
C, "BluetoothApis.dll");
// $ffi->BluetoothEnableDiscovery(hRadio, fEnabled);
// hRadio : HANDLE optional
// fEnabled : BOOL
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。

import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Bluetoothapis extends StdCallLibrary {
    Bluetoothapis INSTANCE = Native.load("bluetoothapis", Bluetoothapis.class);
    boolean BluetoothEnableDiscovery(
        Pointer hRadio,   // HANDLE optional
        boolean fEnabled   // BOOL
    );
}

@[Link("bluetoothapis")]
lib LibBluetoothApis
  fun BluetoothEnableDiscovery = BluetoothEnableDiscovery(
    hRadio : Void*,   # HANDLE optional
    fEnabled : Int32   # BOOL
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。

import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef BluetoothEnableDiscoveryNative = Int32 Function(Pointer<Void>, Int32);
typedef BluetoothEnableDiscoveryDart = int Function(Pointer<Void>, int);
final BluetoothEnableDiscovery = DynamicLibrary.open('BluetoothApis.dll')
    .lookupFunction<BluetoothEnableDiscoveryNative, BluetoothEnableDiscoveryDart>('BluetoothEnableDiscovery');
// hRadio : HANDLE optional -> Pointer<Void>
// fEnabled : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function BluetoothEnableDiscovery(
  hRadio: THandle;   // HANDLE optional
  fEnabled: BOOL   // BOOL
): BOOL; stdcall;
  external 'BluetoothApis.dll' name 'BluetoothEnableDiscovery';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "BluetoothEnableDiscovery"
  c_BluetoothEnableDiscovery :: Ptr () -> CInt -> IO CInt
-- hRadio : HANDLE optional -> Ptr ()
-- fEnabled : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let bluetoothenablediscovery =
  foreign "BluetoothEnableDiscovery"
    ((ptr void) @-> int32_t @-> returning int32_t)
(* hRadio : HANDLE optional -> (ptr void) *)
(* fEnabled : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

(cffi:define-foreign-library bluetoothapis (t "BluetoothApis.dll"))
(cffi:use-foreign-library bluetoothapis)

(cffi:defcfun ("BluetoothEnableDiscovery" bluetooth-enable-discovery :convention :stdcall) :int32
  (h-radio :pointer)   ; HANDLE optional
  (f-enabled :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $BluetoothEnableDiscovery = Win32::API::More->new('BluetoothApis',
    'BOOL BluetoothEnableDiscovery(HANDLE hRadio, BOOL fEnabled)');
# my $ret = $BluetoothEnableDiscovery->Call($hRadio, $fEnabled);
# hRadio : HANDLE optional -> HANDLE
# fEnabled : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。