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

[アーティクル]
08/22/2023

RetrievePending メソッドは、以前にCR_DISP_INCOMPLETEまたはCR_DISP_UNDER_SUBMISSIONを返した可能性がある以前の要求から証明書の処理状態を取得します。

結果の処理状態がCR_DISP_ISSUED場合は、 ICertRequest3::GetCertificate を呼び出して発行された証明書を取得できます。 CR_DISP_ISSUED以外の処理が返された場合は、詳細については、 ICertRequest3::GetLastStatus、 ICertRequest3::GetDispositionMessage、または両方のメソッドを呼び出します。

構文

HRESULT RetrievePending(
  [in]          LONG       RequestId,
  [in]          const BSTR strConfig,
  [out, retval] LONG       *pDisposition
);

パラメーター

[in] RequestId

以前にCR_DISP_INCOMPLETEまたはCR_DISP_UNDER_SUBMISSIONを返した要求の ID。

[in] strConfig

Certificate Services サーバーの有効な構成文字列を表します。この文字列は、登録サーバーの HTTPS URL または ComputerName\CAName 形式で指定できます。 ComputerName はサーバーのネットワーク名で、 CAName は証明書サービスのセットアップ時に入力された証明機関の共通名です。構成文字列名の詳細については、「 ICertConfig」を参照してください。

Windows Server 2008、Windows Vista、Windows Server 2003、Windows XP: HTTPS URL は入力としてサポートされていません。

[out, retval] pDisposition

要求の処理値へのポインター。

戻り値

C++

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

この関数が正常に完了すると、*pDisposition は次の表のいずれかの値に設定されます。

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

VB

戻り値は、要求の処理を指定します。処理は、次のいずれかの値です。

リターンコード	説明
CR_DISP_INCOMPLETE	要求が完了しませんでした
CR_DISP_ERROR	要求が失敗しました
CR_DISP_DENIED	要求が拒否されました
CR_DISP_ISSUED	証明書発行日
CR_DISP_ISSUED_OUT_OF_BAND	個別に発行された証明書
CR_DISP_UNDER_SUBMISSION	申請時に受け取った要求

注釈

このメソッドを正常に呼び出すと、EXITEVENT_CERTRETRIEVEPENDING イベントが生成されます。 ICertExit3::Initialize を呼び出すときに終了モジュールがこのイベントを指定した場合、アクティブな終了モジュールは (ICertExit3::Notify の呼び出しによって) このイベントの通知を受け取ります。

例

BSTR    bstrCA = NULL;
long    nReqID, nDisp;

// In this example, the request ID is hard-coded.
nReqID = 1234;

// Note use of two '\' in C++ to produce one '\'.
bstrCA = SysAllocString(L"server01\\myCAName");

// pCertRequest is previously instantiated ICertRequest
// object pointer. Retrieve the status for the specified request.
hr = pCertRequest->RetrievePending( nReqID, bstrCA, &nDisp );
if (FAILED(hr))
{
    printf("Failed RetrievePending [%x]\n", hr);
    goto error;
}
else
{
    // Use the disposition value as needed...
}
// Free BSTR resource.
if ( NULL != bstrCA )
    SysFreeString( bstrCA );

要件

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