Win32 API 日本語リファレンス
ホーム › UI.Shell › INamedPropertyBag

INamedPropertyBag

COM
📘 Microsoft Learn (日本語) · English
IIDfb700430-952c-11d1-946f-000000000000継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

オブジェクトが自身のプロパティを保存できる、指定された名前付きプロパティバッグをオブジェクトに提供するメソッドを公開します。

メソッド 3

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT ReadPropertyNPB(LPWSTR pszBagname, LPWSTR pszPropName, PROPVARIANT* pVar)

名前付きプロパティバッグからプロパティを読み取ります。

pszBagnameLPWSTRinプロパティバッグの名前を格納する文字列へのポインターです。
pszPropNameLPWSTRin読み取るプロパティの名前を格納する文字列へのポインターです。
pVarPROPVARIANT*inoutVARIANT のアドレスです。このメソッドが正常に返ると、プロパティ値を受け取ります。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 4 HRESULT WritePropertyNPB(LPWSTR pszBagname, LPWSTR pszPropName, PROPVARIANT* pVar)

名前付きプロパティバッグにプロパティを保存します。

pszBagnameLPWSTRinプロパティバッグの名前を格納する文字列へのポインターです。
pszPropNameLPWSTRin書き込むプロパティの名前を格納する文字列へのポインターです。
pVarPROPVARIANT*in新しいプロパティ値を保持する VARIANT へのポインターです。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 5 HRESULT RemovePropertyNPB(LPWSTR pszBagname, LPWSTR pszPropName)

名前付きプロパティバッグからプロパティを削除します。

pszBagnameLPWSTRinプロパティを削除する対象のプロパティバッグの名前を格納する文字列へのポインターです。
pszPropNameLPWSTRin削除するプロパティの名前を格納する文字列へのポインターです。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_INamedPropertyBag "{FB700430-952C-11D1-946F-000000000000}"
#usecom global INamedPropertyBag IID_INamedPropertyBag "{}"
#comfunc global INamedPropertyBag_ReadPropertyNPB    3 wstr,wstr,var
#comfunc global INamedPropertyBag_WritePropertyNPB   4 wstr,wstr,var
#comfunc global INamedPropertyBag_RemovePropertyNPB  5 wstr,wstr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。