Win32 API 日本語リファレンス
ホーム › Security.Cryptography.Certificates › IX509EnrollmentStatus

IX509EnrollmentStatus

COMIDispatch (デュアル)
📘 Microsoft Learn (日本語) · English
✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IID728ab304-217d-11da-b2a4-000e7bbb2b09継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

IX509EnrollmentStatus インターフェイスは、証明書の登録(エンロール)トランザクションに関する詳細なエラー情報を指定または取得するために使用できます。

メソッド 12

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 7 HRESULT AppendText(LPWSTR strText)

Text プロパティに格納されているステータス情報に文字列を追加します。

strTextLPWSTRin追加するテキストを格納する BSTR 変数。

戻り値

関数が成功した場合は、S_OK を返します。

関数が失敗した場合は、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、Common HRESULT Values を参照してください。

vtbl 8 HRESULT get_Text(LPWSTR* pValue)

登録(エンロール)処理のステータスに関連付けられたメッセージを含む文字列を指定または取得します。(Get)

pValueLPWSTR*out登録状態の説明テキストを受け取る文字列ポインタである。

解説(Remarks)

メッセージに情報を追加するには、AppendText メソッドを呼び出すことができます。

vtbl 9 HRESULT put_Text(LPWSTR Value)

登録(エンロール)処理のステータスに関連付けられたメッセージを含む文字列を指定または取得します。(Put)

ValueLPWSTRin登録状態の説明テキストを指定する。

解説(Remarks)

メッセージに情報を追加するには、AppendText メソッドを呼び出すことができます。

vtbl 10 HRESULT get_Selected(EnrollmentSelectionStatus* pValue)

登録(エンロール)処理中に項目を使用できるかどうかを示す値を指定または取得します。(Get)

pValueEnrollmentSelectionStatus*out選択状態を受け取る EnrollmentSelectionStatus へのポインタである。

解説(Remarks)

このプロパティは現在、キーの作成に使用できる暗号化プロバイダー/アルゴリズムの組み合わせを識別するためだけに使用されます。詳細については、IX509CertificateRequestPkcs10 インターフェイスの GetCspStatuses メソッドを参照してください。

vtbl 11 HRESULT put_Selected(EnrollmentSelectionStatus Value)

登録(エンロール)処理中に項目を使用できるかどうかを示す値を指定または取得します。(Put)

ValueEnrollmentSelectionStatusin設定する選択状態を表す EnrollmentSelectionStatus である。

解説(Remarks)

このプロパティは現在、キーの作成に使用できる暗号化プロバイダー/アルゴリズムの組み合わせを識別するためだけに使用されます。詳細については、IX509CertificateRequestPkcs10 インターフェイスの GetCspStatuses メソッドを参照してください。

vtbl 12 HRESULT get_Display(EnrollmentDisplayStatus* pValue)

ステータス情報をユーザーインターフェイスに表示するかどうかを示す値を指定または取得します。(Get)

pValueEnrollmentDisplayStatus*out表示状態を受け取る EnrollmentDisplayStatus へのポインタである。

解説(Remarks)

このプロパティは、証明書の登録(エンロール)ウィザードが、関連付けられた項目を表示するかどうかを判断するために使用します。現在のところ、この値を設定しても登録(エンロール)の動作には影響しません。

vtbl 13 HRESULT put_Display(EnrollmentDisplayStatus Value)

ステータス情報をユーザーインターフェイスに表示するかどうかを示す値を指定または取得します。(Put)

ValueEnrollmentDisplayStatusin設定する表示状態を表す EnrollmentDisplayStatus である。

解説(Remarks)

このプロパティは、証明書の登録(エンロール)ウィザードが、関連付けられた項目を表示するかどうかを判断するために使用します。現在のところ、この値を設定しても登録(エンロール)の動作には影響しません。

vtbl 14 HRESULT get_Status(EnrollmentEnrollStatus* pValue)

登録(エンロール)処理のステータスを示す値を指定または取得します。(Get)

pValueEnrollmentEnrollStatus*out登録の進行状態を受け取る EnrollmentEnrollStatus へのポインタである。
vtbl 15 HRESULT put_Status(EnrollmentEnrollStatus Value)

登録(エンロール)処理のステータスを示す値を指定または取得します。(Put)

ValueEnrollmentEnrollStatusin設定する登録の進行状態を表す EnrollmentEnrollStatus である。
vtbl 16 HRESULT get_Error(HRESULT* pValue)

証明書の登録(エンロール)処理のエラーステータスを識別する値を指定および取得します。(Get)

pValueHRESULT*out登録処理のエラーコードを受け取る HRESULT へのポインタである。
vtbl 17 HRESULT put_Error(HRESULT Value)

証明書の登録(エンロール)処理のエラーステータスを識別する値を指定および取得します。(Put)

ValueHRESULTin設定するエラーコードを表す HRESULT である。
vtbl 18 HRESULT get_ErrorText(LPWSTR* pValue)

Error プロパティが返すエラー結果コードに関連付けられたメッセージを含む文字列を取得します。

pValueLPWSTR*outエラーの説明テキストを受け取る文字列ポインタである。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数: 
#define global IID_IX509EnrollmentStatus "{728AB304-217D-11DA-B2A4-000E7BBB2B09}"
#usecom global IX509EnrollmentStatus IID_IX509EnrollmentStatus "{}"
#comfunc global IX509EnrollmentStatus_AppendText     7 wstr
#comfunc global IX509EnrollmentStatus_get_Text       8 var
#comfunc global IX509EnrollmentStatus_put_Text       9 wstr
#comfunc global IX509EnrollmentStatus_get_Selected   10 var
#comfunc global IX509EnrollmentStatus_put_Selected   11 int
#comfunc global IX509EnrollmentStatus_get_Display    12 var
#comfunc global IX509EnrollmentStatus_put_Display    13 int
#comfunc global IX509EnrollmentStatus_get_Status     14 var
#comfunc global IX509EnrollmentStatus_put_Status     15 int
#comfunc global IX509EnrollmentStatus_get_Error      16 var
#comfunc global IX509EnrollmentStatus_put_Error      17 int
#comfunc global IX509EnrollmentStatus_get_ErrorText  18 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。