Win32 API 日本語リファレンス
ホームDevices.Bluetooth › BluetoothGATTGetServices

BluetoothGATTGetServices

関数
BLEデバイスのGATTサービス一覧を取得する。
DLLBluetoothApis.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

HRESULT BluetoothGATTGetServices(
    HANDLE hDevice,
    WORD ServicesBufferCount,
    BTH_LE_GATT_SERVICE* ServicesBuffer,   // optional
    WORD* ServicesBufferActual,
    DWORD Flags
);

パラメーター

名前方向説明
hDeviceHANDLEinGATTサービスを取得する対象BLEデバイスのハンドル。
ServicesBufferCountWORDinServicesBufferが格納できる要素数。サイズ照会時は0。
ServicesBufferBTH_LE_GATT_SERVICE*outoptional取得したGATTサービス情報を受け取る配列ポインタ。サイズ照会時はNULL。
ServicesBufferActualWORD*out実際のサービス数を受け取る出力ポインタ。
FlagsDWORDin取得動作を制御するフラグ。BLUETOOTH_GATT_FLAG_NONE等。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT BluetoothGATTGetServices(
    HANDLE hDevice,
    WORD ServicesBufferCount,
    BTH_LE_GATT_SERVICE* ServicesBuffer,   // optional
    WORD* ServicesBufferActual,
    DWORD Flags
);
[DllImport("BluetoothApis.dll", ExactSpelling = true)]
static extern int BluetoothGATTGetServices(
    IntPtr hDevice,   // HANDLE
    ushort ServicesBufferCount,   // WORD
    IntPtr ServicesBuffer,   // BTH_LE_GATT_SERVICE* optional, out
    out ushort ServicesBufferActual,   // WORD* out
    uint Flags   // DWORD
);
<DllImport("BluetoothApis.dll", ExactSpelling:=True)>
Public Shared Function BluetoothGATTGetServices(
    hDevice As IntPtr,   ' HANDLE
    ServicesBufferCount As UShort,   ' WORD
    ServicesBuffer As IntPtr,   ' BTH_LE_GATT_SERVICE* optional, out
    <Out> ByRef ServicesBufferActual As UShort,   ' WORD* out
    Flags As UInteger   ' DWORD
) As Integer
End Function
' hDevice : HANDLE
' ServicesBufferCount : WORD
' ServicesBuffer : BTH_LE_GATT_SERVICE* optional, out
' ServicesBufferActual : WORD* out
' Flags : DWORD
Declare PtrSafe Function BluetoothGATTGetServices Lib "bluetoothapis" ( _
    ByVal hDevice As LongPtr, _
    ByVal ServicesBufferCount As Integer, _
    ByVal ServicesBuffer As LongPtr, _
    ByRef ServicesBufferActual As Integer, _
    ByVal Flags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

BluetoothGATTGetServices = ctypes.windll.bluetoothapis.BluetoothGATTGetServices
BluetoothGATTGetServices.restype = ctypes.c_int
BluetoothGATTGetServices.argtypes = [
    wintypes.HANDLE,  # hDevice : HANDLE
    ctypes.c_ushort,  # ServicesBufferCount : WORD
    ctypes.c_void_p,  # ServicesBuffer : BTH_LE_GATT_SERVICE* optional, out
    ctypes.POINTER(ctypes.c_ushort),  # ServicesBufferActual : WORD* out
    wintypes.DWORD,  # Flags : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('BluetoothApis.dll')
BluetoothGATTGetServices = Fiddle::Function.new(
  lib['BluetoothGATTGetServices'],
  [
    Fiddle::TYPE_VOIDP,  # hDevice : HANDLE
    -Fiddle::TYPE_SHORT,  # ServicesBufferCount : WORD
    Fiddle::TYPE_VOIDP,  # ServicesBuffer : BTH_LE_GATT_SERVICE* optional, out
    Fiddle::TYPE_VOIDP,  # ServicesBufferActual : WORD* out
    -Fiddle::TYPE_INT,  # Flags : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "bluetoothapis")]
extern "system" {
    fn BluetoothGATTGetServices(
        hDevice: *mut core::ffi::c_void,  // HANDLE
        ServicesBufferCount: u16,  // WORD
        ServicesBuffer: *mut BTH_LE_GATT_SERVICE,  // BTH_LE_GATT_SERVICE* optional, out
        ServicesBufferActual: *mut u16,  // WORD* out
        Flags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("BluetoothApis.dll")]
public static extern int BluetoothGATTGetServices(IntPtr hDevice, ushort ServicesBufferCount, IntPtr ServicesBuffer, out ushort ServicesBufferActual, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'BluetoothApis_BluetoothGATTGetServices' -Namespace Win32 -PassThru
# $api::BluetoothGATTGetServices(hDevice, ServicesBufferCount, ServicesBuffer, ServicesBufferActual, Flags)
#uselib "BluetoothApis.dll"
#func global BluetoothGATTGetServices "BluetoothGATTGetServices" sptr, sptr, sptr, sptr, sptr
; BluetoothGATTGetServices hDevice, ServicesBufferCount, varptr(ServicesBuffer), varptr(ServicesBufferActual), Flags   ; 戻り値は stat
; hDevice : HANDLE -> "sptr"
; ServicesBufferCount : WORD -> "sptr"
; ServicesBuffer : BTH_LE_GATT_SERVICE* optional, out -> "sptr"
; ServicesBufferActual : WORD* out -> "sptr"
; Flags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "BluetoothApis.dll"
#cfunc global BluetoothGATTGetServices "BluetoothGATTGetServices" sptr, int, var, var, int
; res = BluetoothGATTGetServices(hDevice, ServicesBufferCount, ServicesBuffer, ServicesBufferActual, Flags)
; hDevice : HANDLE -> "sptr"
; ServicesBufferCount : WORD -> "int"
; ServicesBuffer : BTH_LE_GATT_SERVICE* optional, out -> "var"
; ServicesBufferActual : WORD* out -> "var"
; Flags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT BluetoothGATTGetServices(HANDLE hDevice, WORD ServicesBufferCount, BTH_LE_GATT_SERVICE* ServicesBuffer, WORD* ServicesBufferActual, DWORD Flags)
#uselib "BluetoothApis.dll"
#cfunc global BluetoothGATTGetServices "BluetoothGATTGetServices" intptr, int, var, var, int
; res = BluetoothGATTGetServices(hDevice, ServicesBufferCount, ServicesBuffer, ServicesBufferActual, Flags)
; hDevice : HANDLE -> "intptr"
; ServicesBufferCount : WORD -> "int"
; ServicesBuffer : BTH_LE_GATT_SERVICE* optional, out -> "var"
; ServicesBufferActual : WORD* out -> "var"
; Flags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	bluetoothapis = windows.NewLazySystemDLL("BluetoothApis.dll")
	procBluetoothGATTGetServices = bluetoothapis.NewProc("BluetoothGATTGetServices")
)

// hDevice (HANDLE), ServicesBufferCount (WORD), ServicesBuffer (BTH_LE_GATT_SERVICE* optional, out), ServicesBufferActual (WORD* out), Flags (DWORD)
r1, _, err := procBluetoothGATTGetServices.Call(
	uintptr(hDevice),
	uintptr(ServicesBufferCount),
	uintptr(ServicesBuffer),
	uintptr(ServicesBufferActual),
	uintptr(Flags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function BluetoothGATTGetServices(
  hDevice: THandle;   // HANDLE
  ServicesBufferCount: Word;   // WORD
  ServicesBuffer: Pointer;   // BTH_LE_GATT_SERVICE* optional, out
  ServicesBufferActual: Pointer;   // WORD* out
  Flags: DWORD   // DWORD
): Integer; stdcall;
  external 'BluetoothApis.dll' name 'BluetoothGATTGetServices';
result := DllCall("BluetoothApis\BluetoothGATTGetServices"
    , "Ptr", hDevice   ; HANDLE
    , "UShort", ServicesBufferCount   ; WORD
    , "Ptr", ServicesBuffer   ; BTH_LE_GATT_SERVICE* optional, out
    , "Ptr", ServicesBufferActual   ; WORD* out
    , "UInt", Flags   ; DWORD
    , "Int")   ; return: HRESULT
●BluetoothGATTGetServices(hDevice, ServicesBufferCount, ServicesBuffer, ServicesBufferActual, Flags) = DLL("BluetoothApis.dll", "int BluetoothGATTGetServices(void*, int, void*, void*, dword)")
# 呼び出し: BluetoothGATTGetServices(hDevice, ServicesBufferCount, ServicesBuffer, ServicesBufferActual, Flags)
# hDevice : HANDLE -> "void*"
# ServicesBufferCount : WORD -> "int"
# ServicesBuffer : BTH_LE_GATT_SERVICE* optional, out -> "void*"
# ServicesBufferActual : WORD* out -> "void*"
# Flags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "bluetoothapis" fn BluetoothGATTGetServices(
    hDevice: ?*anyopaque, // HANDLE
    ServicesBufferCount: u16, // WORD
    ServicesBuffer: [*c]BTH_LE_GATT_SERVICE, // BTH_LE_GATT_SERVICE* optional, out
    ServicesBufferActual: [*c]u16, // WORD* out
    Flags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc BluetoothGATTGetServices(
    hDevice: pointer,  # HANDLE
    ServicesBufferCount: uint16,  # WORD
    ServicesBuffer: ptr BTH_LE_GATT_SERVICE,  # BTH_LE_GATT_SERVICE* optional, out
    ServicesBufferActual: ptr uint16,  # WORD* out
    Flags: uint32  # DWORD
): int32 {.importc: "BluetoothGATTGetServices", stdcall, dynlib: "BluetoothApis.dll".}
pragma(lib, "bluetoothapis");
extern(Windows)
int BluetoothGATTGetServices(
    void* hDevice,   // HANDLE
    ushort ServicesBufferCount,   // WORD
    BTH_LE_GATT_SERVICE* ServicesBuffer,   // BTH_LE_GATT_SERVICE* optional, out
    ushort* ServicesBufferActual,   // WORD* out
    uint Flags   // DWORD
);
ccall((:BluetoothGATTGetServices, "BluetoothApis.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt16, Ptr{BTH_LE_GATT_SERVICE}, Ptr{UInt16}, UInt32),
      hDevice, ServicesBufferCount, ServicesBuffer, ServicesBufferActual, Flags)
# hDevice : HANDLE -> Ptr{Cvoid}
# ServicesBufferCount : WORD -> UInt16
# ServicesBuffer : BTH_LE_GATT_SERVICE* optional, out -> Ptr{BTH_LE_GATT_SERVICE}
# ServicesBufferActual : WORD* out -> Ptr{UInt16}
# Flags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t BluetoothGATTGetServices(
    void* hDevice,
    uint16_t ServicesBufferCount,
    void* ServicesBuffer,
    uint16_t* ServicesBufferActual,
    uint32_t Flags);
]]
local bluetoothapis = ffi.load("bluetoothapis")
-- bluetoothapis.BluetoothGATTGetServices(hDevice, ServicesBufferCount, ServicesBuffer, ServicesBufferActual, Flags)
-- hDevice : HANDLE
-- ServicesBufferCount : WORD
-- ServicesBuffer : BTH_LE_GATT_SERVICE* optional, out
-- ServicesBufferActual : WORD* out
-- Flags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('BluetoothApis.dll');
const BluetoothGATTGetServices = lib.func('__stdcall', 'BluetoothGATTGetServices', 'int32_t', ['void *', 'uint16_t', 'void *', 'uint16_t *', 'uint32_t']);
// BluetoothGATTGetServices(hDevice, ServicesBufferCount, ServicesBuffer, ServicesBufferActual, Flags)
// hDevice : HANDLE -> 'void *'
// ServicesBufferCount : WORD -> 'uint16_t'
// ServicesBuffer : BTH_LE_GATT_SERVICE* optional, out -> 'void *'
// ServicesBufferActual : WORD* out -> 'uint16_t *'
// Flags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("BluetoothApis.dll", {
  BluetoothGATTGetServices: { parameters: ["pointer", "u16", "pointer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.BluetoothGATTGetServices(hDevice, ServicesBufferCount, ServicesBuffer, ServicesBufferActual, Flags)
// hDevice : HANDLE -> "pointer"
// ServicesBufferCount : WORD -> "u16"
// ServicesBuffer : BTH_LE_GATT_SERVICE* optional, out -> "pointer"
// ServicesBufferActual : WORD* out -> "pointer"
// Flags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t BluetoothGATTGetServices(
    void* hDevice,
    uint16_t ServicesBufferCount,
    void* ServicesBuffer,
    uint16_t* ServicesBufferActual,
    uint32_t Flags);
C, "BluetoothApis.dll");
// $ffi->BluetoothGATTGetServices(hDevice, ServicesBufferCount, ServicesBuffer, ServicesBufferActual, Flags);
// hDevice : HANDLE
// ServicesBufferCount : WORD
// ServicesBuffer : BTH_LE_GATT_SERVICE* optional, out
// ServicesBufferActual : WORD* out
// Flags : DWORD
// 構造体/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);
    int BluetoothGATTGetServices(
        Pointer hDevice,   // HANDLE
        short ServicesBufferCount,   // WORD
        Pointer ServicesBuffer,   // BTH_LE_GATT_SERVICE* optional, out
        ShortByReference ServicesBufferActual,   // WORD* out
        int Flags   // DWORD
    );
}
@[Link("bluetoothapis")]
lib LibBluetoothApis
  fun BluetoothGATTGetServices = BluetoothGATTGetServices(
    hDevice : Void*,   # HANDLE
    ServicesBufferCount : UInt16,   # WORD
    ServicesBuffer : BTH_LE_GATT_SERVICE*,   # BTH_LE_GATT_SERVICE* optional, out
    ServicesBufferActual : UInt16*,   # WORD* out
    Flags : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef BluetoothGATTGetServicesNative = Int32 Function(Pointer<Void>, Uint16, Pointer<Void>, Pointer<Uint16>, Uint32);
typedef BluetoothGATTGetServicesDart = int Function(Pointer<Void>, int, Pointer<Void>, Pointer<Uint16>, int);
final BluetoothGATTGetServices = DynamicLibrary.open('BluetoothApis.dll')
    .lookupFunction<BluetoothGATTGetServicesNative, BluetoothGATTGetServicesDart>('BluetoothGATTGetServices');
// hDevice : HANDLE -> Pointer<Void>
// ServicesBufferCount : WORD -> Uint16
// ServicesBuffer : BTH_LE_GATT_SERVICE* optional, out -> Pointer<Void>
// ServicesBufferActual : WORD* out -> Pointer<Uint16>
// Flags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function BluetoothGATTGetServices(
  hDevice: THandle;   // HANDLE
  ServicesBufferCount: Word;   // WORD
  ServicesBuffer: Pointer;   // BTH_LE_GATT_SERVICE* optional, out
  ServicesBufferActual: Pointer;   // WORD* out
  Flags: DWORD   // DWORD
): Integer; stdcall;
  external 'BluetoothApis.dll' name 'BluetoothGATTGetServices';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "BluetoothGATTGetServices"
  c_BluetoothGATTGetServices :: Ptr () -> Word16 -> Ptr () -> Ptr Word16 -> Word32 -> IO Int32
-- hDevice : HANDLE -> Ptr ()
-- ServicesBufferCount : WORD -> Word16
-- ServicesBuffer : BTH_LE_GATT_SERVICE* optional, out -> Ptr ()
-- ServicesBufferActual : WORD* out -> Ptr Word16
-- Flags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let bluetoothgattgetservices =
  foreign "BluetoothGATTGetServices"
    ((ptr void) @-> uint16_t @-> (ptr void) @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* hDevice : HANDLE -> (ptr void) *)
(* ServicesBufferCount : WORD -> uint16_t *)
(* ServicesBuffer : BTH_LE_GATT_SERVICE* optional, out -> (ptr void) *)
(* ServicesBufferActual : WORD* out -> (ptr uint16_t) *)
(* Flags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library bluetoothapis (t "BluetoothApis.dll"))
(cffi:use-foreign-library bluetoothapis)

(cffi:defcfun ("BluetoothGATTGetServices" bluetooth-gattget-services :convention :stdcall) :int32
  (h-device :pointer)   ; HANDLE
  (services-buffer-count :uint16)   ; WORD
  (services-buffer :pointer)   ; BTH_LE_GATT_SERVICE* optional, out
  (services-buffer-actual :pointer)   ; WORD* out
  (flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $BluetoothGATTGetServices = Win32::API::More->new('BluetoothApis',
    'int BluetoothGATTGetServices(HANDLE hDevice, WORD ServicesBufferCount, LPVOID ServicesBuffer, LPVOID ServicesBufferActual, DWORD Flags)');
# my $ret = $BluetoothGATTGetServices->Call($hDevice, $ServicesBufferCount, $ServicesBuffer, $ServicesBufferActual, $Flags);
# hDevice : HANDLE -> HANDLE
# ServicesBufferCount : WORD -> WORD
# ServicesBuffer : BTH_LE_GATT_SERVICE* optional, out -> LPVOID
# ServicesBufferActual : WORD* out -> LPVOID
# Flags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型