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

WinBioLogonIdentifiedUser

関数
生体認証で識別された利用者のログオンを実行する。
DLLwinbio.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT WinBioLogonIdentifiedUser(
    DWORD SessionHandle
);

パラメーター

名前型方向説明
SessionHandleDWORDin直前に識別操作に成功した生体認証セッションを識別する WINBIO_SESSION_HANDLE 値。セッションハンドルは WinBioOpenSession を呼び出して開きます。

戻り値の型: HRESULT

公式ドキュメント

生体認証セッションが最後に成功した識別操作に関連付けられているアカウントへ、ユーザーの簡易切り替え (fast user switching) を行います。

戻り値

関数が成功すると S_OK を返します。関数が失敗すると、エラーを示す HRESULT 値を返します。取り得る値には次の表の値が含まれますが、これらに限定されません。一般的なエラーコードの一覧については、Common HRESULT Values を参照してください。

戻り値 説明
E_ACCESSDENIED
呼び出し元にユーザーを切り替える権限がないか、生体認証セッションが古くなっています。
E_HANDLE
セッションハンドルが有効ではありません。
S_FALSE
SessionHandle パラメーターで識別されたユーザーが、現在のユーザーと同じです。
SEC_E_LOGON_DENIED
ユーザーをログオンできませんでした。
WINBIO_E_CRED_PROV_DISABLED
現在の管理ポリシーにより、資格情報プロバイダーの使用が禁止されています。
WINBIO_E_FAST_USER_SWITCH_DISABLED
ユーザーの簡易切り替えが有効になっていません。
WINBIO_E_SAS_ENABLED
セキュリティで保護されたログオン (CTRL+ALT+DELETE) が現在有効になっているため、ユーザーの簡易切り替えを実行できません。

解説(Remarks)

WinBioLogonIdentifiedUser 関数は通常、ユーザーの簡易切り替えをサポートするアプリケーションが、現在ログオンしているユーザー以外のユーザーを識別したときに呼び出します。

ユーザーの簡易切り替えを試みると、セキュリティログにログオンイベントが残ることがありますが、資格情報マネージャーが終了しても ID が自動的に保存されることはありません。

SessionHandle パラメーターで指定した生体認証セッションが、ユーザーの簡易切り替えイベントの対象アカウントを制御します。そのハンドルが直前に識別操作の実行に使用されていた場合、その結果として得られた ID がユーザーの簡易切り替え後にログオンされます。

セキュリティ上の理由から、Windows Biometric Framework は識別操作と WinBioLogonIdentifiedUser の呼び出しが短時間のうちに行われることを要求します。その期間を過ぎると識別は古いものと見なされ、WinBioLogonIdentifiedUser の呼び出しは失敗します。既定のタイムアウト間隔は 5 秒ですが、管理者は最大 60 秒まで延長できます。

対象ユーザーが現在のユーザーと同じ場合にこの関数を呼び出すと、S_FALSE が返され、ユーザーの簡易切り替えの試行は無視されます。

例

次の関数は、あらかじめ識別されたユーザーをログオンさせるために WinBioLogonIdentifiedUser を呼び出します。この関数が正しく動作するには、セキュリティで保護されたログオンが有効になっていない必要があります。Winbio.lib 静的ライブラリをリンクし、次のヘッダーファイルをインクルードしてください。

HRESULT LogonIdentifiedUser()
{
    // 変数を宣言します。
    HRESULT hr;
    WINBIO_SESSION_HANDLE sessionHandle = NULL;
    WINBIO_UNIT_ID  UnitId;
    WINBIO_IDENTITY Identity;
    WINBIO_BIOMETRIC_SUBTYPE SubFactor;
    WINBIO_REJECT_DETAIL RejectDetail;
    BOOL    bContinue = TRUE;

    // システムプールに接続します。
    hr = WinBioOpenSession( 
            WINBIO_TYPE_FINGERPRINT,    // サービスプロバイダー
            WINBIO_POOL_SYSTEM,         // プールの種類
            WINBIO_FLAG_DEFAULT,        // 構成とアクセス
            NULL,                       // 生体認証ユニット ID の配列
            0,                          // 生体認証ユニット ID の数
            WINBIO_DB_DEFAULT,                       // データベース ID
            &sessionHandle              // [out] セッションハンドル
            );
    if (FAILED(hr))
    {
        wprintf_s(L"
 WinBioOpenSession failed. hr = 0x%x
", hr);
        goto e_Exit;
    }

    // 生体認証センサーを特定し、WINBIO_IDENTITY オブジェクトを取得します。
    // センサー上で指をスワイプする必要があります。
    wprintf_s(L"
 Calling WinBioIdentify - Swipe finger on sensor...
");
    while(bContinue)
    {
        hr = WinBioIdentify(
                sessionHandle,          // セッションハンドル
                &UnitId,                // 生体認証ユニット ID
                &Identity,              // ユーザーの SID または GUID
                &SubFactor,             // 指のサブファクター
                &RejectDetail           // 拒否情報
                );

        switch(hr)
        {
        case S_OK:
            bContinue = FALSE;
            break;
        default:
            wprintf_s(L"
 WinBioIdentify failed. hr = 0x%x
", hr);
            break;
        }
    }

    if (SUCCEEDED(hr))
    {
        // 有効な ID を受け取った後、対象ユーザーに切り替えます。
        hr = WinBioLogonIdentifiedUser(sessionHandle);

        switch(hr)
        {
        case S_FALSE:
            printf("
 Target is the logged on user. No action taken.
");
            break;
        case S_OK:
            printf("
 Fast user switch initiated.
");
            break;
        default:
            wprintf_s(L"
 WinBioLogonIdentifiedUser failed. hr = 0x%x
", hr);
            break;
        }
    }

e_Exit:

    if (sessionHandle != NULL)
    {
        WinBioCloseSession(sessionHandle);
        sessionHandle = NULL;
    }

    wprintf_s(L"
 Press any key to exit...");
    _getch();

    return hr;
}

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

各言語での呼び出し定義

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

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

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

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

var (
	winbio = windows.NewLazySystemDLL("winbio.dll")
	procWinBioLogonIdentifiedUser = winbio.NewProc("WinBioLogonIdentifiedUser")
)

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

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

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

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

関連項目

公式の関連項目