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

Artigo
08/22/2023

O método GetDispositionMessage obtém uma mensagem legível por humanos que fornece a disposição atual da solicitação de certificado.

Observe que a mensagem retornada aqui pode ter mais detalhes do que o código de erro retornado. Por exemplo, ICertRequest3::GetLastStatus pode retornar um HRESULT, enquanto GetDispositionMessage retornará um motivo detalhado que especifica por que a solicitação foi negada.

Sintaxe

HRESULT GetDispositionMessage(
  [out] BSTR *pstrDispositionMessage
);

Parâmetros

[out] pstrDispositionMessage

Um ponteiro para o BSTR que contém a mensagem de disposição.

Retornar valor

C++

Se o método for bem-sucedido, o método retornará S_OK.

Após a conclusão bem-sucedida dessa função, *pstrDispositionMessage é definido como o BSTR que contém uma mensagem legível por humanos que fornece a disposição atual da solicitação de certificado. Para usar esse método, crie uma variável do tipo BSTR , defina a variável igual a NULL e passe o endereço dessa variável como pstrDispositionMessage. Quando terminar de usar o BSTR, libere-o chamando a função SysFreeString .

Se o método falhar, ele retornará um valor HRESULT que indica o erro. Para obter uma lista de códigos de erro comuns, consulte Valores HRESULT comuns.

VB

O valor retornado é uma cadeia de caracteres que contém uma mensagem legível por humanos que fornece a disposição atual da solicitação de certificado.

Comentários

Um aplicativo chamaria esse método para obter a mensagem recuperada do servidor por meio de uma chamada anterior para ICertRequest3::Submit ou ICertRequest3::RetrievePending. Além disso, a mensagem é armazenada no banco de dados dos Serviços de Certificados e pode ser exibida pelo snap-in MMC da Autoridade de Certificação (escolha a coluna Solicitar Mensagem de Disposição). Se a mensagem contiver texto localizado, ela foi localizada no servidor (com base na localidade do servidor).

Exemplos

#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);

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	certcli.h (inclua Certsrv.h)
Biblioteca	Certidl.lib
DLL	Certcli.dll