SslOpenPrivateKey function
The SslOpenPrivateKey function opens a handle to a private key.
Syntax
SECURITY_STATUS WINAPI SslOpenPrivateKey(
_In_ NCRYPT_PROV_HANDLE hSslProvider,
_Out_ NCRYPT_KEY_HANDLE *phPrivateKey,
_In_ PCCERT_CONTEXT pCertContext,
_In_ DWORD dwFlags
);
Parameters
-
hSslProvider [in]
-
The handle to the Secure Sockets Layer protocol (SSL) protocol provider instance.
-
phPrivateKey [out]
-
The address of a buffer in which to write the handle to the private key.
When you have finished using the key, you should free phPrivateKey by calling the SslFreeObject function.
-
pCertContext [in]
-
The address of the certificate from which to obtain the private key.
-
dwFlags [in]
-
This parameter is reserved for future use.
Return value
If the function succeeds, it returns zero.
If the function fails, it returns a nonzero error value.
Possible return codes include, but are not limited to, the following.
| Return code/value | Description |
|---|---|
|
Not enough memory is available to allocate necessary buffers. |
|
The hSslProvider handle is not valid. |
|
The phPrivateKey or pCertContext parameter is NULL. |
Remarks
The private key obtained is part of a public/private key pair within a certificate. This function merely extracts the private key from the certificate specified by the pCertContext parameter.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows Vista [desktop apps only] |
| Minimum supported server |
Windows Server 2008 [desktop apps only] |
| Header |
|
| DLL |
|