Fungsi WinBioSetProperty (winbio.h)

  • Artikel

Menetapkan nilai properti standar yang terkait dengan sesi biometrik, unit, templat, atau akun. Dimulai dengan Windows 10, build 1607, fungsi ini tersedia untuk digunakan dengan gambar seluler.

Sintaks

HRESULT WinBioSetProperty(
  [in]           WINBIO_SESSION_HANDLE    SessionHandle,
  [in]           WINBIO_PROPERTY_TYPE     PropertyType,
  [in]           WINBIO_PROPERTY_ID       PropertyId,
  [in, optional] WINBIO_UNIT_ID           UnitId,
  [in, optional] WINBIO_IDENTITY          *Identity,
  [in, optional] WINBIO_BIOMETRIC_SUBTYPE SubFactor,
  [in]           PVOID                    PropertyBuffer,
  [in]           SIZE_T                   PropertyBufferSize
);

Parameter

[in] SessionHandle

Nilai WINBIO_SESSION_HANDLE yang mengidentifikasi sesi biometrik terbuka. Buka handel sesi sinkron dengan memanggil WinBioOpenSession. Buka handel sesi asinkron dengan memanggil WinBioAsyncOpenSession.

[in] PropertyType

Nilai WINBIO_PROPERTY_TYPE yang menentukan jenis properti yang ingin Anda atur. Saat ini ini harus WINBIO_PROPERTY_TYPE_ACCOUNT.

[in] PropertyId

Nilai WINBIO_PROPERTY_ID yang menentukan properti yang akan diatur. Saat ini ini harus WINBIO_PROPERTY_ANTI_SPOOF_POLICY. Semua properti lainnya bersifat baca-saja.

[in, optional] UnitId

Nilai WINBIO_UNIT_ID yang mengidentifikasi unit biometrik. Untuk properti WINBIO_PROPERTY_ANTI_SPOOF_POLICY , nilai ini harus 0.

[in, optional] Identity

Alamat struktur WINBIO_IDENTITY yang menentukan akun yang ingin Anda atur propertinya.

[in, optional] SubFactor

Dicadangkan. Ini harus WINBIO_SUBTYPE_NO_INFORMATION.

[in] PropertyBuffer

Penunjuk ke struktur yang menentukan nilai baru untuk properti. Nilai ini tidak boleh NULL. Untuk mengatur properti WINBIO_PROPERTY_ANTI_SPOOF_POLICY , struktur harus merupakan struktur WINBIO_ANTI_SPOOF_POLICY .

[in] PropertyBufferSize

Ukuran, dalam byte, dari struktur yang menunjuk parameter PropertyBuffer . Nilai ini tidak boleh 0.

Mengembalikan nilai

Jika fungsi berhasil, fungsi akan mengembalikan S_OK. Jika fungsi gagal, fungsi mengembalikan nilai HRESULT yang menunjukkan kesalahan. Nilai yang mungkin termasuk, tetapi tidak terbatas pada, yang ada dalam tabel berikut. Untuk daftar kode kesalahan umum, lihat Nilai HRESULT Umum.

Menampilkan kode Deskripsi
E_HANDLE
 Handel sesi yang ditentukan oleh parameter SessionHandle tidak valid.
E_POINTER
 Parameter Identity dan PropertyBuffer tidak boleh NULL.
E_INVALIDARG
 Parameter PropertyType, PropertyId, atau PropertyBufferSize tidak boleh 0.
WINBIO_E_INVALID_PROPERTY_TYPE
 Nilai argumen PropertyType salah.
WINBIO_E_INVALID_PROPERTY_ID
 Nilai argumen PropertyId salah.
WINBIO_E_LOCK_VIOLATION
 Penelepon mencoba mengatur properti yang berada di dalam wilayah terkunci.
WINBIO_E_UNSUPPORTED_PROPERTY
 Objek tidak mendukung properti yang ditentukan.
WINBIO_E_ENROLLMENT_IN_PROGRESS
 Operasi tidak dapat diselesaikan karena unit biometrik yang ditentukan saat ini sedang digunakan untuk transaksi pendaftaran (hanya kumpulan sistem).

Keterangan

Untuk menggunakan WinBioSetProperty secara sinkron, panggil fungsi dengan handel sesi yang dibuat dengan memanggil WinBioOpenSession. Fungsi memblokir hingga operasi selesai atau terjadi kesalahan. Untuk mencegah kebocoran memori, Anda harus memanggil WinBioFree untuk merilis memori yang ditunjukkan oleh parameter PropertyBuffer ketika Anda selesai menggunakan data yang terkandung dalam buffer.

Untuk menggunakan WinBioSetProperty secara asinkron, panggil fungsi dengan handel sesi yang dibuat dengan memanggil WinBioAsyncOpenSession. Kerangka kerja mengalokasikan struktur WINBIO_ASYNC_RESULT dan menggunakannya untuk mengembalikan informasi tentang keberhasilan atau kegagalan operasi. Struktur WINBIO_ASYNC_RESULT dikembalikan ke panggilan balik aplikasi atau ke antrean pesan aplikasi, tergantung pada nilai yang Anda tetapkan dalam parameter NotificationMethod dari fungsi WinBioAsyncOpenSession :

  • Jika Anda memilih untuk menerima pemberitahuan penyelesaian dengan menggunakan panggilan balik, Anda harus menerapkan fungsi PWINBIO_ASYNC_COMPLETION_CALLBACK dan mengatur parameter NotificationMethod ke WINBIO_ASYNC_NOTIFY_CALLBACK.
  • Jika Anda memilih untuk menerima pemberitahuan penyelesaian dengan menggunakan antrean pesan aplikasi, Anda harus mengatur parameter NotificationMethod ke WINBIO_ASYNC_NOTIFY_MESSAGE. Kerangka kerja mengembalikan penunjuk WINBIO_ASYNC_RESULT ke bidang LPARAM pesan jendela.
Untuk mencegah kebocoran memori, Anda harus memanggil WinBioFree untuk merilis struktur WINBIO_ASYNC_RESULT setelah Anda selesai menggunakannya.

Persyaratan

   
Klien minimum yang didukung Windows 10 [khusus aplikasi desktop]
Server minimum yang didukung Windows Server 2016 [hanya aplikasi desktop]
Target Platform Windows
Header winbio.h
Pustaka Winbio.lib
DLL Winbio.dll

Lihat juga

WinBioFree

WinBioGetProperty