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

ICertProperties

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

公式ドキュメント

証明書プロパティのコレクションを管理するためのメソッドとプロパティを提供します。

メソッド 7

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

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

インデックス番号を指定して、コレクションからプロパティを取得します。

IndexINTin取得する証明書プロパティのコレクション内での 0 始まりのインデックスを指定する。
pValICertProperty**out指定インデックスの ICertProperty オブジェクトへのポインタを受け取る出力先である。
vtbl 8 HRESULT get_Count(INT* pVal)

コレクション内のプロパティの数を取得します。

pValINT*outコレクションに含まれる証明書プロパティの個数を受け取る出力先である。
vtbl 9 HRESULT get__NewEnum(IUnknown** pVal)

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

pValIUnknown**outコレクションを列挙するための IEnumVARIANT 列挙子の IUnknown ポインタを受け取る出力先である。
vtbl 10 HRESULT Add(ICertProperty* pVal)

コレクションにプロパティを追加します。

pValICertProperty*inoptionalコレクションに追加するプロパティを表す ICertProperty インターフェースへのポインター。

戻り値

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

関数が失敗した場合、エラーを示す HRESULT 値を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。一般的なエラーコードの一覧については、Common HRESULT Values を参照してください。

リターンコード/値 説明
HRESULT_FROM_WIN32(ERROR_FILE_EXISTS)
 コレクション内の項目が、指定したプロパティと同じ ID を持っています。
vtbl 11 HRESULT Remove(INT Index)

インデックス値を指定して、コレクションからプロパティを削除します。

IndexINTin削除するプロパティのインデックスを格納する LONG 変数。

戻り値

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

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

vtbl 12 HRESULT Clear()

コレクションからすべてのプロパティを削除します。

戻り値

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

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

vtbl 13 HRESULT InitializeFromCertificate(VARIANT_BOOL MachineContext, EncodingType Encoding, LPWSTR strCertificate)

証明書に含まれるプロパティからコレクションを初期化します。

MachineContextVARIANT_BOOLin証明書ストアのコンテキストを指定する VARIANT_BOOL 変数。コンピューターの場合は VARIANT_TRUE を、ユーザーの場合は VARIANT_FALSE を指定します。
EncodingEncodingTypeinstrCertificate パラメーターに含まれる証明書に適用される Unicode エンコードの種類を指定する EncodingType 列挙値。
strCertificateLPWSTRin

DER エンコードされた証明書を格納する BSTR 変数。

Windows 7 および Windows Server 2008 R2 以降では、エンコードされた証明書の代わりに、証明書の拇印 (サムプリント) またはシリアル番号を指定できます。これを指定すると、関数は一致する証明書を適切なローカルストアから検索します。次の点に注意してください。

  • BSTR は偶数個の 16 進数字である必要があります。
  • 16 進数のペア間の空白は無視されます。
  • Encoding パラメーターには XCN_CRYPT_STRING_HEXRAW を設定する必要があります。
  • MachineContext パラメーターは、ユーザーストア、コンピューターストア、またはその両方のいずれを検索するかを決定します。
  • 秘密キーが必要な場合は、個人ストアと要求ストアのみが検索されます。
  • 秘密キーが不要な場合は、ルートおよび中間 CA ストアも検索されます。

戻り値

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

関数が失敗した場合、エラーを示す HRESULT 値を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。一般的なエラーコードの一覧については、Common HRESULT Values を参照してください。

リターンコード/値 説明
CRYPT_E_NOT_FOUND
 証明書が見つかりませんでした。
CRYPT_E_UNEXPECTED_MSG_TYPE
 証明書は見つかりましたが、秘密キーを読み込めませんでした。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ICertProperties "{728AB32F-217D-11DA-B2A4-000E7BBB2B09}"
#usecom global ICertProperties IID_ICertProperties "{}"
#comfunc global ICertProperties_get_ItemByIndex            7 int,sptr
#comfunc global ICertProperties_get_Count                  8 var
#comfunc global ICertProperties_get__NewEnum               9 sptr
#comfunc global ICertProperties_Add                        10 sptr
#comfunc global ICertProperties_Remove                     11 int
#comfunc global ICertProperties_Clear                      12
#comfunc global ICertProperties_InitializeFromCertificate  13 int,int,wstr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。