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

ICspStatuses

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

公式ドキュメント

暗号化プロバイダー/アルゴリズムのペアに関する情報を格納します。(ICspStatuses)

メソッド 10

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

vtbl 7 HRESULT get_ItemByIndex(INT Index, ICspStatus** pVal)

コレクションからインデックス番号で ICspStatus オブジェクトを取得します。

IndexINTin取得する項目の 0 起点のインデックスを指定する。
pValICspStatus**out指定したインデックスの ICspStatus オブジェクトを受け取るインターフェイスポインタへのポインタである。
vtbl 8 HRESULT get_Count(INT* pVal)

コレクション内の ICspStatus オブジェクトの数を取得します。

pValINT*outコレクション内の CSP 状態数を受け取る INT へのポインタである。
vtbl 9 HRESULT get__NewEnum(IUnknown** pVal)

コレクションの列挙子を取得します。(ICspStatuses.get__NewEnum)

pValIUnknown**outコレクションを反復処理するための列挙子を受け取る IUnknown インターフェイスポインタへのポインタである。
vtbl 10 HRESULT Add(ICspStatus* pVal)

コレクションに ICspStatus オブジェクトを追加します。

pValICspStatus*inoptionalコレクションに追加する ICspStatus オブジェクトへのポインター。

戻り値

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

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

vtbl 11 HRESULT Remove(INT Index)

コレクションからインデックス番号で ICspStatus オブジェクトを削除します。

IndexINTin削除するオブジェクトのインデックスを格納する LONG 変数。

戻り値

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

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

vtbl 12 HRESULT Clear()

コレクションからすべての ICspStatus オブジェクトを削除します。

戻り値

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

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

vtbl 13 HRESULT get_ItemByName(LPWSTR strCspName, LPWSTR strAlgorithmName, ICspStatus** ppValue)

コレクションからプロバイダー名とアルゴリズム名で ICspStatus オブジェクトを取得します。

strCspNameLPWSTRin取得対象の CSP 名を指定する。
strAlgorithmNameLPWSTRin取得対象のアルゴリズム名を指定する。
ppValueICspStatus**out条件に一致する ICspStatus オブジェクトを受け取るインターフェイスポインタへのポインタである。
vtbl 14 HRESULT get_ItemByOrdinal(INT Ordinal, ICspStatus** ppValue)

コレクションから序数で ICspStatus オブジェクトを取得します。

OrdinalINTin取得対象の状態を識別する序数を指定する。
ppValueICspStatus**out指定した序数の ICspStatus オブジェクトを受け取るインターフェイスポインタへのポインタである。

解説(Remarks)

コレクション内の ICspStatus オブジェクトの序数順は、コレクションを列挙するたびに、以下を含む(ただしこれらに限定されない)さまざまな理由により変化する可能性があります。

たとえば、証明書要求を作成するために選択されたバージョン 2 テンプレートが、証明書を署名にのみ使用できる(pKIDefaultKeySpec テンプレート属性が XCN_AT_SIGNATURE である)ことと、既定のプロバイダーが Microsoft Enhanced RSA and AES Cryptographic Provider であることを指定していると仮定します。プロバイダーが暗号化アルゴリズムと署名アルゴリズムの両方をサポートしているにもかかわらず、テンプレートが証明書を署名に制限していることに注意してください。つまり、プロバイダーの KeySpec プロパティは XCN_AT_KEYEXCHANGE 定数と XCN_AT_SIGNATURE 定数のビット単位の組み合わせですが、pKIDefaultKeySpec テンプレート属性は XCN_AT_SIGNATURE のみをサポートします。

コレクション内の ICspStatus オブジェクトは、次のように順序付けられます。

別の例として、バージョン 3 テンプレートが特定の 1 つの CNG プロバイダーとアルゴリズムを指定していると仮定します。そのプロバイダー/アルゴリズムのペア(ICspStatus オブジェクト)が最初に順序付けられ、表示が有効かつ選択された状態になります。そのプロバイダーがサポートするその他すべてのアルゴリズムは後で順序付けられ、表示は有効にならず、選択もされません。指定されたアルゴリズムをサポートするその他すべてのプロバイダーはさらに後で順序付けられ、表示は有効になりますが、選択はされません。残りのすべてのプロバイダー/アルゴリズムのペアは、表示が有効にならず、選択もされません。

CNG プロバイダーは KeySpec の使用目的の概念をサポートしていません。これらはこのプロパティ値として XCN_AT_NONE を返します。

vtbl 15 HRESULT get_ItemByOperations(LPWSTR strCspName, LPWSTR strAlgorithmName, AlgorithmOperationFlags Operations, ICspStatus** ppValue)

入力で指定されたプロバイダーと同じ名前かつ同じアルゴリズムを持つが、異なる暗号化操作を識別する ICspStatus オブジェクトを取得します。

strCspNameLPWSTRin取得対象の CSP 名を指定する。
strAlgorithmNameLPWSTRin取得対象のアルゴリズム名を指定する。
OperationsAlgorithmOperationFlagsin対象とする操作を指定する AlgorithmOperationFlags である。
ppValueICspStatus**out条件に一致する ICspStatus オブジェクトを受け取るインターフェイスポインタへのポインタである。
vtbl 16 HRESULT get_ItemByProvider(ICspStatus* pCspStatus, ICspStatus** ppValue)

入力で指定されたプロバイダーと同じ名前を持つが、異なるキーの使用目的をサポートするアルゴリズムを識別する ICspStatus オブジェクトを取得します。

pCspStatusICspStatus*inoptional検索条件となる ICspStatus へのポインタである。
ppValueICspStatus**out同じプロバイダーに一致する ICspStatus オブジェクトを受け取るインターフェイスポインタへのポインタである。

解説(Remarks)

ItemByProvider プロパティは、入力プロバイダーの名前と一致するが、異なる X509KeySpec 列挙値に関連付けられた ICspStatus オブジェクトを取得します。たとえば、入力プロバイダーの KeySpec 値が XCN_AT_KEYEXCHANGE の場合、ItemByProvider プロパティは、同じプロバイダーで KeySpec 値が XCN_AT_SIGNATURE である ICspStatus オブジェクトを見つけようとします。

KeySpec プロパティはレガシプロバイダーにのみ関連付けられているため、Cryptography API: Next Generation (CNG) プロバイダーを指定した場合、ItemByProvider プロパティは入力されたものと同じ ICspStatus オブジェクトを返します。

このプロパティを使用してコレクションを反復処理するには、次の手順を実行します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ICspStatuses "{728AB30A-217D-11DA-B2A4-000E7BBB2B09}"
#usecom global ICspStatuses IID_ICspStatuses "{}"
#comfunc global ICspStatuses_get_ItemByIndex       7 int,sptr
#comfunc global ICspStatuses_get_Count             8 var
#comfunc global ICspStatuses_get__NewEnum          9 sptr
#comfunc global ICspStatuses_Add                   10 sptr
#comfunc global ICspStatuses_Remove                11 int
#comfunc global ICspStatuses_Clear                 12
#comfunc global ICspStatuses_get_ItemByName        13 wstr,wstr,sptr
#comfunc global ICspStatuses_get_ItemByOrdinal     14 int,sptr
#comfunc global ICspStatuses_get_ItemByOperations  15 wstr,wstr,int,sptr
#comfunc global ICspStatuses_get_ItemByProvider    16 sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。