Fungsi CryptDestroyKey (wincrypt.h)

Artikel
08/27/2023

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 CryptDestroyKey merilis handel yang dirujuk oleh parameter hKey . Setelah handel kunci dirilis, handel tidak lagi valid dan tidak dapat digunakan lagi.

Jika handel mengacu pada kunci sesi, atau ke kunci publik yang telah diimpor ke penyedia layanan kriptografi (CSP) melalui CryptImportKey, fungsi ini menghancurkan kunci dan membebaskan memori yang digunakan kunci. Banyak CSP menimpa memori tempat kunci ditahan sebelum membebaskannya. Namun, pasangan kunci publik/privat yang mendasar tidak dihancurkan oleh fungsi ini. Hanya handel yang dihancurkan.

Sintaks

BOOL CryptDestroyKey(
  [in] HCRYPTKEY hKey
);

Parameter

[in] hKey

Handel kunci yang akan dihancurkan.

Nilai kembali

Jika fungsi berhasil, nilai yang dikembalikan bukan nol.

Jika fungsi gagal, nilai yang dikembalikan adalah nol. Untuk informasi kesalahan yang diperluas, hubungi GetLastError.

Kode kesalahan yang diawali oleh "NTE" dihasilkan oleh CSP tertentu yang digunakan. Beberapa kemungkinan kode kesalahan tercantum dalam tabel berikut.

Menampilkan kode	Deskripsi
ERROR_BUSY	Objek kunci yang ditentukan oleh hKey saat ini sedang digunakan dan tidak dapat dihancurkan.
ERROR_INVALID_HANDLE	Parameter hKey menentukan handel yang tidak valid.
ERROR_INVALID_PARAMETER	Parameter hKey berisi nilai yang tidak valid.
NTE_BAD_KEY	Parameter hKey tidak berisi handel yang valid ke kunci.
NTE_BAD_UID	Konteks CSP yang ditentukan ketika kunci dibuat tidak dapat ditemukan.

Keterangan

Kunci mengambil ruang memori sistem operasi dan ruang memori CSP. Beberapa CSP diimplementasikan dalam perangkat keras dengan sumber daya memori terbatas. Aplikasi harus menghancurkan semua kunci dengan fungsi CryptDestroyKey ketika selesai dengannya.

Semua handel kunci yang telah dibuat atau diimpor dengan menggunakan CSP tertentu harus dihancurkan sebelum handel CSP dirilis dengan fungsi CryptReleaseContext .

Contoh

Untuk contoh yang menggunakan fungsi CryptDestroyKey , lihat Contoh Program C: Membuat dan Hashing Kunci Sesi.

Persyaratan


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	Advapi32.lib
DLL	Advapi32.dll