ホーム › Devices.BiometricFramework › WinBioAsyncOpenFramework

WinBioAsyncOpenFramework

関数

生体認証フレームワークへの非同期接続ハンドルを開く。

DLLwinbio.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

HRESULT WinBioAsyncOpenFramework(
    WINBIO_ASYNC_NOTIFICATION_METHOD NotificationMethod,
    HWND TargetWindow,   // optional
    DWORD MessageCode,   // optional
    PWINBIO_ASYNC_COMPLETION_CALLBACK CallbackRoutine,   // optional
    void* UserData,   // optional
    BOOL AsynchronousOpen,
    DWORD* FrameworkHandle   // optional
);

パラメーター

名前

型

方向

説明

NotificationMethod

WINBIO_ASYNC_NOTIFICATION_METHOD

このフレームワークセッションにおける非同期操作の完了通知を、クライアントアプリケーションにどのように配信するかを指定します。次のいずれかの値である必要があります。

値	意味
WINBIO_ASYNC_NOTIFY_CALLBACK	フレームワークは、アプリケーションが定義したコールバック関数を呼び出します。
WINBIO_ASYNC_NOTIFY_MESSAGE	フレームワークは、アプリケーションのメッセージキューにウィンドウメッセージをポストします。

TargetWindow

HWND

inoptional

完了通知を受け取るウィンドウのハンドルです。この値は、NotificationMethod パラメーターに WINBIO_ASYNC_NOTIFY_MESSAGE が設定されていない限り無視されます。

MessageCode

DWORD

inoptional

完了通知を示すためにフレームワークが送信するウィンドウメッセージコードです。この値は、NotificationMethod パラメーターに WINBIO_ASYNC_NOTIFY_MESSAGE が設定されていない限り無視されます。値は WM_APP (0x8000) から 0xBFFF までの範囲内である必要があります。

Windows Biometric Framework は、メッセージの LPARAM 値に、操作の結果を格納する WINBIO_ASYNC_RESULT 構造体のアドレスを設定します。構造体の使用を終えた後は、WinBioFree を呼び出して解放する必要があります。

CallbackRoutine

PWINBIO_ASYNC_COMPLETION_CALLBACK

inoptional

完了通知のために呼び出されるコールバックルーチンのアドレスです。この値は、NotificationMethod パラメーターに WINBIO_ASYNC_NOTIFY_CALLBACK が設定されていない限り無視されます。

UserData

void*

inoptional

呼び出し元が指定するバッファーのアドレスです。このバッファーは、フレームワークやバイオメトリックユニットによって変更されることはありません。バッファーは WINBIO_ASYNC_RESULT 構造体で返されます。アプリケーションはこのデータを利用して、完了通知を受け取った際に実行する処理を判断したり、要求した操作に関する追加情報を保持したりできます。

AsynchronousOpen

BOOL

フレームワークセッションが開かれるまでブロックするかどうかを指定します。FALSE を指定すると、プロセスはブロックされます。TRUE を指定すると、セッションは非同期に開かれます。

フレームワークセッションを同期的に開くために FALSE を指定した場合、成功または失敗はこの関数の HRESULT 戻り値によって呼び出し元に直接返されます。セッションが正常に開かれた場合、アプリケーションが最初に受け取る非同期完了イベントは、フレームワークが開かれた後に要求された非同期操作に対するものになります。

フレームワークセッションを非同期に開くために TRUE を指定した場合、最初に受け取る非同期完了通知はフレームワークを開く操作に対するものになります。NotificationMethod パラメーターに WINBIO_ASYNC_NOTIFY_CALLBACK が設定されている場合、操作結果は CallbackRoutine パラメーターで指定されたコールバック関数において WINBIO_ASYNC_RESULT 構造体で渡されます。NotificationMethod パラメーターに WINBIO_ASYNC_NOTIFY_MESSAGE が設定されている場合、操作結果はウィンドウメッセージの LPARAM フィールドが指す WINBIO_ASYNC_RESULT 構造体で渡されます。

FrameworkHandle

