Fonction BCryptQueryContextConfiguration (bcrypt.h)

Article
02/23/2024

[BCryptQueryContextConfiguration est disponible pour une utilisation dans les systèmes d’exploitation spécifiés dans la section Configuration requise. Il peut être modifié ou indisponible dans les versions suivantes.]

La fonction BCryptQueryContextConfiguration récupère la configuration actuelle pour le contexte CNG spécifié.

Syntaxe

NTSTATUS BCryptQueryContextConfiguration(
  [in]      ULONG                 dwTable,
  [in]      LPCWSTR               pszContext,
  [in, out] ULONG                 *pcbBuffer,
  [in, out] PCRYPT_CONTEXT_CONFIG *ppBuffer
);

Paramètres

[in] dwTable

Identifie la table de configuration dans laquelle le contexte existe. Il peut s’agir de l’une des valeurs suivantes.

Valeur	Signification
CRYPT_LOCAL	Le contexte existe dans la table de configuration de l’ordinateur local.
CRYPT_DOMAIN	Cette valeur n’est pas disponible pour l’utilisation.

[in] pszContext

Pointeur vers une chaîne Unicode terminée par null qui contient l’identificateur du contexte pour lequel obtenir les informations de configuration.

[in, out] pcbBuffer

Adresse d’une variable ULONG qui, lors de l’entrée, contient la taille, en octets, de la mémoire tampon pointée vers ppBuffer. Si cette taille n’est pas suffisante pour contenir les informations de contexte, cette fonction échoue avec STATUS_BUFFER_TOO_SMALL.

Une fois cette fonction retournée, cette variable contient le nombre d’octets qui ont été copiés dans la mémoire tampon ppBuffer .

[in, out] ppBuffer

Adresse d’un pointeur vers une structure CRYPT_CONTEXT_CONFIG qui reçoit les informations de configuration de contexte récupérées par cette fonction. La valeur indiquée par le paramètre pcbBuffer contient la taille de cette mémoire tampon.

Si la valeur pointée par ce paramètre est NULL, cette fonction alloue la mémoire requise. Cette mémoire doit être libérée lorsqu’elle n’est plus nécessaire en passant ce pointeur vers la fonction BCryptFreeBuffer .

Si ce paramètre a la valeur NULL, cette fonction place la taille requise, en octets, dans la variable pointée par le paramètre pcbBuffer et retourne STATUS_BUFFER_TOO_SMALL.

Pour plus d’informations sur l’utilisation de ce paramètre, consultez Remarques.

Valeur retournée

Retourne un code status qui indique la réussite ou l’échec de la fonction.

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

Code de retour	Description
STATUS_SUCCESS	La fonction a réussi.
STATUS_BUFFER_TOO_SMALL	Le paramètre ppBuffer n’est pas NULL et la valeur pointée par le paramètre pcbBuffer n’est pas assez grande pour contenir l’ensemble de contextes.
STATUS_INVALID_PARAMETER	Un ou plusieurs paramètres ne sont pas valides.
STATUS_NO_MEMORY	Un échec d’allocation de mémoire s’est produit.
STATUS_NOT_FOUND	Le contexte spécifié est introuvable.

Remarques

Chaque contexte n’a qu’un seul ensemble d’informations de configuration. Par conséquent, bien que le paramètre ppBuffer semble être utilisé en tant que tableau, cette fonction le traite comme un tableau avec un seul élément. L’exemple suivant permet de clarifier la façon dont ce paramètre est utilisé.

// Get the configuration information for the context.
CRYPT_CONTEXT_CONFIG config;
ULONG uSize = sizeof(config);
PCRYPT_CONTEXT_CONFIG pConfig = &config;
status = BCryptQueryContextConfiguration(
    CRYPT_LOCAL, 
    pszContextID, 
    &uSize, 
    &pConfig);

BCryptQueryContextConfiguration peut être appelé uniquement en mode utilisateur.

Configuration requise

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]
Plateforme cible	Windows
En-tête	bcrypt.h
Bibliothèque	Bcrypt.lib
DLL	Bcrypt.dll

Share via