Fungsi CryptGetUserKey (wincrypt.h)

  • Artikel
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 CryptGetUserKey mengambil handel dari salah satu dari dua pasangan kunci publik/privat pengguna. Fungsi ini hanya digunakan oleh pemilik pasangan kunci publik/privat dan hanya ketika handel penyedia layanan kriptografi (CSP) dan kontainer kunci terkait tersedia. Jika handel CSP tidak tersedia dan sertifikat pengguna, gunakan CryptAcquireCertificatePrivateKey.

Sintaks

BOOL CryptGetUserKey(
  [in]  HCRYPTPROV hProv,
  [in]  DWORD      dwKeySpec,
  [out] HCRYPTKEY  *phUserKey
);

Parameter

[in] hProv

Handel HCRYPTPROV dari penyedia layanan kriptografi (CSP) yang dibuat oleh panggilan ke CryptAcquireContext.

[in] dwKeySpec

Mengidentifikasi kunci privat yang akan digunakan dari kontainer kunci. Ini bisa AT_KEYEXCHANGE atau AT_SIGNATURE.

Selain itu, beberapa penyedia mengizinkan akses ke kunci khusus pengguna lainnya melalui fungsi ini. Untuk detailnya, lihat dokumentasi tentang penyedia tertentu.

[out] phUserKey

Penunjuk ke handel HCRYPTKEY dari kunci yang diambil. Setelah Anda selesai menggunakan kunci, hapus handel dengan memanggil fungsi CryptDestroyKey .

Mengembalikan nilai

Jika fungsi berhasil, nilai yang dikembalikan bukan nol (TRUE).

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

Kode kesalahan yang diawali oleh "NTE" dihasilkan oleh CSP tertentu yang digunakan. Beberapa kemungkinan kode kesalahan mengikuti.

Menampilkan kode Deskripsi
ERROR_INVALID_HANDLE
 Salah satu parameter menentukan handel yang tidak valid.
ERROR_INVALID_PARAMETER
 Salah satu parameter berisi nilai yang tidak valid. Ini paling sering merupakan pointer yang tidak valid.
NTE_BAD_KEY
 Parameter dwKeySpec berisi nilai yang tidak valid.
NTE_BAD_UID
 Parameter hProv tidak berisi handel konteks yang valid.
NTE_NO_KEY
 Kunci yang diminta oleh parameter dwKeySpec tidak ada.

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

Lihat juga

CryptAcquireContext

CryptDestroyKey

CryptGenKey

Pembuatan Kunci dan Fungsi Exchange