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

BluetoothGATTGetCharacteristicValue

関数
GATTキャラクタリスティックの値を読み取り取得する。
DLLBluetoothApis.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

HRESULT BluetoothGATTGetCharacteristicValue(
    HANDLE hDevice,
    BTH_LE_GATT_CHARACTERISTIC* Characteristic,
    DWORD CharacteristicValueDataSize,
    BTH_LE_GATT_CHARACTERISTIC_VALUE* CharacteristicValue,   // optional
    WORD* CharacteristicValueSizeRequired,   // optional
    DWORD Flags
);

パラメーター

名前型方向説明
hDeviceHANDLEinサービスのハンドル。
CharacteristicBTH_LE_GATT_CHARACTERISTIC*in取得する特性値の親となる特性 (characteristic) へのポインター。
CharacteristicValueDataSizeDWORDinCharacteristicValue パラメーターに割り当てられているバイト数。
CharacteristicValueBTH_LE_GATT_CHARACTERISTIC_VALUE*outoptional特性値を返すバッファーへのポインター。
CharacteristicValueSizeRequiredWORD*outoptionalCharacteristicValue が指すバッファーにデータを返すために必要なバイト数を格納するバッファーへのポインター。
FlagsDWORDin

BluetoothGATTGetCharacteristicValue の動作を変更するフラグです:

フラグ 説明
BLUETOOTH_GATT_FLAG_NONE クライアントに固有の GATT 要件はありません (既定)。
BLUETOOTH_GATT_FLAG_CONNECTION_ENCRYPTED クライアントは、暗号化されたチャネル経由でデータを送信することを要求します。
BLUETOOTH_GATT_FLAG_CONNECTION_AUTHENTICATED クライアントは、認証されたチャネル経由でデータを送信することを要求します。
BLUETOOTH_GATT_FLAG_FORCE_READ_FROM_DEVICE 特性値をデバイスから直接読み取ります。キャッシュに既に値がある場合は、それを上書きします。
BLUETOOTH_GATT_FLAG_FORCE_READ_FROM_CACHE 特性値をキャッシュから読み取ります (キャッシュに存在するかどうかにかかわらず)。

戻り値の型: HRESULT

公式ドキュメント

指定された特性 (characteristic) の値を取得します。

戻り値

BluetoothGATTGetCharacteristicValue 関数は、次の値を返します:

戻り値 説明
S_OK
操作は正常に完了しました。
ERROR_MORE_DATA
バッファーのパラメーターが NULL であるため、代わりに利用可能な項目数が返されます。
ERROR_ACCESS_DENIED
親サービスとサービスのハンドルの両方が指定されており、サービスの階層をたどっても、指定された親サービスのハンドルに到達しない場合に返されます。
ERROR_INVALID_PARAMETER
CharacteristicValue と CharacteristicValueSizeRequired の両方が 0 です。
ERROR_INVALID_USER_BUFFER
バッファーが指定されていますが、指定されたバッファーのサイズ (バイト単位) が必要な大きさより小さい値です。
ERROR_BAD_COMMAND
キャッシュ内の現在のデータに不整合があると思われ、内部エラーを引き起こしています。
ERROR_BAD_NET_RESP
対象のサーバーから適切なネットワーク応答が返されませんでした。
ERROR_SEM_TIMEOUT
要求がタイムアウトしました。
ERROR_PRIVILEGE_NOT_HELD
特性のプロパティで規定されているとおり、この特性値は読み取ることができません。
ERROR_NO_SYSTEM_RESOURCES
操作中にメモリが不足しました。
E_BLUETOOTH_ATT_INVALID_HANDLE
指定された属性ハンドルは、このサーバーでは有効ではありませんでした。
E_BLUETOOTH_ATT_READ_NOT_PERMITTED
この属性は読み取ることができません。
E_BLUETOOTH_ATT_WRITE_NOT_PERMITTED
この属性は書き込むことができません。
E_BLUETOOTH_ATT_INVALID_PDU
属性 PDU が無効でした。
E_BLUETOOTH_ATT_INSUFFICIENT_AUTHENTICATION
この属性の読み取りまたは書き込みには、認証が必要です。
E_BLUETOOTH_ATT_REQUEST_NOT_SUPPORTED
属性サーバーは、クライアントから受信した要求をサポートしていません。
E_BLUETOOTH_ATT_INVALID_OFFSET
指定されたオフセットが、属性の末尾を超えています。
E_BLUETOOTH_ATT_INSUFFICIENT_AUTHORIZATION
この属性の読み取りまたは書き込みには、承認 (authorization) が必要です。
E_BLUETOOTH_ATT_PREPARE_QUEUE_FULL
キューに登録された prepare write が多すぎます。
E_BLUETOOTH_ATT_ATTRIBUTE_NOT_FOUND
指定された属性ハンドルの範囲内に、属性が見つかりませんでした。
E_BLUETOOTH_ATT_ATTRIBUTE_NOT_LONG
この属性は、Read Blob Request を使用して読み取りまたは書き込みを行うことはできません。
E_BLUETOOTH_ATT_INSUFFICIENT_ENCRYPTION_KEY_SIZE
このリンクの暗号化に使用されている暗号化キーのサイズが不足しています。
E_BLUETOOTH_ATT_INVALID_ATTRIBUTE_VALUE_LENGTH
属性値の長さが、この操作に対して無効です。
E_BLUETOOTH_ATT_UNLIKELY
要求された属性要求で、発生する可能性が低いエラーが発生したため、要求どおりに完了できませんでした。
E_BLUETOOTH_ATT_INSUFFICIENT_ENCRYPTION
この属性の読み取りまたは書き込みには、暗号化が必要です。
E_BLUETOOTH_ATT_UNSUPPORTED_GROUP_TYPE
この属性の型は、上位層の仕様で定義されているグループ化属性としてサポートされていません。
E_BLUETOOTH_ATT_INSUFFICIENT_RESOURCES
要求を完了するためのリソースが不足しています。
E_BLUETOOTH_ATT_UNKNOWN_ERROR
予約されている範囲のエラーを受信しました。

