ホーム › Devices.BiometricFramework › PIBIO_STORAGE_QUERY_BY_SUBJECT_FN
PIBIO_STORAGE_QUERY_BY_SUBJECT_FN
コールバックシグネチャ
HRESULT PIBIO_STORAGE_QUERY_BY_SUBJECT_FN(
WINBIO_PIPELINE* Pipeline,
WINBIO_IDENTITY* Identity,
BYTE SubFactor
);パラメーター
| フィールド | 型 | 説明 |
|---|---|---|
| Pipeline | WINBIO_PIPELINE* | 操作を実行するバイオメトリック ユニットに関連付けられた WINBIO_PIPELINE 構造体へのポインター。 |
| Identity | WINBIO_IDENTITY* | 検索対象の GUID または SID を格納する WINBIO_IDENTITY 構造体へのポインター。この構造体の Type フィールドに WINBIO_IDENTITY_TYPE_WILDCARD が格納されている場合、クエリは SubFactor パラメーターに一致するすべてのテンプレートを返します。 |
| SubFactor | BYTE | 検索対象のサブファクターを指定する WINBIO_BIOMETRIC_SUBTYPE 値。この値が WINBIO_SUBTYPE_ANY の場合、クエリは Identity パラメーターに一致するすべてのテンプレートを返します。 |
公式ドキュメント
指定された ID とサブファクターに一致するテンプレートを検索するために、Windows Biometric Framework またはエンジン アダプターによって呼び出されます。
戻り値
関数が成功した場合は S_OK を返します。関数が失敗した場合は、エラーを示すために次のいずれかの HRESULT 値を返す必要があります。
| 戻り値 | 説明 |
|---|---|
| SubFactor パラメーターで指定された引数が無効であるか、Identity パラメーターで指定された構造体のメンバーが無効です。 | |
| 必須のポインター引数が NULL です。 | |
| クエリは成功しましたが、一致するレコードが見つかりませんでした。 | |
| データベースがロックされています。 | |
| 原因不明の問題が発生しました。 | |
| パイプライン オブジェクトの StorageContext メンバーが NULL であるか、FileHandle メンバーが無効です。 |
解説(Remarks)
このメソッドが正常に戻った場合、クエリが空のセットを返したときであっても、パイプライン内の結果セットはクエリの結果で置き換えられます。
この関数の呼び出し元は、次の方法ですべてのレコードを取得できる必要があります。
- Type フィールドを WINBIO_IDENTITY_TYPE_WILDCARD に設定した WINBIO_IDENTITY 構造体を Identity パラメーターに渡す。
- SubFactor パラメーターに WINBIO_SUBTYPE_ANY を渡す。
重要
SubFactor パラメーターに指定された値を検証しようとしないでください。Windows Biometrics Service が、指定された値を実装に渡す前に検証します。値が WINBIO_SUBTYPE_NO_INFORMATION または WINBIO_SUBTYPE_ANY の場合は、必要に応じて検証してください。
例
次の擬似コードは、この関数の実装例の 1 つを示しています。この例はそのままではコンパイルできません。目的に合わせて適合させる必要があります。
/////////////////////////////////////////////////////////////////////////////////////////
//
// StorageAdapterQueryBySubject
//
// Purpose:
// Locates templates that match a specified identity and sub-factor.
//
// Parameters:
// Pipeline - Pointer to a WINBIO_PIPELINE structure associated with
// the biometric unit performing the operation.
// Identity - Pointer to a WINBIO_IDENTITY structure that contains the GUID
// or SID to be located.
// SubFactor - A WINBIO_BIOMETRIC_SUBTYPE value that specifies the sub-factor
// to be located.
//
static HRESULT
WINAPI
StorageAdapterQueryBySubject(
__inout PWINBIO_PIPELINE Pipeline,
__in PWINBIO_IDENTITY Identity,
__in WINBIO_BIOMETRIC_SUBTYPE SubFactor
)
{
HRESULT hr = S_OK;
SIZE_T recordCount = 0;
// Verify that pointer arguments are not NULL.
if (!ARGUMENT_PRESENT(Pipeline) ||
!ARGUMENT_PRESENT(Identity))
{
hr = E_POINTER;
goto cleanup;
}
// Retrieve the context from the pipeline.
PWINBIO_STORAGE_CONTEXT storageContext = (PWINBIO_STORAGE_CONTEXT)Pipeline->StorageContext;
// Verify the pipeline state.
if (storageContext == NULL || storageContext->FileHandle == INVALID_HANDLE_VALUE)
{
hr = WINBIO_E_INVALID_DEVICE_STATE;
goto cleanup;
}
// Verify the Identity argument.
if (Identity->Type != WINBIO_ID_TYPE_GUID &&
Identity->Type != WINBIO_ID_TYPE_SID &&
Identity->Type != WINBIO_ID_TYPE_WILDCARD)
{
hr = E_INVALIDARG;
goto cleanup;
}
if (Identity->Type == WINBIO_ID_TYPE_WILDCARD &&
Identity->Value.Wildcard != WINBIO_IDENTITY_WILDCARD)
{
hr = E_INVALIDARG;
goto cleanup;
}
// WINBIO_SUBTYPE_ANY is a valid sub-factor.
// WINBIO_SUBTYPE_NO_INFORMATION is not a valid sub-factor.
if (SubFactor == WINBIO_SUBTYPE_NO_INFORMATION)
{
hr = E_INVALIDARG;
goto cleanup;
}
// Call a custom function (_FindAllMatchingRecords) that compares the
// identity and sub-factor values from the caller to the identity and
// sub-factor values of every record in the database and adds the matching
// database records to the result set in the pipeline.
hr = _FindAllMatchingRecords(
Pipeline,
Identity,
SubFactor,
&recordCount
);
if (FAILED(hr))
{
goto cleanup;
}
if (recordCount == 0)
{
hr = WINBIO_E_DATABASE_NO_RESULTS;
goto cleanup;
}
cleanup:
return hr;
}
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)