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

ICertEncodeStringArray

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

公式ドキュメント

証明書拡張で使用される文字列配列を処理するためのメソッドを提供します。

メソッド 7

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

vtbl 7 HRESULT Decode(LPWSTR strBinary)

Abstract Syntax Notation One (ASN.1) でエンコードされた文字列配列をデコードし、結果として得られる文字列の配列を CertEncodeStringArray オブジェクトに格納します。

strBinaryLPWSTRinASN.1 でエンコードされた文字列配列。

戻り値

VB

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

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

解説(Remarks)

このメソッドは、strBinary のデコード内容をオブジェクトの文字列配列に格納します。オブジェクトの配列に既に文字列が含まれている場合、その既存の内容は解放され、配列にデコードされた値が読み込まれます。

Decode メソッドを使用する例については、ICertEncodeStringArray::Encode メソッドを参照してください。

vtbl 8 HRESULT GetStringType(INT* pStringType)

文字列配列に含まれる文字列値の型を返します。

pStringTypeINT*out文字列の型を表す Long へのポインター。文字列の型の一覧については、「解説」を参照してください。

戻り値

C++

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

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

VB

戻り値は文字列配列内の文字列の型を示します。文字列の型の一覧については、「解説」を参照してください。

解説(Remarks)

次の表は、文字列配列が含むことのできる文字列の型を示します。RDN 型の詳細については、CryptoAPI 2.0 のドキュメントを参照してください。

文字列の型 意味
CERT_RDN_ANY_TYPE X509_UNICODE_NAME 名をエンコードするため。
CERT_RDN_NUMERIC_STRING 数字 0 から 9 と空白文字 (8 ビット)。
CERT_RDN_PRINTABLE_STRING 印刷可能文字 (8 ビット)。
CERT_RDN_T61_STRING T.61 でエンコードされた文字 (8 ビット)。
CERT_RDN_VIDEOTEX_STRING VIDEOTEX 文字。
CERT_RDN_IA5_STRING IA5 (ASCII) 文字。
CERT_RDN_GRAPHIC_STRING ISO 定義の GRAPHIC 文字からなる文字列。
CERT_RDN_ISO646_STRING 128 文字セット (8 ビット)。
CERT_RDN_GENERAL_STRING ISO 定義の GENERAL 文字からなる文字列。
CERT_RDN_INT4_STRING INT4 値の配列 (32 ビット)。
CERT_RDN_UNICODE_STRING Unicode 文字 (16 ビット)。

GetStringType メソッドを使用する例については、ICertEncodeStringArray::Encode メソッドを参照してください。

vtbl 9 HRESULT GetCount(INT* pCount)

文字列配列内の文字列値の数を返します。

pCountINT*out文字列配列に含まれる文字列値の数を受け取る LONG へのポインター。

戻り値

C++

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

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

VB

戻り値は文字列配列に含まれる文字列値の数です。
vtbl 10 HRESULT GetValue(INT Index, LPWSTR* pstr)

文字列配列から指定した文字列を返します。

IndexINTin取得する文字列を指定する 0 から始まるインデックス。
pstrLPWSTR*out文字列値を表す BSTR へのポインター。BSTR の使用が終わったら、SysFreeString 関数を呼び出して解放してください。

戻り値

C++

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

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

VB

戻り値は指定したインデックスの文字列値です。
vtbl 11 HRESULT Reset(INT Count, CERT_RDN_ATTR_VALUE_TYPE StringType)

文字列配列のサイズと、配列が含む文字列の型を指定します。

CountINTin文字列配列内の要素数を指定します。
StringTypeCERT_RDN_ATTR_VALUE_TYPEin

文字列配列が含む文字列の型を指定します。型は次のいずれかの値でなければなりません。RDN 型の詳細については、CryptoAPI 2.0 のドキュメントを参照してください。

意味
CERT_RDN_ANY_TYPE
X509_UNICODE_NAME 名をエンコードするため。
CERT_RDN_NUMERIC_STRING
文字 0 から 9 と空白文字 (8 ビット)。
CERT_RDN_PRINTABLE_STRING
印刷可能文字 (8 ビット)。
CERT_RDN_T61_STRING
T.61 でエンコードされた文字 (8 ビット)。
CERT_RDN_VIDEOTEX_STRING
VIDEOTEX 文字。
CERT_RDN_IA5_STRING
IA5 (ASCII) 文字。
CERT_RDN_GRAPHIC_STRING
ISO 定義の GRAPHIC 文字からなる文字列。
CERT_RDN_ISO646_STRING
128 文字セット (8 ビット)。
CERT_RDN_GENERAL_STRING
ISO 定義の GENERAL 文字からなる文字列。
CERT_RDN_INT4_STRING
INT4 値の配列 (32 ビット)。
CERT_RDN_UNICODE_STRING
Unicode 文字 (16 ビット)。

戻り値

VB

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

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

vtbl 12 HRESULT SetValue(INT Index, LPWSTR str)

文字列配列の指定したインデックスに文字列値を設定します。

IndexINTin設定する文字列配列の要素を指定する 0 から始まるインデックス。
strLPWSTRin設定する文字列値を指定します。

戻り値

VB

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

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

vtbl 13 HRESULT Encode(LPWSTR* pstrBinary)

このオブジェクトに格納されている文字列配列を ASN.1 でエンコードした文字列を返します。

pstrBinaryLPWSTR*outエンコードされた文字列配列を格納する BSTR へのポインター。BSTR の使用が終わったら、SysFreeString 関数を呼び出して解放してください。

戻り値

C++

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

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

VB

戻り値は ASN.1 でエンコードされた文字列配列です。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ICertEncodeStringArray "{12A88820-7494-11D0-8816-00A0C903B83C}"
#usecom global ICertEncodeStringArray IID_ICertEncodeStringArray "{}"
#comfunc global ICertEncodeStringArray_Decode         7 wstr
#comfunc global ICertEncodeStringArray_GetStringType  8 var
#comfunc global ICertEncodeStringArray_GetCount       9 var
#comfunc global ICertEncodeStringArray_GetValue       10 int,var
#comfunc global ICertEncodeStringArray_Reset          11 int,int
#comfunc global ICertEncodeStringArray_SetValue       12 int,wstr
#comfunc global ICertEncodeStringArray_Encode         13 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。