ICertRequest::GetDispositionMessage メソッド (certcli.h)

[アーティクル]
02/23/2024

GetDispositionMessage メソッドは、証明書要求の現在の処理を示す人間が判読できるメッセージを取得します。

ここで返されるメッセージの詳細は、返されたエラーコードよりも多くの場合があることに注意してください。たとえば、 ICertRequest3::GetLastStatus は HRESULT を返しますが、 GetDispositionMessage は要求が拒否された理由を指定する詳細な理由を返します。

構文

HRESULT GetDispositionMessage(
  [out] BSTR *pstrDispositionMessage
);

パラメーター

[out] pstrDispositionMessage

処理メッセージを含む BSTR へのポインター。

戻り値

C++

メソッドが成功した場合、メソッドは S_OKを返します。

この関数が正常に完了すると、*pstrDispositionMessage は、証明書要求の現在の処理を示す人間が判読できるメッセージを含む BSTR に設定されます。このメソッドを使用するには、 BSTR 型の変数を作成し、変数を NULL に設定し、この変数のアドレス を pstrDispositionMessage として渡します。 BSTR の使用が完了したら、SysFreeString 関数を呼び出して解放します。

メソッドが失敗した場合は、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、「共通 HRESULT 値」を参照してください。

VB

戻り値は、証明書要求の現在の処理を示す人間が判読できるメッセージを含む文字列です。

注釈

アプリケーションはこのメソッドを呼び出して、ICertRequest3::Submit または ICertRequest3::RetrievePending の以前の呼び出しによってサーバーから取得されたメッセージを取得します。さらに、メッセージは証明書サービスデータベースに格納され、証明機関 MMC スナップインによって表示される場合があります ([処理メッセージの要求] 列を選択します)。メッセージにローカライズされたテキストが含まれている場合は、サーバーにローカライズされました (サーバーのロケールに基づきます)。

例

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

要件

要件	値
サポートされている最小のクライアント	Windows XP (デスクトップアプリのみ)
サポートされている最小のサーバー	Windows Server 2003 (デスクトップアプリのみ)
対象プラットフォーム	Windows
ヘッダー	certcli.h (Certsrv.h を含む)
Library	Certidl.lib
[DLL]	Certcli.dll