nf-certcli-icertrequest-getdispositionmessage.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:certcli.ICertRequest.GetDispositionMessage	ICertRequest::GetDispositionMessage (certcli.h)	Gets a human-readable message that gives the current disposition of the certificate request.	CCertRequest object [Security] GetDispositionMessage method GetDispositionMessage GetDispositionMessage method [Security] GetDispositionMessage method [Security] CCertRequest object GetDispositionMessage method [Security] ICertRequest interface GetDispositionMessage method [Security] ICertRequest2 interface GetDispositionMessage method [Security] ICertRequest3 interface ICertRequest interface [Security] GetDispositionMessage method ICertRequest.GetDispositionMessage ICertRequest2 interface [Security] GetDispositionMessage method ICertRequest2::GetDispositionMessage ICertRequest3 interface [Security] GetDispositionMessage method ICertRequest3::GetDispositionMessage ICertRequest::GetDispositionMessage certcli/ICertRequest2::GetDispositionMessage certcli/ICertRequest3::GetDispositionMessage certcli/ICertRequest::GetDispositionMessage security.icertrequest2_getdispositionmessage	security\icertrequest2_getdispositionmessage.htm	security	c3639cf6-c70f-4f15-a0ed-e60abe2955cb	12/05/2018	CCertRequest object [Security],GetDispositionMessage method, GetDispositionMessage, GetDispositionMessage method [Security], GetDispositionMessage method [Security],CCertRequest object, GetDispositionMessage method [Security],ICertRequest interface, GetDispositionMessage method [Security],ICertRequest2 interface, GetDispositionMessage method [Security],ICertRequest3 interface, ICertRequest interface [Security],GetDispositionMessage method, ICertRequest.GetDispositionMessage, ICertRequest2 interface [Security],GetDispositionMessage method, ICertRequest2::GetDispositionMessage, ICertRequest3 interface [Security],GetDispositionMessage method, ICertRequest3::GetDispositionMessage, ICertRequest::GetDispositionMessage, certcli/ICertRequest2::GetDispositionMessage, certcli/ICertRequest3::GetDispositionMessage, certcli/ICertRequest::GetDispositionMessage, security.icertrequest2_getdispositionmessage	certcli.h	Certsrv.h	Windows	Windows XP [desktop apps only]	Windows Server 2003 [desktop apps only]										Certidl.lib	Certcli.dll		Windows			19H1	ICertRequest::GetDispositionMessage certcli/ICertRequest::GetDispositionMessage	c++	APIRef kbSyntax	COM	Certcli.dll	ICertRequest3.GetDispositionMessage ICertRequest2.GetDispositionMessage ICertRequest.GetDispositionMessage CCertRequest.GetDispositionMessage

ICertRequest::GetDispositionMessage

-description

The GetDispositionMessage method gets a human-readable message that gives the current disposition of the certificate request.

Note that the message returned here may have more detail than the returned error code. For example, ICertRequest3::GetLastStatus may return an HRESULT, while GetDispositionMessage will return a detailed reason that specifies why the request was denied.

-parameters

-param pstrDispositionMessage [out]

A pointer to the BSTR that contains the disposition message.

-returns

C++

If the method succeeds, the method returns S_OK.

Upon successful completion of this function, *pstrDispositionMessage is set to the BSTR that contains a human-readable message that gives the current disposition of the certificate request. To use this method, create a variable of BSTR type, set the variable equal to NULL, and pass the address of this variable as pstrDispositionMessage. When you have finished using the BSTR, free it by calling the SysFreeString function.

If the method fails, it returns an HRESULT value that indicates the error. For a list of common error codes, see Common HRESULT Values.

VB

The return value is a string that contains a human-readable message that gives the current disposition of the certificate request.

-remarks

An application would call this method to obtain the message retrieved from the server by means of an earlier call to ICertRequest3::Submit or ICertRequest3::RetrievePending. Additionally, the message is stored in the Certificate Services database and may be viewed by the Certification Authority MMC snap-in (choose the Request Disposition Message column). If the message contains localized text, it was localized on the server (based on the server's locale).

Examples

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

-see-also

CCertRequest

ICertRequest

ICertRequest2

ICertRequest3