DWORD*

outoptional

関数が成功しなかった場合、このパラメーターは NULL になります。

セッションが同期的に、かつ正常に開かれた場合、このパラメーターにはセッションハンドルへのポインターが格納されます。

セッションを非同期に開くよう指定した場合、このメソッドは直ちに戻り、セッションハンドルは NULL になります。セッションが正常に開かれたかどうかを判断するには、WINBIO_ASYNC_RESULT 構造体を調べる必要があります。

戻り値の型: HRESULT

公式ドキュメント

バイオメトリックフレームワークへのハンドルを開きます。Windows 10 ビルド 1607 以降、この関数はモバイルイメージで使用できます。

戻り値

関数が成功した場合は S_OK を返します。関数が失敗した場合は、エラーを示す HRESULT 値を返します。返される可能性のある値には、次の表に示すものが含まれます (ただしこれらに限定されません)。一般的なエラーコードの一覧については、Common HRESULT Values を参照してください。

戻り値	説明
E_OUTOFMEMORY	フレームワークセッションを作成するための十分なメモリがありません。
E_INVALIDARG	通知方法に WINBIO_ASYNC_NOTIFY_MESSAGE を設定した場合、TargetWindow パラメーターに NULL または HWND_BROADCAST を指定することはできず、MessageCode パラメーターをゼロ (0) にすることもできません。
E_POINTER	FrameworkHandle パラメーターと AsynchronousOpen パラメーターを設定する必要があります。通知方法に WINBIO_ASYNC_NOTIFY_CALLBACK を設定した場合は、CallbackRoutine パラメーターにコールバック関数のアドレスも指定する必要があります。

解説(Remarks)

WinBioAsyncOpenFramework 関数が返すフレームワークハンドルは、次の関数の非同期完了通知を生成するために使用できます。

AsynchronousOpen パラメーターは、開く操作がブロックするかどうかのみを決定します。このパラメーターは、セッションハンドルを使用する以降の呼び出しの完了動作には影響しません。

AsynchronousOpen パラメーターに TRUE を設定した場合、この関数は引数の初期検証を実行した時点で直ちに S_OK を返します。それ以降に検出されたエラーは、NotificationMethod パラメーターで指定された方法で呼び出し元に通知されます。つまり、戻り値が成功であることは WinBioAsyncOpenFramework のパラメーターに問題がなかったことを示すだけであり、開く操作が成功したことを示すものではありません。開く操作が成功したかどうかを判断するには、WINBIO_ASYNC_RESULT 構造体を調べる必要があります。

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

各言語での呼び出し定義

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

HRESULT WinBioAsyncOpenFramework(
    WINBIO_ASYNC_NOTIFICATION_METHOD NotificationMethod,
    HWND TargetWindow,   // optional
    DWORD MessageCode,   // optional
    PWINBIO_ASYNC_COMPLETION_CALLBACK CallbackRoutine,   // optional
    void* UserData,   // optional
    BOOL AsynchronousOpen,
    DWORD* FrameworkHandle   // optional
);

[DllImport("winbio.dll", ExactSpelling = true)]
static extern int WinBioAsyncOpenFramework(
    int NotificationMethod,   // WINBIO_ASYNC_NOTIFICATION_METHOD
    IntPtr TargetWindow,   // HWND optional
    uint MessageCode,   // DWORD optional
    IntPtr CallbackRoutine,   // PWINBIO_ASYNC_COMPLETION_CALLBACK optional
    IntPtr UserData,   // void* optional
    bool AsynchronousOpen,   // BOOL
    IntPtr FrameworkHandle   // DWORD* optional, out
);

<DllImport("winbio.dll", ExactSpelling:=True)>
Public Shared Function WinBioAsyncOpenFramework(
    NotificationMethod As Integer,   ' WINBIO_ASYNC_NOTIFICATION_METHOD
    TargetWindow As IntPtr,   ' HWND optional
    MessageCode As UInteger,   ' DWORD optional
    CallbackRoutine As IntPtr,   ' PWINBIO_ASYNC_COMPLETION_CALLBACK optional
    UserData As IntPtr,   ' void* optional
    AsynchronousOpen As Boolean,   ' BOOL
    FrameworkHandle As IntPtr   ' DWORD* optional, out
) As Integer
End Function

