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

WinBioFree

関数
WinBio APIが割り当てたメモリを解放する。
DLLwinbio.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT WinBioFree(
    void* Address
);

パラメーター

名前型方向説明
Addressvoid*in削除するメモリブロックのアドレス。

戻り値の型: HRESULT

公式ドキュメント

以前の Windows Biometric Framework API 関数の呼び出しによってクライアントアプリケーション用に割り当てられたメモリを解放します。Windows 10 ビルド 1607 以降、この関数はモバイルイメージでも使用できます。

戻り値

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

戻り値 説明
E_POINTER
Address パラメーターを NULL にすることはできません。

解説(Remarks)

Windows Biometric Framework API の複数の関数は、クライアントアプリケーションのためにメモリを割り当て、そのメモリのアドレスをクライアントに渡します。メモリリークを防ぐため、その内容の使用を終えたら WinBioFree を呼び出してブロックを削除する必要があります。メモリを削除するには、そのアドレスを WinBioFree に渡します。アドレスは、次の各関数の該当するパラメーターで指定されたポインターを逆参照することで取得できます。

関数 パラメーター 割り当てられるブロックの種類
WinBioCaptureSample Sample 構造体
WinBioEnumBiometricUnits UnitSchemaArray 構造体の配列
WinBioEnumDatabases StorageSchemaArray 構造体の配列
WinBioEnumEnrollments SubFactorArray 整数の配列
WinBioEnumServiceProviders BspSchemaArray 構造体の配列
EventCallBack Event 構造体
CaptureCallback Sample 構造体

例

次の関数は、WinBioEnumBiometricUnits を呼び出して インストールされているバイオメトリックセンサーを列挙し、WinBioFree を呼び出して WinBioEnumBiometricUnits が作成した メモリを解放します。Winbio.lib スタティックライブラリにリンクし、次のヘッダーファイルをインクルードしてください。

HRESULT EnumerateSensors( )
{
    HRESULT hr = S_OK;
    PWINBIO_UNIT_SCHEMA unitSchema = NULL;
    SIZE_T unitCount = 0;

    // インストールされているバイオメトリックユニットを列挙します。
    hr = WinBioEnumBiometricUnits( 
            WINBIO_TYPE_FINGERPRINT,        // バイオメトリックユニットの種類
            &unitSchema,                    // ユニットスキーマの配列
            &unitCount );                   // ユニットスキーマの数

    if (FAILED(hr))
    {
        wprintf_s(L"
WinBioEnumBiometricUnits failed. hr = 0x%x
", hr);
        goto e_Exit;
    }

e_Exit:

    // メモリを解放します。
    if (unitSchema != NULL)
    {
        WinBioFree(unitSchema);
        unitSchema = NULL;
    }

    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 WinBioFree(
    void* Address
);
[DllImport("winbio.dll", ExactSpelling = true)]
static extern int WinBioFree(
    IntPtr Address   // void*
);
<DllImport("winbio.dll", ExactSpelling:=True)>
Public Shared Function WinBioFree(
    Address As IntPtr   ' void*
) As Integer
End Function
' Address : void*
Declare PtrSafe Function WinBioFree Lib "winbio" ( _
    ByVal Address As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WinBioFree = ctypes.windll.winbio.WinBioFree
WinBioFree.restype = ctypes.c_int
WinBioFree.argtypes = [
    ctypes.POINTER(None),  # Address : void*
]
require 'fiddle'
require 'fiddle/import'

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

var (
	winbio = windows.NewLazySystemDLL("winbio.dll")
	procWinBioFree = winbio.NewProc("WinBioFree")
)

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

extern "winbio" fn WinBioFree(
    Address: ?*anyopaque // void*
) callconv(std.os.windows.WINAPI) i32;
proc WinBioFree(
    Address: pointer  # void*
): int32 {.importc: "WinBioFree", stdcall, dynlib: "winbio.dll".}
pragma(lib, "winbio");
extern(Windows)
int WinBioFree(
    void* Address   // void*
);
ccall((:WinBioFree, "winbio.dll"), stdcall, Int32,
      (Ptr{Cvoid},),
      Address)
# Address : void* -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WinBioFree(
    void* Address);
]]
local winbio = ffi.load("winbio")
-- winbio.WinBioFree(Address)
-- Address : void*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('winbio.dll');
const WinBioFree = lib.func('__stdcall', 'WinBioFree', 'int32_t', ['void *']);
// WinBioFree(Address)
// Address : void* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("winbio.dll", {
  WinBioFree: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.WinBioFree(Address)
// Address : void* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WinBioFree(
    void* Address);
C, "winbio.dll");
// $ffi->WinBioFree(Address);
// Address : void*
// 構造体/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 WinBioFree(
        Pointer Address   // void*
    );
}
@[Link("winbio")]
lib Libwinbio
  fun WinBioFree = WinBioFree(
    Address : Void*   # void*
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WinBioFreeNative = Int32 Function(Pointer<Void>);
typedef WinBioFreeDart = int Function(Pointer<Void>);
final WinBioFree = DynamicLibrary.open('winbio.dll')
    .lookupFunction<WinBioFreeNative, WinBioFreeDart>('WinBioFree');
// Address : void* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WinBioFree(
  Address: Pointer   // void*
): Integer; stdcall;
  external 'winbio.dll' name 'WinBioFree';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WinBioFree"
  c_WinBioFree :: Ptr () -> IO Int32
-- Address : void* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let winbiofree =
  foreign "WinBioFree"
    ((ptr void) @-> returning int32_t)
(* Address : void* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winbio (t "winbio.dll"))
(cffi:use-foreign-library winbio)

(cffi:defcfun ("WinBioFree" win-bio-free :convention :stdcall) :int32
  (address :pointer))   ; void*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WinBioFree = Win32::API::More->new('winbio',
    'int WinBioFree(LPVOID Address)');
# my $ret = $WinBioFree->Call($Address);
# Address : void* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目