SslOpenPrivateKey, fonction

La fonction SslOpenPrivateKey ouvre un handle à une clé privée.

Syntaxe

SECURITY_STATUS WINAPI SslOpenPrivateKey(
  _In_  NCRYPT_PROV_HANDLE hSslProvider,
  _Out_ NCRYPT_KEY_HANDLE  *phPrivateKey,
  _In_  PCCERT_CONTEXT     pCertContext,
  _In_  DWORD              dwFlags
);

Paramètres

hSslProvider [in]

Handle du fournisseur de protocole SSL (Secure Sockets Layer Protocol) instance.

phPrivateKey [out]

Adresse d’une mémoire tampon dans laquelle écrire le handle dans la clé privée.

Lorsque vous avez terminé d’utiliser la clé, vous devez libérer phPrivateKey en appelant la fonction SslFreeObject .

pCertContext [in]

Adresse du certificat à partir de laquelle obtenir la clé privée.

dwFlags [in]

Ce paramètre est réservé à un usage futur.

Valeur retournée

Si la fonction réussit, elle retourne zéro.

Si la fonction échoue, elle retourne une valeur d’erreur différente de zéro.

Les codes de retour possibles incluent, sans s’y limiter, les éléments suivants.

Code/valeur de retour	Description
NTE_NO_MEMORY 0x8009000EL	La mémoire disponible est insuffisante pour allouer les mémoires tampons nécessaires.
NTE_INVALID_HANDLE 0x80090026L	Le handle hSslProvider n’est pas valide.
NTE_INVALID_PARAMETER 0x80090027L	Le paramètre phPrivateKey ou pCertContext est NULL.

Notes

La clé privée obtenue fait partie d’une paire de clés publique/privée au sein d’un certificat. Cette fonction extrait simplement la clé privée du certificat spécifié par le paramètre pCertContext .

Spécifications

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau uniquement]
En-tête	Sslprovider.h
DLL	Ncrypt.dll