Win32 API 日本語リファレンス
ホーム › Networking.ActiveDirectory › IPersistQuery

IPersistQuery

COM
📘 Microsoft Learn (日本語) · English
IID1a3114b8-a62e-11d0-a6c5-00a0c906af45継承元IPersist自前メソッド開始 vtbl4

公式ドキュメント

クエリのパラメーターを永続的なストレージに保存したり、そこから取得したりするために使用します。

メソッド 7

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

vtbl 4 HRESULT WriteString(LPWSTR pSection, LPWSTR pValueName, LPWSTR pValue)

クエリストアに文字列を書き込みます。

pSectionLPWSTRin文字列の書き込み先となるセクション名を表す、null で終わる Unicode 文字列へのポインター。
pValueNameLPWSTRin文字列値の名前を表す、null で終わる Unicode 文字列へのポインター。
pValueLPWSTRin書き込む文字列を格納した、null で終わる Unicode 文字列へのポインター。

戻り値

成功した場合は S_OK を返し、それ以外の場合は標準の HRESULT 値を返します。想定されるエラーコードには次のものがあります。

vtbl 5 HRESULT ReadString(LPWSTR pSection, LPWSTR pValueName, LPWSTR pBuffer, INT cchBuffer)

クエリストアから文字列を読み取ります。

pSectionLPWSTRin文字列の読み取り元となるセクション名を表す、null で終わる Unicode 文字列へのポインター。
pValueNameLPWSTRin読み取る文字列値の名前を表す、null で終わる Unicode 文字列へのポインター。
pBufferLPWSTRout文字列値を受け取る文字バッファーへのポインター。cchBuffer パラメーターには、null 終端文字を含むこのバッファーのサイズを指定します。
cchBufferINTinnull 終端文字を含む pBuffer バッファーのサイズを文字数で格納します。

戻り値

成功した場合は S_OK を返し、それ以外の場合は標準の HRESULT 値を返します。想定されるエラーコードには次のものがあります。

vtbl 6 HRESULT WriteInt(LPWSTR pSection, LPWSTR pValueName, INT value)

クエリストアに整数値を書き込みます。

pSectionLPWSTRin整数の書き込み先となるセクション名を表す、null で終わる Unicode 文字列へのポインター。
pValueNameLPWSTRin整数値の名前を表す、null で終わる Unicode 文字列へのポインター。
valueINTinクエリストアに書き込む整数値を格納します。

戻り値

成功した場合は S_OK を返し、それ以外の場合は標準の HRESULT 値を返します。想定されるエラーコードには次のものがあります。

vtbl 7 HRESULT ReadInt(LPWSTR pSection, LPWSTR pValueName, INT* pValue)

クエリストアから整数値を読み取ります。

pSectionLPWSTRin整数の読み取り元となるセクション名を表す、null で終わる Unicode 文字列へのポインター。
pValueNameLPWSTRin読み取る整数値の名前を表す、null で終わる Unicode 文字列へのポインター。
pValueINT*inout整数値を受け取る整数型変数へのポインター。

戻り値

成功した場合は S_OK を返し、それ以外の場合は標準の HRESULT 値を返します。想定されるエラーコードには次のものがあります。

vtbl 8 HRESULT WriteStruct(LPWSTR pSection, LPWSTR pValueName, void* pStruct, DWORD cbStruct)

クエリストアに構造体を書き込みます。

pSectionLPWSTRin構造体の書き込み先となるセクション名を表す、null で終わる Unicode 文字列へのポインター。
pValueNameLPWSTRin構造体の名前を表す、null で終わる Unicode 文字列へのポインター。
pStructvoid*inout書き込む構造体へのポインター。cbStruct パラメーターには書き込むバイト数を格納します。
cbStructDWORDin書き込む構造体のサイズをバイト単位で格納します。

戻り値

成功した場合は S_OK を返し、それ以外の場合は標準の HRESULT 値を返します。想定されるエラーコードには次のものがあります。

vtbl 9 HRESULT ReadStruct(LPWSTR pSection, LPWSTR pValueName, void* pStruct, DWORD cbStruct)

クエリストアから構造体を読み取ります。

pSectionLPWSTRin構造体の読み取り元となるセクション名を表す、null で終わる Unicode 文字列へのポインター。
pValueNameLPWSTRin読み取る構造体値の名前を表す、null で終わる Unicode 文字列へのポインター。
pStructvoid*inout構造体を受け取るバッファーへのポインター。cbStruct パラメーターには、このバッファーのサイズをバイト単位で指定します。
cbStructDWORDinpStruct パラメーターで表されるバッファーのサイズをバイト単位で指定します。

戻り値

成功した場合は S_OK を返し、それ以外の場合は標準の HRESULT 値を返します。想定されるエラーコードには次のものがあります。

vtbl 10 HRESULT Clear()

クエリストアの内容を空にします。

戻り値

成功した場合は 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_IPersistQuery "{1A3114B8-A62E-11D0-A6C5-00A0C906AF45}"
#usecom global IPersistQuery IID_IPersistQuery "{}"
#comfunc global IPersistQuery_WriteString  4 wstr,wstr,wstr
#comfunc global IPersistQuery_ReadString   5 wstr,wstr,var,int
#comfunc global IPersistQuery_WriteInt     6 wstr,wstr,int
#comfunc global IPersistQuery_ReadInt      7 wstr,wstr,var
#comfunc global IPersistQuery_WriteStruct  8 wstr,wstr,sptr,int
#comfunc global IPersistQuery_ReadStruct   9 wstr,wstr,sptr,int
#comfunc global IPersistQuery_Clear        10
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。