解説(Remarks)

キャッシュに特性値が既に存在する場合は、キャッシュから返されます。デバイスのすべての属性はペアリングまたは関連付けの時点でキャッシュされるため、ほとんどの場合はこの動作になります。ただし、キャッシュに存在しない場合は、特性値がデバイスから直接読み取られ、読み取りに成功した時点でキャッシュされます。BLUETOOTH_GATT_FLAG_FORCE_READ_FROM_CACHE または BLUETOOTH_GATT_FLAG_FORCE_READ_FROM_DEVICE が指定されている場合、特性値は指定された方法で読み取られます。

返された特性は、デバイスから直接取得に成功した時点でキャッシュされます。サービス変更イベントを受信しない限り、返される特性の一覧は変化しないものと想定されます。

プロファイルドライバーは、返される特性の配列を格納するのに十分な大きさのバッファーをあらかじめ割り当てておく必要があります。必要なバッファーサイズは、CharacteristicValueSizeRequired に NULL 以外の値を、CharacteristicValue に NULL を渡すことで確認できます。

親サービスはキャッシュに存在している必要があります。存在しない場合、この関数は失敗します。親サービスは、BluetoothGATTGetServices または BluetoothGATTGetIncludedServices から返されたサービスである必要があります。

例


            if (currGattChar->IsReadable) {
////////////////////////////////////////////////////////////////////////////
// Determine Characteristic Value Buffer Size
////////////////////////////////////////////////////////////////////////////

                hr = BluetoothGATTGetCharacteristicValue(
                        hCurrService,
                        currGattChar,
                        0,
                        NULL,
                        &charValueDataSize,
                        BLUETOOTH_GATT_FLAG_NONE);

                if (HRESULT_FROM_WIN32(ERROR_MORE_DATA) != hr) {
                    PrintHr("BluetoothGATTGetCharacteristicValue - Buffer Size", hr);
                    goto GetDescriptors; // Proceed to retrieving descriptors
                }

                pCharValueBuffer = (PBTH_LE_GATT_CHARACTERISTIC_VALUE)malloc(charValueDataSize);

                if (NULL == pCharValueBuffer) {
                    printf("pCharValueBuffer out of memory\r\n");
                    goto Done;
                } else {
                    RtlZeroMemory(pCharValueBuffer, charValueDataSize);
                }

////////////////////////////////////////////////////////////////////////////
// Retrieve the Characteristic Value
////////////////////////////////////////////////////////////////////////////

                hr = BluetoothGATTGetCharacteristicValue(
                        hCurrService,
                        currGattChar,
                        (ULONG)charValueDataSize,
                        pCharValueBuffer,
                        NULL,
                        BLUETOOTH_GATT_FLAG_NONE);

                if (S_OK != hr) {
                    PrintHr("BluetoothGATTGetCharacteristicValue - Actual Data", hr);
                    goto GetDescriptors; // Proceed to retrieving descriptors
                }

                PrintCharacteristicValue(pCharValueBuffer, 2, currGattChar->CharacteristicUuid);

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

各言語での呼び出し定義

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

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

BluetoothGATTGetCharacteristicValue = ctypes.windll.bluetoothapis.BluetoothGATTGetCharacteristicValue
BluetoothGATTGetCharacteristicValue.restype = ctypes.c_int
BluetoothGATTGetCharacteristicValue.argtypes = [
    wintypes.HANDLE,  # hDevice : HANDLE
    ctypes.c_void_p,  # Characteristic : BTH_LE_GATT_CHARACTERISTIC*
    wintypes.DWORD,  # CharacteristicValueDataSize : DWORD
    ctypes.c_void_p,  # CharacteristicValue : BTH_LE_GATT_CHARACTERISTIC_VALUE* optional, out
    ctypes.POINTER(ctypes.c_ushort),  # CharacteristicValueSizeRequired : WORD* optional, out
    wintypes.DWORD,  # Flags : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	bluetoothapis = windows.NewLazySystemDLL("BluetoothApis.dll")
	procBluetoothGATTGetCharacteristicValue = bluetoothapis.NewProc("BluetoothGATTGetCharacteristicValue")
)

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

extern "bluetoothapis" fn BluetoothGATTGetCharacteristicValue(
    hDevice: ?*anyopaque, // HANDLE
    Characteristic: [*c]BTH_LE_GATT_CHARACTERISTIC, // BTH_LE_GATT_CHARACTERISTIC*
    CharacteristicValueDataSize: u32, // DWORD
    CharacteristicValue: [*c]BTH_LE_GATT_CHARACTERISTIC_VALUE, // BTH_LE_GATT_CHARACTERISTIC_VALUE* optional, out
    CharacteristicValueSizeRequired: [*c]u16, // WORD* optional, out
    Flags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc BluetoothGATTGetCharacteristicValue(
    hDevice: pointer,  # HANDLE
    Characteristic: ptr BTH_LE_GATT_CHARACTERISTIC,  # BTH_LE_GATT_CHARACTERISTIC*
    CharacteristicValueDataSize: uint32,  # DWORD
    CharacteristicValue: ptr BTH_LE_GATT_CHARACTERISTIC_VALUE,  # BTH_LE_GATT_CHARACTERISTIC_VALUE* optional, out
    CharacteristicValueSizeRequired: ptr uint16,  # WORD* optional, out
    Flags: uint32  # DWORD
): int32 {.importc: "BluetoothGATTGetCharacteristicValue", stdcall, dynlib: "BluetoothApis.dll".}
pragma(lib, "bluetoothapis");
extern(Windows)
int BluetoothGATTGetCharacteristicValue(
    void* hDevice,   // HANDLE
    BTH_LE_GATT_CHARACTERISTIC* Characteristic,   // BTH_LE_GATT_CHARACTERISTIC*
    uint CharacteristicValueDataSize,   // DWORD
    BTH_LE_GATT_CHARACTERISTIC_VALUE* CharacteristicValue,   // BTH_LE_GATT_CHARACTERISTIC_VALUE* optional, out
    ushort* CharacteristicValueSizeRequired,   // WORD* optional, out
    uint Flags   // DWORD
);
ccall((:BluetoothGATTGetCharacteristicValue, "BluetoothApis.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{BTH_LE_GATT_CHARACTERISTIC}, UInt32, Ptr{BTH_LE_GATT_CHARACTERISTIC_VALUE}, Ptr{UInt16}, UInt32),
      hDevice, Characteristic, CharacteristicValueDataSize, CharacteristicValue, CharacteristicValueSizeRequired, Flags)
# hDevice : HANDLE -> Ptr{Cvoid}
# Characteristic : BTH_LE_GATT_CHARACTERISTIC* -> Ptr{BTH_LE_GATT_CHARACTERISTIC}
# CharacteristicValueDataSize : DWORD -> UInt32
# CharacteristicValue : BTH_LE_GATT_CHARACTERISTIC_VALUE* optional, out -> Ptr{BTH_LE_GATT_CHARACTERISTIC_VALUE}
# CharacteristicValueSizeRequired : WORD* optional, out -> Ptr{UInt16}
# Flags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t BluetoothGATTGetCharacteristicValue(
    void* hDevice,
    void* Characteristic,
    uint32_t CharacteristicValueDataSize,
    void* CharacteristicValue,
    uint16_t* CharacteristicValueSizeRequired,
    uint32_t Flags);
]]
local bluetoothapis = ffi.load("bluetoothapis")
-- bluetoothapis.BluetoothGATTGetCharacteristicValue(hDevice, Characteristic, CharacteristicValueDataSize, CharacteristicValue, CharacteristicValueSizeRequired, Flags)
-- hDevice : HANDLE
-- Characteristic : BTH_LE_GATT_CHARACTERISTIC*
-- CharacteristicValueDataSize : DWORD
-- CharacteristicValue : BTH_LE_GATT_CHARACTERISTIC_VALUE* optional, out
-- CharacteristicValueSizeRequired : WORD* optional, out
-- Flags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('BluetoothApis.dll');
const BluetoothGATTGetCharacteristicValue = lib.func('__stdcall', 'BluetoothGATTGetCharacteristicValue', 'int32_t', ['void *', 'void *', 'uint32_t', 'void *', 'uint16_t *', 'uint32_t']);
// BluetoothGATTGetCharacteristicValue(hDevice, Characteristic, CharacteristicValueDataSize, CharacteristicValue, CharacteristicValueSizeRequired, Flags)
// hDevice : HANDLE -> 'void *'
// Characteristic : BTH_LE_GATT_CHARACTERISTIC* -> 'void *'
// CharacteristicValueDataSize : DWORD -> 'uint32_t'
// CharacteristicValue : BTH_LE_GATT_CHARACTERISTIC_VALUE* optional, out -> 'void *'
// CharacteristicValueSizeRequired : WORD* optional, out -> 'uint16_t *'
// Flags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("BluetoothApis.dll", {
  BluetoothGATTGetCharacteristicValue: { parameters: ["pointer", "pointer", "u32", "pointer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.BluetoothGATTGetCharacteristicValue(hDevice, Characteristic, CharacteristicValueDataSize, CharacteristicValue, CharacteristicValueSizeRequired, Flags)
// hDevice : HANDLE -> "pointer"
// Characteristic : BTH_LE_GATT_CHARACTERISTIC* -> "pointer"
// CharacteristicValueDataSize : DWORD -> "u32"
// CharacteristicValue : BTH_LE_GATT_CHARACTERISTIC_VALUE* optional, out -> "pointer"
// CharacteristicValueSizeRequired : WORD* optional, out -> "pointer"
// Flags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t BluetoothGATTGetCharacteristicValue(
    void* hDevice,
    void* Characteristic,
    uint32_t CharacteristicValueDataSize,
    void* CharacteristicValue,
    uint16_t* CharacteristicValueSizeRequired,
    uint32_t Flags);
C, "BluetoothApis.dll");
// $ffi->BluetoothGATTGetCharacteristicValue(hDevice, Characteristic, CharacteristicValueDataSize, CharacteristicValue, CharacteristicValueSizeRequired, Flags);
// hDevice : HANDLE
// Characteristic : BTH_LE_GATT_CHARACTERISTIC*
// CharacteristicValueDataSize : DWORD
// CharacteristicValue : BTH_LE_GATT_CHARACTERISTIC_VALUE* optional, out
// CharacteristicValueSizeRequired : WORD* optional, 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 BluetoothGATTGetCharacteristicValue(
        Pointer hDevice,   // HANDLE
        Pointer Characteristic,   // BTH_LE_GATT_CHARACTERISTIC*
        int CharacteristicValueDataSize,   // DWORD
        Pointer CharacteristicValue,   // BTH_LE_GATT_CHARACTERISTIC_VALUE* optional, out
        ShortByReference CharacteristicValueSizeRequired,   // WORD* optional, out
        int Flags   // DWORD
    );
}
@[Link("bluetoothapis")]
lib LibBluetoothApis
  fun BluetoothGATTGetCharacteristicValue = BluetoothGATTGetCharacteristicValue(
    hDevice : Void*,   # HANDLE
    Characteristic : BTH_LE_GATT_CHARACTERISTIC*,   # BTH_LE_GATT_CHARACTERISTIC*
    CharacteristicValueDataSize : UInt32,   # DWORD
    CharacteristicValue : BTH_LE_GATT_CHARACTERISTIC_VALUE*,   # BTH_LE_GATT_CHARACTERISTIC_VALUE* optional, out
    CharacteristicValueSizeRequired : UInt16*,   # WORD* optional, 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 BluetoothGATTGetCharacteristicValueNative = Int32 Function(Pointer<Void>, Pointer<Void>, Uint32, Pointer<Void>, Pointer<Uint16>, Uint32);
typedef BluetoothGATTGetCharacteristicValueDart = int Function(Pointer<Void>, Pointer<Void>, int, Pointer<Void>, Pointer<Uint16>, int);
final BluetoothGATTGetCharacteristicValue = DynamicLibrary.open('BluetoothApis.dll')
    .lookupFunction<BluetoothGATTGetCharacteristicValueNative, BluetoothGATTGetCharacteristicValueDart>('BluetoothGATTGetCharacteristicValue');
// hDevice : HANDLE -> Pointer<Void>
// Characteristic : BTH_LE_GATT_CHARACTERISTIC* -> Pointer<Void>
// CharacteristicValueDataSize : DWORD -> Uint32
// CharacteristicValue : BTH_LE_GATT_CHARACTERISTIC_VALUE* optional, out -> Pointer<Void>
// CharacteristicValueSizeRequired : WORD* optional, out -> Pointer<Uint16>
// Flags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function BluetoothGATTGetCharacteristicValue(
  hDevice: THandle;   // HANDLE
  Characteristic: Pointer;   // BTH_LE_GATT_CHARACTERISTIC*
  CharacteristicValueDataSize: DWORD;   // DWORD
  CharacteristicValue: Pointer;   // BTH_LE_GATT_CHARACTERISTIC_VALUE* optional, out
  CharacteristicValueSizeRequired: Pointer;   // WORD* optional, out
  Flags: DWORD   // DWORD
): Integer; stdcall;
  external 'BluetoothApis.dll' name 'BluetoothGATTGetCharacteristicValue';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "BluetoothGATTGetCharacteristicValue"
  c_BluetoothGATTGetCharacteristicValue :: Ptr () -> Ptr () -> Word32 -> Ptr () -> Ptr Word16 -> Word32 -> IO Int32
