Fungsi CryptEnumKeyIdentifierProperties (wincrypt.h)

Penting API ini tidak digunakan lagi. Perangkat lunak baru dan yang sudah ada harus mulai menggunakan Cryptography Next Generation API. Microsoft dapat menghapus API ini dalam rilis mendatang.

 

Fungsi CryptEnumKeyIdentifierProperties menghitung pengidentifikasi kunci dan propertinya. Fungsi ini tidak dipanggil dalam perulangan. Sebaliknya, ia mengulang secara internal sampai properti pengidentifikasi kunci terakhir dijumlahkan atau fungsi panggilan balik mengembalikan FALSE. Jika dwPropId adalah nol atau jika properti pengidentifikasi kunci cocok dengan dwPropId, fungsi panggilan balik dipanggil.

Sintaks

BOOL CryptEnumKeyIdentifierProperties(
  [in, optional] const CRYPT_HASH_BLOB     *pKeyIdentifier,
  [in]           DWORD                     dwPropId,
  [in]           DWORD                     dwFlags,
  [in, optional] LPCWSTR                   pwszComputerName,
  [in]           void                      *pvReserved,
  [in, optional] void                      *pvArg,
  [in]           PFN_CRYPT_ENUM_KEYID_PROP pfnEnum
);

Parameter

[in, optional] pKeyIdentifier

Penunjuk ke struktur CRYPT_HASH_BLOB yang berisi pengidentifikasi kunci.

Jika pKeyIdentifier adalah NULL, fungsi menghitung semua pengidentifikasi kunci.

Jika pKeyIdentifier bukan NULL, fungsi panggilan balik pfnEnum hanya dipanggil untuk pengidentifikasi kunci yang ditentukan.

[in] dwPropId

Menunjukkan pengidentifikasi properti yang akan dicantumkan.

Jika dwPropId diatur ke nol, fungsi ini memanggil fungsi panggilan balik dengan semua properti.

Jika dwPropId bukan nol dan pKeyIdentifier adalah NULL, fungsi panggilan balik hanya dipanggil untuk pengidentifikasi kunci yang memiliki properti yang ditentukan (mengatur parameter cProppfnEnum ke satu). Semua pengidentifikasi kunci yang tidak memiliki properti dilewati.

Pengidentifikasi properti sertifikat apa pun dapat digunakan.

[in] dwFlags

Secara default, daftar pengidentifikasi kunci untuk CurrentUser dicari. Jika CRYPT_KEYID_MACHINE_FLAG diatur, daftar pengidentifikasi kunci LocalMachine (jika pwszComputerName adalah NULL) atau komputer jarak jauh (jika pwszComputerName bukan NULL) dicari. Untuk informasi selengkapnya, lihat pwszComputerName.

[in, optional] pwszComputerName

Penunjuk ke nama komputer jarak jauh yang akan dicari. Jika CRYPT_KEYID_MACHINE_FLAG diatur dalam dwFlags, komputer jarak jauh dicari untuk daftar pengidentifikasi kunci. Jika komputer lokal akan dicari dan bukan komputer jarak jauh, pwszComputerName diatur ke NULL.

[in] pvReserved

Dicadangkan untuk digunakan di masa mendatang dan harus NULL.

[in, optional] pvArg

Penunjuk ke data yang akan diteruskan ke fungsi panggilan balik. Jenisnya adalah kekosongan yang memungkinkan aplikasi untuk mendeklarasikan, menentukan, dan menginisialisasi struktur atau argumen untuk menyimpan informasi apa pun.

[in] pfnEnum

Penunjuk ke fungsi panggilan balik yang ditentukan aplikasi yang dijalankan untuk setiap entri pengidentifikasi kunci yang cocok dengan parameter input. Untuk detail tentang parameter fungsi panggilan balik, lihat CRYPT_ENUM_KEYID_PROP.

Mengembalikan nilai

Fungsi CryptEnumKeyIdentifierProperties berulang kali memanggil fungsi panggilan balik CRYPT_ENUM_KEYID_PROP hingga pengidentifikasi kunci terakhir dijumlahkan atau fungsi panggilan balik mengembalikan FALSE.

Jika fungsi utama berhasil, fungsi mengembalikan bukan nol (TRUE).

Jika fungsi gagal, fungsi mengembalikan nol (FALSE). Untuk informasi kesalahan yang diperluas, hubungi GetLastError.

Untuk melanjutkan enumerasi, fungsi mengembalikan TRUE.

Untuk menghentikan enumerasi, fungsi mengembalikan FALSE dan mengatur kode kesalahan terakhir.

Keterangan

Pengidentifikasi kunci dapat memiliki properti yang sama dengan konteks sertifikat.

Contoh

Untuk contoh yang menggunakan fungsi ini, lihat Contoh Program C: Bekerja dengan Pengidentifikasi Kunci.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows XP [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2003 [hanya aplikasi desktop]
Target Platform	Windows
Header	wincrypt.h
Pustaka	Crypt32.lib
DLL	Crypt32.dll

Lihat juga

Fungsi Kriptografi Dasar

CryptGetKeyIdentifierProperty

CryptSetKeyIdentifierProperty