CPGetUserKey

The CPGetUserKey function retrieves a handle to one of the permanent key pairs in the hProv key container, such as the key exchange key pair.

BOOL CPGetUserKey(
  HCRYPTPROV hProv,     // in
  DWORD dwKeySpec,      // in
  HCRYPTKEY *phUserKey  // out
);
 

Parameters

hProv

Handle to a particular key container (or "context") within the CSP. This handle is obtained via a call to CPAcquireContext.

dwKeySpec

Specification of the key to retrieve. The following key pair types are currently defined:

• AT_KEYEXCHANGE—key exchange key pair
• AT_SIGNATURE—digital signature key pair

phUserKey

Address to which the function copies the handle of the retrieved key.

Return Values

If the function succeeds, TRUE should be returned; otherwise, return FALSE. When FALSE is returned, the appropriate error code (see the following table) must be set via SetLastError.

See Also

CPExportKey, CPGenKey, CryptGetUserKey