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

WinBioLocateSensor

関数
ユーザー操作により対象の生体センサーを特定する。
DLLwinbio.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT WinBioLocateSensor(
    DWORD SessionHandle,
    DWORD* UnitId   // optional
);

パラメーター

名前方向説明
SessionHandleDWORDinセンサー検出に用いるセッションのハンドル。
UnitIdDWORD*outoptionalユーザーがタッチしたセンサーのユニットIDを受け取る出力ポインタ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WinBioLocateSensor(
    DWORD SessionHandle,
    DWORD* UnitId   // optional
);
[DllImport("winbio.dll", ExactSpelling = true)]
static extern int WinBioLocateSensor(
    uint SessionHandle,   // DWORD
    IntPtr UnitId   // DWORD* optional, out
);
<DllImport("winbio.dll", ExactSpelling:=True)>
Public Shared Function WinBioLocateSensor(
    SessionHandle As UInteger,   ' DWORD
    UnitId As IntPtr   ' DWORD* optional, out
) As Integer
End Function
' SessionHandle : DWORD
' UnitId : DWORD* optional, out
Declare PtrSafe Function WinBioLocateSensor Lib "winbio" ( _
    ByVal SessionHandle As Long, _
    ByVal UnitId As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WinBioLocateSensor = ctypes.windll.winbio.WinBioLocateSensor
WinBioLocateSensor.restype = ctypes.c_int
WinBioLocateSensor.argtypes = [
    wintypes.DWORD,  # SessionHandle : DWORD
    ctypes.POINTER(wintypes.DWORD),  # UnitId : DWORD* optional, out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	winbio = windows.NewLazySystemDLL("winbio.dll")
	procWinBioLocateSensor = winbio.NewProc("WinBioLocateSensor")
)

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

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

foreign import stdcall safe "WinBioLocateSensor"
  c_WinBioLocateSensor :: Word32 -> Ptr Word32 -> IO Int32
-- SessionHandle : DWORD -> Word32
-- UnitId : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let winbiolocatesensor =
  foreign "WinBioLocateSensor"
    (uint32_t @-> (ptr uint32_t) @-> returning int32_t)
(* SessionHandle : DWORD -> uint32_t *)
(* UnitId : 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 ("WinBioLocateSensor" win-bio-locate-sensor :convention :stdcall) :int32
  (session-handle :uint32)   ; DWORD
  (unit-id :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WinBioLocateSensor = Win32::API::More->new('winbio',
    'int WinBioLocateSensor(DWORD SessionHandle, LPVOID UnitId)');
# my $ret = $WinBioLocateSensor->Call($SessionHandle, $UnitId);
# SessionHandle : DWORD -> DWORD
# UnitId : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。