ホーム › Security.Cryptography.Certificates › IX500DistinguishedName

IX500DistinguishedName

COMIDispatch (デュアル)

📘 Microsoft Learn (日本語) · English

✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。

IID728ab303-217d-11da-b2a4-000e7bbb2b09継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

X.500 識別名 (DN) を表します。

メソッド 4

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

vtbl 7 HRESULT Decode(LPWSTR strEncodedName, EncodingType Encoding, X500NameFlags NameFlags)

Unicode でエンコードされた識別名からオブジェクトを初期化します。

strEncodedName	LPWSTR	in	エンコードされた名前を格納する BSTR 変数です。
Encoding	EncodingType	in	入力文字列に適用されている Unicode エンコードの種類を指定する EncodingType 列挙値です。既定値は XCN_CRYPT_STRING_BASE64 です。
NameFlags	X500NameFlags	in	デコード後の文字列の形式を指定する X500NameFlags 列挙値です。注意次のフラグは自動的に設定されます。 Certenroll.h で指定される既定値は XCN_CERT_NAME_STR_NONE です。 XCN_CERT_NAME_STR_FORWARD_FLAG を指定しない場合、XCN_CERT_NAME_STR_REVERSE_FLAG が自動的に適用されます。 XCN_CERT_NAME_STR_DISABLE_UTF8_DIR_STR_FLAG を指定しない場合、XCN_CERT_NAME_STR_FORCE_UTF8_DIR_STR_FLAG が自動的に適用されます。指定した他のフラグに関係なく、XCN_CERT_NAME_STR_ENABLE_PUNYCODE_FLAG が自動的に設定されます。

戻り値

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

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

戻り値/値	説明
E_OUTOFMEMORY	デコードされた値のためのメモリを割り当てられませんでした。
E_POINTER	strEncodedName パラメーターを NULL にすることはできません。
HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND)	名前をデコードできませんでした。

解説(Remarks)

このメソッドは内部的に CryptoAPI の CertNameToStr 関数を呼び出します。名前を null 終端文字列として取得するには、Name プロパティを呼び出します。エンコードされた名前を格納する文字列を取得するには、EncodedName プロパティを呼び出します。

vtbl 8 HRESULT Encode(LPWSTR strName, X500NameFlags NameFlags)

識別名を格納する文字列からオブジェクトを初期化します。

strName	LPWSTR	in	エンコードする文字列を格納する BSTR 変数です。
NameFlags	X500NameFlags	in	エンコードされた値の形式を指定する X500NameFlags 列挙値です。注意次のフラグは自動的に設定されます。 Certenroll.h で指定される既定値は XCN_CERT_NAME_STR_NONE です。 XCN_CERT_NAME_STR_FORWARD_FLAG を指定しない場合、XCN_CERT_NAME_STR_REVERSE_FLAG が自動的に適用されます。 XCN_CERT_NAME_STR_DISABLE_UTF8_DIR_STR_FLAG を指定しない場合、XCN_CERT_NAME_STR_FORCE_UTF8_DIR_STR_FLAG が自動的に適用されます。指定した他のフラグに関係なく、XCN_CERT_NAME_STR_ENABLE_PUNYCODE_FLAG が自動的に設定されます。

戻り値

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

戻り値/値	説明
E_OUTOFMEMORY	エンコードされた値のためのメモリを割り当てられませんでした。
E_POINTER	strName パラメーターを NULL にすることはできません。
HRESULT_FROM_WIN32(ERROR_FILENAME_EXCED_RANGE)	strName パラメーターの長さ (文字数) は 64 * 1024 を超えることはできません。

解説(Remarks)

このメソッドは内部的に CryptoAPI の CertStrToName 関数を呼び出します。名前を null 終端文字列として取得するには、Name プロパティを呼び出します。エンコードされた名前を格納する文字列を取得するには、EncodedName プロパティを呼び出します。

vtbl 9 HRESULT get_Name(LPWSTR* pValue)

識別名を取得します。

pValue

LPWSTR*

out

識別名 (DN) の文字列表現を受け取る文字列ポインタである。

解説(Remarks)

識別名をエンコードするには、Encode メソッドを呼び出します。識別名をデコードするには、Decode メソッドを呼び出します。名前をエンコードされた文字列として取得するには、EncodedName プロパティを呼び出します。

vtbl 10 HRESULT get_EncodedName(EncodingType Encoding, LPWSTR* pValue)

Unicode でエンコードされた識別名を取得します。

Encoding	EncodingType	in	出力データのエンコード形式を指定する EncodingType である。
pValue	LPWSTR*	out	エンコード済みの識別名を受け取る文字列ポインタである。

解説(Remarks)

識別名をエンコードするには、Encode メソッドを呼び出します。識別名をデコードするには、Decode メソッドを呼び出します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IX500DistinguishedName "{728AB303-217D-11DA-B2A4-000E7BBB2B09}"
#usecom global IX500DistinguishedName IID_IX500DistinguishedName "{}"
#comfunc global IX500DistinguishedName_Decode           7 wstr,int,int
#comfunc global IX500DistinguishedName_Encode           8 wstr,int
#comfunc global IX500DistinguishedName_get_Name         9 var
#comfunc global IX500DistinguishedName_get_EncodedName  10 int,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_IX500DistinguishedName "{728AB303-217D-11DA-B2A4-000E7BBB2B09}"
#usecom global IX500DistinguishedName IID_IX500DistinguishedName "{}"
#comfunc global IX500DistinguishedName_Decode           7 wstr,int,int
#comfunc global IX500DistinguishedName_Encode           8 wstr,int
#comfunc global IX500DistinguishedName_get_Name         9 sptr
#comfunc global IX500DistinguishedName_get_EncodedName  10 int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。