-- hDevice : HANDLE -> Ptr ()
-- Characteristic : BTH_LE_GATT_CHARACTERISTIC* -> Ptr ()
-- CharacteristicValueDataSize : DWORD -> Word32
-- CharacteristicValue : BTH_LE_GATT_CHARACTERISTIC_VALUE* optional, out -> Ptr ()
-- CharacteristicValueSizeRequired : WORD* optional, out -> Ptr Word16
-- Flags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let bluetoothgattgetcharacteristicvalue =
  foreign "BluetoothGATTGetCharacteristicValue"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> (ptr void) @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* hDevice : HANDLE -> (ptr void) *)
(* Characteristic : BTH_LE_GATT_CHARACTERISTIC* -> (ptr void) *)
(* CharacteristicValueDataSize : DWORD -> uint32_t *)
(* CharacteristicValue : BTH_LE_GATT_CHARACTERISTIC_VALUE* optional, out -> (ptr void) *)
(* CharacteristicValueSizeRequired : WORD* optional, 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 ("BluetoothGATTGetCharacteristicValue" bluetooth-gattget-characteristic-value :convention :stdcall) :int32
  (h-device :pointer)   ; HANDLE
  (characteristic :pointer)   ; BTH_LE_GATT_CHARACTERISTIC*
  (characteristic-value-data-size :uint32)   ; DWORD
  (characteristic-value :pointer)   ; BTH_LE_GATT_CHARACTERISTIC_VALUE* optional, out
  (characteristic-value-size-required :pointer)   ; WORD* optional, out
  (flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $BluetoothGATTGetCharacteristicValue = Win32::API::More->new('BluetoothApis',
    'int BluetoothGATTGetCharacteristicValue(HANDLE hDevice, LPVOID Characteristic, DWORD CharacteristicValueDataSize, LPVOID CharacteristicValue, LPVOID CharacteristicValueSizeRequired, DWORD Flags)');
# my $ret = $BluetoothGATTGetCharacteristicValue->Call($hDevice, $Characteristic, $CharacteristicValueDataSize, $CharacteristicValue, $CharacteristicValueSizeRequired, $Flags);
# hDevice : HANDLE -> HANDLE
# Characteristic : BTH_LE_GATT_CHARACTERISTIC* -> LPVOID
# CharacteristicValueDataSize : DWORD -> DWORD
# CharacteristicValue : BTH_LE_GATT_CHARACTERISTIC_VALUE* optional, out -> LPVOID
# CharacteristicValueSizeRequired : WORD* optional, out -> LPVOID
# Flags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型