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

WinBioMonitorPresence

関数
対象ユニットでの生体プレゼンスの監視を開始する。
DLLwinbio.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

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

HRESULT WinBioMonitorPresence(
    DWORD SessionHandle,
    DWORD UnitId
);

パラメーター

名前型方向説明
SessionHandleDWORDinPoolType パラメーターに WINBIO_POOL_SYSTEM を指定して WinBioAsyncOpenSession 関数を呼び出して取得した、バイオメトリック セッションの非同期ハンドルです。
UnitIdDWORDin顔認識機構または虹彩監視機構をオンにする対象のバイオメトリック ユニットの識別子です。

戻り値の型: HRESULT

公式ドキュメント

指定されたバイオメトリック ユニットの顔認識機構または虹彩監視機構をオンにします。Windows 10 ビルド 1607 以降、この関数はモバイル イメージで使用できます。

戻り値

関数のパラメーターが適切な場合は S_OK を返します。パラメーターが適切でない場合は、エラーを示す HRESULT 値を返します。
返される可能性のある値には、次の表に示すものが含まれますが、これらに限定されません。一般的なエラー コードの一覧については、「Common HRESULT Values」を参照してください。

戻り値 説明
E_HANDLE
セッション ハンドルが無効です。
E_INVALIDARG
UnitId パラメーターに 0 を指定することはできません。
WINBIO_E_INCORRECT_SESSION_TYPE
セッション ハンドルが非同期のバイオメトリック セッションに対応していません。

操作自体の実際の成否は、WINBIO_ASYNC_RESULT 構造体として通知関数に返されます。

解説(Remarks)

1 つのバイオメトリック セッションで同時にアクティブにできるプレゼンス モニターは 1 つだけです。

WinBioMonitorPresence の呼び出しに成功すると、通知関数は Operation メンバーが WINBIO_OPERATION_MONITOR_PRESENCE と等しい WINBIO_ASYNC_RESULT 構造体の形式で通知を受け取ります。詳細については、WINBIO_ASYNC_RESULT 構造体の Parameters.MonitorPresence メンバーを調べてください。

通知の受信を停止するには、元の非同期ハンドルの値を指定して WinBioCancel または WinBioCloseSession のいずれかを呼び出します。

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

各言語での呼び出し定義

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

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

WinBioMonitorPresence = ctypes.windll.winbio.WinBioMonitorPresence
WinBioMonitorPresence.restype = ctypes.c_int
WinBioMonitorPresence.argtypes = [
    wintypes.DWORD,  # SessionHandle : DWORD
    wintypes.DWORD,  # UnitId : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('winbio.dll')
WinBioMonitorPresence = Fiddle::Function.new(
  lib['WinBioMonitorPresence'],
  [
    -Fiddle::TYPE_INT,  # SessionHandle : DWORD
    -Fiddle::TYPE_INT,  # UnitId : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "winbio")]
extern "system" {
    fn WinBioMonitorPresence(
        SessionHandle: u32,  // DWORD
        UnitId: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("winbio.dll")]
public static extern int WinBioMonitorPresence(uint SessionHandle, uint UnitId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winbio_WinBioMonitorPresence' -Namespace Win32 -PassThru
# $api::WinBioMonitorPresence(SessionHandle, UnitId)
#uselib "winbio.dll"
#func global WinBioMonitorPresence "WinBioMonitorPresence" sptr, sptr
; WinBioMonitorPresence SessionHandle, UnitId   ; 戻り値は stat
; SessionHandle : DWORD -> "sptr"
; UnitId : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "winbio.dll"
#cfunc global WinBioMonitorPresence "WinBioMonitorPresence" int, int
; res = WinBioMonitorPresence(SessionHandle, UnitId)
; SessionHandle : DWORD -> "int"
; UnitId : DWORD -> "int"
; HRESULT WinBioMonitorPresence(DWORD SessionHandle, DWORD UnitId)
#uselib "winbio.dll"
#cfunc global WinBioMonitorPresence "WinBioMonitorPresence" int, int
; res = WinBioMonitorPresence(SessionHandle, UnitId)
; SessionHandle : DWORD -> "int"
; UnitId : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winbio = windows.NewLazySystemDLL("winbio.dll")
	procWinBioMonitorPresence = winbio.NewProc("WinBioMonitorPresence")
)

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

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

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

let winbiomonitorpresence =
  foreign "WinBioMonitorPresence"
    (uint32_t @-> uint32_t @-> returning int32_t)
(* SessionHandle : DWORD -> uint32_t *)
(* UnitId : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winbio (t "winbio.dll"))
(cffi:use-foreign-library winbio)

(cffi:defcfun ("WinBioMonitorPresence" win-bio-monitor-presence :convention :stdcall) :int32
  (session-handle :uint32)   ; DWORD
  (unit-id :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WinBioMonitorPresence = Win32::API::More->new('winbio',
    'int WinBioMonitorPresence(DWORD SessionHandle, DWORD UnitId)');
# my $ret = $WinBioMonitorPresence->Call($SessionHandle, $UnitId);
# SessionHandle : DWORD -> DWORD
# UnitId : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目