' NotificationMethod : WINBIO_ASYNC_NOTIFICATION_METHOD
' TargetWindow : HWND optional
' MessageCode : DWORD optional
' CallbackRoutine : PWINBIO_ASYNC_COMPLETION_CALLBACK optional
' UserData : void* optional
' AsynchronousOpen : BOOL
' FrameworkHandle : DWORD* optional, out
Declare PtrSafe Function WinBioAsyncOpenFramework Lib "winbio" ( _
    ByVal NotificationMethod As Long, _
    ByVal TargetWindow As LongPtr, _
    ByVal MessageCode As Long, _
    ByVal CallbackRoutine As LongPtr, _
    ByVal UserData As LongPtr, _
    ByVal AsynchronousOpen As Long, _
    ByVal FrameworkHandle As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WinBioAsyncOpenFramework = ctypes.windll.winbio.WinBioAsyncOpenFramework
WinBioAsyncOpenFramework.restype = ctypes.c_int
WinBioAsyncOpenFramework.argtypes = [
    ctypes.c_int,  # NotificationMethod : WINBIO_ASYNC_NOTIFICATION_METHOD
    wintypes.HANDLE,  # TargetWindow : HWND optional
    wintypes.DWORD,  # MessageCode : DWORD optional
    ctypes.c_void_p,  # CallbackRoutine : PWINBIO_ASYNC_COMPLETION_CALLBACK optional
    ctypes.POINTER(None),  # UserData : void* optional
    wintypes.BOOL,  # AsynchronousOpen : BOOL
    ctypes.POINTER(wintypes.DWORD),  # FrameworkHandle : DWORD* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('winbio.dll')
WinBioAsyncOpenFramework = Fiddle::Function.new(
  lib['WinBioAsyncOpenFramework'],
  [
    Fiddle::TYPE_INT,  # NotificationMethod : WINBIO_ASYNC_NOTIFICATION_METHOD
    Fiddle::TYPE_VOIDP,  # TargetWindow : HWND optional
    -Fiddle::TYPE_INT,  # MessageCode : DWORD optional
    Fiddle::TYPE_VOIDP,  # CallbackRoutine : PWINBIO_ASYNC_COMPLETION_CALLBACK optional
    Fiddle::TYPE_VOIDP,  # UserData : void* optional
    Fiddle::TYPE_INT,  # AsynchronousOpen : BOOL
    Fiddle::TYPE_VOIDP,  # FrameworkHandle : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "winbio")]
extern "system" {
    fn WinBioAsyncOpenFramework(
        NotificationMethod: i32,  // WINBIO_ASYNC_NOTIFICATION_METHOD
        TargetWindow: *mut core::ffi::c_void,  // HWND optional
        MessageCode: u32,  // DWORD optional
        CallbackRoutine: *const core::ffi::c_void,  // PWINBIO_ASYNC_COMPLETION_CALLBACK optional
        UserData: *mut (),  // void* optional
        AsynchronousOpen: i32,  // BOOL
        FrameworkHandle: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("winbio.dll")]
public static extern int WinBioAsyncOpenFramework(int NotificationMethod, IntPtr TargetWindow, uint MessageCode, IntPtr CallbackRoutine, IntPtr UserData, bool AsynchronousOpen, IntPtr FrameworkHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winbio_WinBioAsyncOpenFramework' -Namespace Win32 -PassThru
# $api::WinBioAsyncOpenFramework(NotificationMethod, TargetWindow, MessageCode, CallbackRoutine, UserData, AsynchronousOpen, FrameworkHandle)

#uselib "winbio.dll"
#func global WinBioAsyncOpenFramework "WinBioAsyncOpenFramework" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; WinBioAsyncOpenFramework NotificationMethod, TargetWindow, MessageCode, CallbackRoutine, UserData, AsynchronousOpen, varptr(FrameworkHandle)   ; 戻り値は stat
; NotificationMethod : WINBIO_ASYNC_NOTIFICATION_METHOD -> "sptr"
; TargetWindow : HWND optional -> "sptr"
; MessageCode : DWORD optional -> "sptr"
; CallbackRoutine : PWINBIO_ASYNC_COMPLETION_CALLBACK optional -> "sptr"
; UserData : void* optional -> "sptr"
; AsynchronousOpen : BOOL -> "sptr"
; FrameworkHandle : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "winbio.dll"
#cfunc global WinBioAsyncOpenFramework "WinBioAsyncOpenFramework" int, sptr, int, sptr, sptr, int, var
; res = WinBioAsyncOpenFramework(NotificationMethod, TargetWindow, MessageCode, CallbackRoutine, UserData, AsynchronousOpen, FrameworkHandle)
; NotificationMethod : WINBIO_ASYNC_NOTIFICATION_METHOD -> "int"
; TargetWindow : HWND optional -> "sptr"
; MessageCode : DWORD optional -> "int"
; CallbackRoutine : PWINBIO_ASYNC_COMPLETION_CALLBACK optional -> "sptr"
; UserData : void* optional -> "sptr"
; AsynchronousOpen : BOOL -> "int"
; FrameworkHandle : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "winbio.dll"
#cfunc global WinBioAsyncOpenFramework "WinBioAsyncOpenFramework" int, sptr, int, sptr, sptr, int, sptr
; res = WinBioAsyncOpenFramework(NotificationMethod, TargetWindow, MessageCode, CallbackRoutine, UserData, AsynchronousOpen, varptr(FrameworkHandle))
; NotificationMethod : WINBIO_ASYNC_NOTIFICATION_METHOD -> "int"
; TargetWindow : HWND optional -> "sptr"
; MessageCode : DWORD optional -> "int"
; CallbackRoutine : PWINBIO_ASYNC_COMPLETION_CALLBACK optional -> "sptr"
; UserData : void* optional -> "sptr"
; AsynchronousOpen : BOOL -> "int"
; FrameworkHandle : DWORD* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; HRESULT WinBioAsyncOpenFramework(WINBIO_ASYNC_NOTIFICATION_METHOD NotificationMethod, HWND TargetWindow, DWORD MessageCode, PWINBIO_ASYNC_COMPLETION_CALLBACK CallbackRoutine, void* UserData, BOOL AsynchronousOpen, DWORD* FrameworkHandle)
#uselib "winbio.dll"
#cfunc global WinBioAsyncOpenFramework "WinBioAsyncOpenFramework" int, intptr, int, intptr, intptr, int, var
; res = WinBioAsyncOpenFramework(NotificationMethod, TargetWindow, MessageCode, CallbackRoutine, UserData, AsynchronousOpen, FrameworkHandle)
; NotificationMethod : WINBIO_ASYNC_NOTIFICATION_METHOD -> "int"
; TargetWindow : HWND optional -> "intptr"
; MessageCode : DWORD optional -> "int"
; CallbackRoutine : PWINBIO_ASYNC_COMPLETION_CALLBACK optional -> "intptr"
; UserData : void* optional -> "intptr"
; AsynchronousOpen : BOOL -> "int"
; FrameworkHandle : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; HRESULT WinBioAsyncOpenFramework(WINBIO_ASYNC_NOTIFICATION_METHOD NotificationMethod, HWND TargetWindow, DWORD MessageCode, PWINBIO_ASYNC_COMPLETION_CALLBACK CallbackRoutine, void* UserData, BOOL AsynchronousOpen, DWORD* FrameworkHandle)
#uselib "winbio.dll"
#cfunc global WinBioAsyncOpenFramework "WinBioAsyncOpenFramework" int, intptr, int, intptr, intptr, int, intptr
; res = WinBioAsyncOpenFramework(NotificationMethod, TargetWindow, MessageCode, CallbackRoutine, UserData, AsynchronousOpen, varptr(FrameworkHandle))
; NotificationMethod : WINBIO_ASYNC_NOTIFICATION_METHOD -> "int"
; TargetWindow : HWND optional -> "intptr"
; MessageCode : DWORD optional -> "int"
; CallbackRoutine : PWINBIO_ASYNC_COMPLETION_CALLBACK optional -> "intptr"
; UserData : void* optional -> "intptr"
; AsynchronousOpen : BOOL -> "int"
; FrameworkHandle : DWORD* optional, out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

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

var (
	winbio = windows.NewLazySystemDLL("winbio.dll")
	procWinBioAsyncOpenFramework = winbio.NewProc("WinBioAsyncOpenFramework")
)

// NotificationMethod (WINBIO_ASYNC_NOTIFICATION_METHOD), TargetWindow (HWND optional), MessageCode (DWORD optional), CallbackRoutine (PWINBIO_ASYNC_COMPLETION_CALLBACK optional), UserData (void* optional), AsynchronousOpen (BOOL), FrameworkHandle (DWORD* optional, out)
r1, _, err := procWinBioAsyncOpenFramework.Call(
	uintptr(NotificationMethod),
	uintptr(TargetWindow),
	uintptr(MessageCode),
	uintptr(CallbackRoutine),
	uintptr(UserData),
	uintptr(AsynchronousOpen),
	uintptr(FrameworkHandle),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT

function WinBioAsyncOpenFramework(
  NotificationMethod: Integer;   // WINBIO_ASYNC_NOTIFICATION_METHOD
  TargetWindow: THandle;   // HWND optional
  MessageCode: DWORD;   // DWORD optional
  CallbackRoutine: Pointer;   // PWINBIO_ASYNC_COMPLETION_CALLBACK optional
  UserData: Pointer;   // void* optional
  AsynchronousOpen: BOOL;   // BOOL
  FrameworkHandle: Pointer   // DWORD* optional, out
): Integer; stdcall;
  external 'winbio.dll' name 'WinBioAsyncOpenFramework';

result := DllCall("winbio\WinBioAsyncOpenFramework"
    , "Int", NotificationMethod   ; WINBIO_ASYNC_NOTIFICATION_METHOD
    , "Ptr", TargetWindow   ; HWND optional
    , "UInt", MessageCode   ; DWORD optional
    , "Ptr", CallbackRoutine   ; PWINBIO_ASYNC_COMPLETION_CALLBACK optional
    , "Ptr", UserData   ; void* optional
    , "Int", AsynchronousOpen   ; BOOL
    , "Ptr", FrameworkHandle   ; DWORD* optional, out
    , "Int")   ; return: HRESULT

●WinBioAsyncOpenFramework(NotificationMethod, TargetWindow, MessageCode, CallbackRoutine, UserData, AsynchronousOpen, FrameworkHandle) = DLL("winbio.dll", "int WinBioAsyncOpenFramework(int, void*, dword, void*, void*, bool, void*)")
# 呼び出し: WinBioAsyncOpenFramework(NotificationMethod, TargetWindow, MessageCode, CallbackRoutine, UserData, AsynchronousOpen, FrameworkHandle)
# NotificationMethod : WINBIO_ASYNC_NOTIFICATION_METHOD -> "int"
# TargetWindow : HWND optional -> "void*"
# MessageCode : DWORD optional -> "dword"
# CallbackRoutine : PWINBIO_ASYNC_COMPLETION_CALLBACK optional -> "void*"
# UserData : void* optional -> "void*"
# AsynchronousOpen : BOOL -> "bool"
# FrameworkHandle : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "winbio" fn WinBioAsyncOpenFramework(
    NotificationMethod: i32, // WINBIO_ASYNC_NOTIFICATION_METHOD
    TargetWindow: ?*anyopaque, // HWND optional
    MessageCode: u32, // DWORD optional
    CallbackRoutine: ?*anyopaque, // PWINBIO_ASYNC_COMPLETION_CALLBACK optional
    UserData: ?*anyopaque, // void* optional
    AsynchronousOpen: i32, // BOOL
    FrameworkHandle: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) i32;

proc WinBioAsyncOpenFramework(
    NotificationMethod: int32,  # WINBIO_ASYNC_NOTIFICATION_METHOD
    TargetWindow: pointer,  # HWND optional
    MessageCode: uint32,  # DWORD optional
    CallbackRoutine: pointer,  # PWINBIO_ASYNC_COMPLETION_CALLBACK optional
    UserData: pointer,  # void* optional
    AsynchronousOpen: int32,  # BOOL
    FrameworkHandle: ptr uint32  # DWORD* optional, out
): int32 {.importc: "WinBioAsyncOpenFramework", stdcall, dynlib: "winbio.dll".}

pragma(lib, "winbio");
extern(Windows)
int WinBioAsyncOpenFramework(
    int NotificationMethod,   // WINBIO_ASYNC_NOTIFICATION_METHOD
    void* TargetWindow,   // HWND optional
    uint MessageCode,   // DWORD optional
    void* CallbackRoutine,   // PWINBIO_ASYNC_COMPLETION_CALLBACK optional
    void* UserData,   // void* optional
    int AsynchronousOpen,   // BOOL
    uint* FrameworkHandle   // DWORD* optional, out
);

ccall((:WinBioAsyncOpenFramework, "winbio.dll"), stdcall, Int32,
      (Int32, Ptr{Cvoid}, UInt32, Ptr{Cvoid}, Ptr{Cvoid}, Int32, Ptr{UInt32}),
      NotificationMethod, TargetWindow, MessageCode, CallbackRoutine, UserData, AsynchronousOpen, FrameworkHandle)
# NotificationMethod : WINBIO_ASYNC_NOTIFICATION_METHOD -> Int32
# TargetWindow : HWND optional -> Ptr{Cvoid}
# MessageCode : DWORD optional -> UInt32
# CallbackRoutine : PWINBIO_ASYNC_COMPLETION_CALLBACK optional -> Ptr{Cvoid}
# UserData : void* optional -> Ptr{Cvoid}
# AsynchronousOpen : BOOL -> Int32
# FrameworkHandle : DWORD* optional, out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
int32_t WinBioAsyncOpenFramework(
    int32_t NotificationMethod,
    void* TargetWindow,
    uint32_t MessageCode,
    void* CallbackRoutine,
    void* UserData,
    int32_t AsynchronousOpen,
    uint32_t* FrameworkHandle);
]]
local winbio = ffi.load("winbio")
-- winbio.WinBioAsyncOpenFramework(NotificationMethod, TargetWindow, MessageCode, CallbackRoutine, UserData, AsynchronousOpen, FrameworkHandle)
-- NotificationMethod : WINBIO_ASYNC_NOTIFICATION_METHOD
-- TargetWindow : HWND optional
-- MessageCode : DWORD optional
-- CallbackRoutine : PWINBIO_ASYNC_COMPLETION_CALLBACK optional
-- UserData : void* optional
-- AsynchronousOpen : BOOL
-- FrameworkHandle : DWORD* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('winbio.dll');
const WinBioAsyncOpenFramework = lib.func('__stdcall', 'WinBioAsyncOpenFramework', 'int32_t', ['int32_t', 'void *', 'uint32_t', 'void *', 'void *', 'int32_t', 'uint32_t *']);
// WinBioAsyncOpenFramework(NotificationMethod, TargetWindow, MessageCode, CallbackRoutine, UserData, AsynchronousOpen, FrameworkHandle)
// NotificationMethod : WINBIO_ASYNC_NOTIFICATION_METHOD -> 'int32_t'
// TargetWindow : HWND optional -> 'void *'
// MessageCode : DWORD optional -> 'uint32_t'
// CallbackRoutine : PWINBIO_ASYNC_COMPLETION_CALLBACK optional -> 'void *'
// UserData : void* optional -> 'void *'
// AsynchronousOpen : BOOL -> 'int32_t'
// FrameworkHandle : DWORD* optional, out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。

const lib = Deno.dlopen("winbio.dll", {
  WinBioAsyncOpenFramework: { parameters: ["i32", "pointer", "u32", "pointer", "pointer", "i32", "pointer"], result: "i32" },
});
// lib.symbols.WinBioAsyncOpenFramework(NotificationMethod, TargetWindow, MessageCode, CallbackRoutine, UserData, AsynchronousOpen, FrameworkHandle)
// NotificationMethod : WINBIO_ASYNC_NOTIFICATION_METHOD -> "i32"
// TargetWindow : HWND optional -> "pointer"
// MessageCode : DWORD optional -> "u32"
// CallbackRoutine : PWINBIO_ASYNC_COMPLETION_CALLBACK optional -> "pointer"
// UserData : void* optional -> "pointer"
// AsynchronousOpen : BOOL -> "i32"
// FrameworkHandle : DWORD* optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t WinBioAsyncOpenFramework(
    int32_t NotificationMethod,
    void* TargetWindow,
    uint32_t MessageCode,
    void* CallbackRoutine,
    void* UserData,
    int32_t AsynchronousOpen,
    uint32_t* FrameworkHandle);
C, "winbio.dll");
// $ffi->WinBioAsyncOpenFramework(NotificationMethod, TargetWindow, MessageCode, CallbackRoutine, UserData, AsynchronousOpen, FrameworkHandle);
// NotificationMethod : WINBIO_ASYNC_NOTIFICATION_METHOD
// TargetWindow : HWND optional
// MessageCode : DWORD optional
// CallbackRoutine : PWINBIO_ASYNC_COMPLETION_CALLBACK optional
// UserData : void* optional
// AsynchronousOpen : BOOL
// FrameworkHandle : DWORD* optional, out
// 構造体/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 Winbio extends StdCallLibrary {
    Winbio INSTANCE = Native.load("winbio", Winbio.class);
    int WinBioAsyncOpenFramework(
        int NotificationMethod,   // WINBIO_ASYNC_NOTIFICATION_METHOD
        Pointer TargetWindow,   // HWND optional
        int MessageCode,   // DWORD optional
        Callback CallbackRoutine,   // PWINBIO_ASYNC_COMPLETION_CALLBACK optional
        Pointer UserData,   // void* optional
        boolean AsynchronousOpen,   // BOOL
        IntByReference FrameworkHandle   // DWORD* optional, out
    );
}

@[Link("winbio")]
lib Libwinbio
  fun WinBioAsyncOpenFramework = WinBioAsyncOpenFramework(
    NotificationMethod : Int32,   # WINBIO_ASYNC_NOTIFICATION_METHOD
    TargetWindow : Void*,   # HWND optional
    MessageCode : UInt32,   # DWORD optional
    CallbackRoutine : Void*,   # PWINBIO_ASYNC_COMPLETION_CALLBACK optional
    UserData : Void*,   # void* optional
    AsynchronousOpen : Int32,   # BOOL
    FrameworkHandle : UInt32*   # DWORD* optional, out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。

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

typedef WinBioAsyncOpenFrameworkNative = Int32 Function(Int32, Pointer<Void>, Uint32, Pointer<Void>, Pointer<Void>, Int32, Pointer<Uint32>);
typedef WinBioAsyncOpenFrameworkDart = int Function(int, Pointer<Void>, int, Pointer<Void>, Pointer<Void>, int, Pointer<Uint32>);
final WinBioAsyncOpenFramework = DynamicLibrary.open('winbio.dll')
    .lookupFunction<WinBioAsyncOpenFrameworkNative, WinBioAsyncOpenFrameworkDart>('WinBioAsyncOpenFramework');
// NotificationMethod : WINBIO_ASYNC_NOTIFICATION_METHOD -> Int32
// TargetWindow : HWND optional -> Pointer<Void>
// MessageCode : DWORD optional -> Uint32
// CallbackRoutine : PWINBIO_ASYNC_COMPLETION_CALLBACK optional -> Pointer<Void>
// UserData : void* optional -> Pointer<Void>
// AsynchronousOpen : BOOL -> Int32
// FrameworkHandle : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function WinBioAsyncOpenFramework(
  NotificationMethod: Integer;   // WINBIO_ASYNC_NOTIFICATION_METHOD
  TargetWindow: THandle;   // HWND optional
  MessageCode: DWORD;   // DWORD optional
  CallbackRoutine: Pointer;   // PWINBIO_ASYNC_COMPLETION_CALLBACK optional
  UserData: Pointer;   // void* optional
  AsynchronousOpen: BOOL;   // BOOL
  FrameworkHandle: Pointer   // DWORD* optional, out
): Integer; stdcall;
  external 'winbio.dll' name 'WinBioAsyncOpenFramework';

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

foreign import stdcall safe "WinBioAsyncOpenFramework"
  c_WinBioAsyncOpenFramework :: Int32 -> Ptr () -> Word32 -> Ptr () -> Ptr () -> CInt -> Ptr Word32 -> IO Int32
-- NotificationMethod : WINBIO_ASYNC_NOTIFICATION_METHOD -> Int32
-- TargetWindow : HWND optional -> Ptr ()
-- MessageCode : DWORD optional -> Word32
-- CallbackRoutine : PWINBIO_ASYNC_COMPLETION_CALLBACK optional -> Ptr ()
-- UserData : void* optional -> Ptr ()
-- AsynchronousOpen : BOOL -> CInt
-- FrameworkHandle : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let winbioasyncopenframework =
  foreign "WinBioAsyncOpenFramework"
    (int32_t @-> (ptr void) @-> uint32_t @-> (ptr void) @-> (ptr void) @-> int32_t @-> (ptr uint32_t) @-> returning int32_t)
(* NotificationMethod : WINBIO_ASYNC_NOTIFICATION_METHOD -> int32_t *)
(* TargetWindow : HWND optional -> (ptr void) *)
(* MessageCode : DWORD optional -> uint32_t *)
(* CallbackRoutine : PWINBIO_ASYNC_COMPLETION_CALLBACK optional -> (ptr void) *)
(* UserData : void* optional -> (ptr void) *)
(* AsynchronousOpen : BOOL -> int32_t *)
(* FrameworkHandle : DWORD* optional, out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

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

(cffi:defcfun ("WinBioAsyncOpenFramework" win-bio-async-open-framework :convention :stdcall) :int32
  (notification-method :int32)   ; WINBIO_ASYNC_NOTIFICATION_METHOD
  (target-window :pointer)   ; HWND optional
  (message-code :uint32)   ; DWORD optional
  (callback-routine :pointer)   ; PWINBIO_ASYNC_COMPLETION_CALLBACK optional
  (user-data :pointer)   ; void* optional
  (asynchronous-open :int32)   ; BOOL
  (framework-handle :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $WinBioAsyncOpenFramework = Win32::API::More->new('winbio',
    'int WinBioAsyncOpenFramework(int NotificationMethod, HANDLE TargetWindow, DWORD MessageCode, LPVOID CallbackRoutine, LPVOID UserData, BOOL AsynchronousOpen, LPVOID FrameworkHandle)');
# my $ret = $WinBioAsyncOpenFramework->Call($NotificationMethod, $TargetWindow, $MessageCode, $CallbackRoutine, $UserData, $AsynchronousOpen, $FrameworkHandle);
# NotificationMethod : WINBIO_ASYNC_NOTIFICATION_METHOD -> int
# TargetWindow : HWND optional -> HANDLE
# MessageCode : DWORD optional -> DWORD
# CallbackRoutine : PWINBIO_ASYNC_COMPLETION_CALLBACK optional -> LPVOID
# UserData : void* optional -> LPVOID
# AsynchronousOpen : BOOL -> BOOL
# FrameworkHandle : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

WinBioAsyncOpenFramework

シグネチャ

パラメーター

公式ドキュメント

戻り値

解説(Remarks)

各言語での呼び出し定義

関連項目