WinBioFree 関数 (winbio.h)

[アーティクル]
03/13/2024

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

構文

HRESULT WinBioFree(
  [in] PVOID Address
);

パラメーター

[in] Address

削除するメモリブロックのアドレス。

戻り値

関数が成功した場合は、S_OK を返します。関数が失敗した場合は、エラーを示す HRESULT 値を返します。有効な値を次の表に示しますが、これ以外にもあります。一般的なエラーコードの一覧については、「共通 HRESULT 値」を参照してください。

リターンコード	説明
E_POINTER	Address パラメーターを NULL にすることはできません。

注釈

Windows 生体認証フレームワーク API の複数の関数は、クライアントアプリケーションのメモリを割り当て、そのメモリのアドレスをクライアントに渡します。メモリリークを防ぐには、 WinBioFree を呼び出して、ブロックに含まれる情報の使用が完了したら、ブロックを削除する必要があります。メモリを削除するには、そのアドレスを WinBioFree に渡します。アドレスを見つけるには、次の各関数で適切なパラメーターで指定されたポインターを参照解除します。

機能	パラメーター	割り当てられたブロックの種類
WinBioCaptureSample	サンプル	構造体
WinBioEnumBiometricUnits	UnitSchemaArray	構造体の配列
WinBioEnumDatabases	StorageSchemaArray	構造体の配列
WinBioEnumEnrollments	SubFactorArray	整数の配列
WinBioEnumServiceProviders	BspSchemaArray	構造体の配列
EventCallBack	Event	構造体
CaptureCallback	サンプル	構造体

例

次の関数は、WinBioEnumBiometricUnits を呼び出してインストールされている生体認証センサーを列挙し、 WinBioFree を 呼び出して WinBioEnumBiometricUnits によって作成されたメモリを解放します。 Winbio.lib 静的ライブラリにリンクし、次のヘッダーファイルを含めます。

Windows.h
Stdio.h
Conio.h
Winbio.h

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

    // Enumerate the installed biometric units.
    hr = WinBioEnumBiometricUnits( 
            WINBIO_TYPE_FINGERPRINT,        // Type of biometric unit
            &unitSchema,                    // Array of unit schemas
            &unitCount );                   // Count of unit schemas

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

e_Exit:

    // Free memory.
    if (unitSchema != NULL)
    {
        WinBioFree(unitSchema);
        unitSchema = NULL;
    }

    return hr;
}

要件

要件	値
サポートされている最小のクライアント	Windows 7 [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows Server 2008 R2 [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	winbio.h (Winbio.h を含む)
Library	Winbio.lib
[DLL]	Winbio.dll