Méthode ICertConfig ::GetField (certcli.h)

Article
08/22/2023

La méthode GetField obtient un champ spécifique à partir de l’enregistrement actif de la base de données de configuration. Cette méthode a d’abord été définie dans l’interface ICertConfig .

Syntaxe

HRESULT GetField(
  [in]          const BSTR strFieldName,
  [out, retval] BSTR       *pstrOut
);

Paramètres

[in] strFieldName

Spécifie le nom du champ à retourner. Ce paramètre peut être l’une des chaînes valides suivantes pour les noms de champs (notez que certaines autorités de certification peuvent ne pas fournir de données pour chaque champ).

Valeur	Signification
Authority	Référencer le nom de l’autorité de certification.
CommonName	Nom commun du serveur.
Config	Ordinateur de référence\nom de l’autorité de certification.
Pays	Pays/Région.
Description	Commentaire descriptif sur le serveur (remplace l’obsolète « Commentaire »).
Exchangecertificate	Nom du fichier qui contient le certificat exchange (s’applique aux services de certificats 1.0 uniquement).
Indicateurs	Chaîne qui représente l’emplacement où les informations de l’autorité de certification ont été trouvées. Pour plus d'informations, consultez la section Notes.
Localité	Ville ou ville.
Organisation	Organisation.
OrgUnit	Unité d’organisation.
SanitizedName	Nom de l’autorité de certification qui est nettoyé conformément aux règles décrites dans GetConfig.
SanitizedShortName	Nom de l’autorité de certification qui est nettoyé et raccourci selon les règles décrites dans GetConfig.
Serveur	Nom de l’ordinateur de référence.
NomCourt	SanitizedShortName, mais avec les séquences « !xxx », comme décrit dans GetConfig, traduites dans le texte d’origine.
SignatureCertificate	Nom du fichier qui contient le certificat d’autorité de certification (également appelé certificat de signature d’autorité de certification) ; il peut s’agir ou non d’un certificat racine.
State	État ou province.
WebEnrollmentServers	Tableau d’URL de service web d’inscription de certificat pour une configuration d’autorité de certification spécifique dans Active Directory. Windows Vista et Windows Storage Server 2003 : Ce champ n’est pas pris en charge.

[out, retval] pstrOut

Pointeur vers un BSTR qui reçoit les données du champ. Lorsque vous avez terminé d’utiliser le BSTR, libérez pbstrOut en appelant la fonction SysFreeString .

Valeur retournée

C++

Si la méthode réussit, la méthode retourne S_OK.

Si la méthode échoue, elle retourne une valeur HRESULT qui indique l’erreur. Pour obtenir la liste des codes d’erreur courants, consultez Valeurs HRESULT courantes.

VB

La valeur de retour est une chaîne qui représente les données du champ.

Remarques

Cette méthode retourne les données de champ pour le champ spécifié.

Lorsque vous spécifiez « Flags » dans le paramètre strFieldName , les données récupérées pour le champ d’indicateurs sont une chaîne qui peut être convertie en entier au moyen de la fonction C-library _wtoi. L’entier résultant représente un champ de bits qui peut être examiné pour déterminer si les indicateurs CAIF_DSENTRY et CAIF_SHAREDFOLDERENTRY sont définis. Si CAIF_DSENTRY (0x00000001) est défini, les informations relatives à l’autorité de certification étaient contenues dans les services d’annuaire. Si CAIF_SHAREDFOLDERENTRY (0x00000002) est défini, les informations relatives à l’autorité de certification étaient contenues dans le dossier partagé. Notez que l’un de ces indicateurs ou les deux peuvent être définis.

Exemples

    BSTR  bstrFieldName = NULL;
    BSTR  bstrFieldValue = NULL;
    HRESULT    hr;

    // Specify the field to retrieve, for example, "CommonName".
    bstrFieldName = SysAllocString(L"<FIELDNAMEHERE>");
    if (NULL == bstrFieldName)
    {
        printf("Memory allocation failed for bstrFieldName.\n");
        goto error;
    }

    // pConfig is a previously instantiated ICertConfig object.
    hr = pConfig->GetField(bstrFieldName, &bstrFieldValue);
    if (FAILED(hr))
    {
        printf("Failed GetField - [%x]\n", hr);
        goto error;
    }
    else
        printf("GetField value for %ws is: %ws\n", 
            bstrFieldName, bstrFieldValue );

error:

    if (bstrFieldName)
        SysFreeString(bstrFieldName);

    if (bstrFieldValue)
        SysFreeString(bstrFieldValue);

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Aucun pris en charge
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	certcli.h (include Certsrv.h)
Bibliothèque	Certidl.lib
DLL	Certcli.dll

Voir aussi

CCertConfig

ICertConfig

Partager via