Méthode ICertRequest ::GetDispositionMessage (certcli.h)

Article
02/26/2024

La méthode GetDispositionMessage obtient un message lisible par l’homme qui donne la disposition actuelle de la demande de certificat.

Notez que le message retourné ici peut avoir plus de détails que le code d’erreur retourné. Par exemple, ICertRequest3 ::GetLastStatus peut retourner un HRESULT, tandis que GetDispositionMessage renvoie une raison détaillée qui spécifie la raison pour laquelle la demande a été refusée.

Syntaxe

HRESULT GetDispositionMessage(
  [out] BSTR *pstrDispositionMessage
);

Paramètres

[out] pstrDispositionMessage

Pointeur vers le BSTR qui contient le message de disposition.

Valeur retournée

C++

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

Une fois cette fonction terminée, *pstrDispositionMessage est défini sur le BSTR qui contient un message lisible par l’homme qui donne la disposition actuelle de la demande de certificat. Pour utiliser cette méthode, créez une variable de type BSTR , définissez la variable sur NULL et transmettez l’adresse de cette variable en tant que pstrDispositionMessage. Lorsque vous avez terminé d’utiliser le BSTR, libérez-le en appelant la fonction SysFreeString .

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 contient un message lisible par l’homme qui donne la disposition actuelle de la demande de certificat.

Remarques

Une application appelle cette méthode pour obtenir le message récupéré à partir du serveur au moyen d’un appel antérieur à ICertRequest3 ::Submit ou ICertRequest3 ::RetrievePending. En outre, le message est stocké dans la base de données Des services de certificats et peut être consulté par le composant logiciel enfichable MMC Autorité de certification (choisissez la colonne Message de suppression de la demande). Si le message contient du texte localisé, il a été localisé sur le serveur (en fonction des paramètres régionaux du serveur).

Exemples

#include <windows.h>
#include <stdio.h>
#include <Certcli.h>

    BSTR    bstrDispMsg = NULL;
    // pCertRequest is previously instantiated ICertRequest object 
    // pointer. Retrieve the disposition message for the 
    // previous request.
    hr = pCertRequest->GetDispositionMessage(&bstrDispMsg);
    if (FAILED(hr))
    {
        printf("Failed GetDispositionMessage [%x]\n", hr);
        goto error;
    }
    else
    {
        // Use the disposition message as needed...
    }

    // Done processing.

error:

    // Free BSTR values.
    if (NULL != bstrCA)
        SysFreeString(bstrCA);

    if (NULL != bstrDispMsg)
        SysFreeString(bstrDispMsg);

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows XP [applications de bureau uniquement]
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