Win32 API 日本語リファレンス
ホーム › System.Wmi › IWbemPathKeyList

IWbemPathKeyList

COM
📘 Microsoft Learn (日本語) · English
IID9ae62877-7544-4bb0-aa26-a13824659ed6継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

パスのキーの詳細にアクセスするために使用します。

メソッド 10

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

vtbl 3 HRESULT GetCount(DWORD* puKeyCount)

IWbemPathKeyList::GetCount メソッドは、パス内のキーの数を取得します。

puKeyCountDWORD*outキーの数。

戻り値

このメソッドは、メソッド呼び出しの状態を示す HRESULT を返します。

vtbl 4 HRESULT SetKey(LPWSTR wszName, DWORD uFlags, DWORD uCimType, void* pKeyVal)

キーの名前と値のペアを設定します。

wszNameLPWSTRinキー名。NULL でもかまいません。
uFlagsDWORDin予約済みです。0 (ゼロ) を指定する必要があります。
uCimTypeDWORDinCIMTYPE のサイズ。
pKeyValvoid*inデータへのポインター。指し示されるデータは、uCimType パラメーターによって異なります。

戻り値

このメソッドは、メソッド呼び出しの状態を示す HRESULT を返します。

vtbl 5 HRESULT SetKey2(LPWSTR wszName, DWORD uFlags, DWORD uCimType, VARIANT* pKeyVal)

バリアントを使用して、キーの名前と値のペアを設定します。

wszNameLPWSTRinキー名。NULL でもかまいません。
uFlagsDWORDin予約済みです。0 (ゼロ) を指定する必要があります。
uCimTypeDWORDinCIMTYPE のサイズ。
pKeyValVARIANT*inデータを格納するバリアントへのポインター。

戻り値

このメソッドは、メソッド呼び出しの状態を示す HRESULT を返します。

vtbl 6 HRESULT GetKey(DWORD uKeyIx, DWORD uFlags, DWORD* puNameBufSize, LPWSTR pszKeyName, DWORD* puKeyValBufSize, void* pKeyVal, DWORD* puApparentCimType)

IWbemPathKeyList::GetKey メソッドは、キーの名前または値を取得します。キーは 0 (ゼロ) から始まるインデックスで指定しますが、キーの順序に意味はありません。

uKeyIxDWORDin0 (ゼロ) から始まるキーのインデックス。
uFlagsDWORDin予約済みです。0 (ゼロ) を指定する必要があります。
puNameBufSizeDWORD*inout呼び出し元は、名前バッファーが保持できる文字数をこの値に設定します。成功すると、終端の NULL を含む、バッファーにコピーされた文字数が設定されます。
pszKeyNameLPWSTRoutoptional名前のコピー先となるバッファー。すべてのキーが名前を持つわけではないため、暗黙のキーの場合、このパラメーターの値は NULL になります。
puKeyValBufSizeDWORD*inout呼び出し元は、値バッファーが保持できる文字数をこの値に設定します。成功すると、NULL 終端文字を含む、バッファーにコピーされた文字数が設定されます。
pKeyValvoid*inoutデータのコピー先となるバッファー。
puApparentCimTypeDWORD*outCIM 型が設定される long へのポインター。

戻り値

このメソッドは、メソッド呼び出しの状態を示す HRESULT を返します。

解説(Remarks)

必要なバッファーのサイズを調べるには、バッファーに NULL ポインターを渡し、そのサイズ パラメーターを 0 (ゼロ) に設定してこのメソッドを呼び出すことをお勧めします。戻り時には、バッファーのサイズ パラメーターに、文字列とその NULL 終端文字を格納するために必要なバッファーのサイズが示されます。その後、メソッドを呼び出してバッファーの値を取得できます。

vtbl 7 HRESULT GetKey2(DWORD uKeyIx, DWORD uFlags, DWORD* puNameBufSize, LPWSTR pszKeyName, VARIANT* pKeyValue, DWORD* puApparentCimType)

IWbemPathKeyList::GetKey2 メソッドは、キーの名前または値を取得し、値を VARIANT として返します。キーは 0 (ゼロ) から始まるインデックスで指定しますが、キーの順序に意味はありません。

uKeyIxDWORDinキーのインデックスは 0 (ゼロ) から始まります。
uFlagsDWORDin予約済みです。0 (ゼロ) を指定する必要があります。
puNameBufSizeDWORD*inout呼び出し元は、名前バッファーが保持できる文字数をこのパラメーターに設定します。成功すると、終端の NULL を含む、バッファーにコピーされた文字数が設定されます。
pszKeyNameLPWSTRoutoptional名前のコピー先となるバッファー。すべてのキーが名前を持つわけではないため、暗黙のキーの場合、このパラメーターの値は NULL になります。
pKeyValueVARIANT*inoutキーの値を格納するバリアントへのポインター。
puApparentCimTypeDWORD*outCIM 型が設定される long 整数へのポインター。

戻り値

このメソッドは、メソッド呼び出しの状態を示す HRESULT を返します。

解説(Remarks)

このメソッドは、バッファーに NULL ポインターを渡し、そのサイズ パラメーターを 0 (ゼロ) に設定することで、必要なバッファーのサイズを調べるために使用できます。戻り時には、バッファー サイズ パラメーターに、文字列とその NULL 終端文字を格納するために必要なバッファーのサイズが示されます。

vtbl 8 HRESULT RemoveKey(LPWSTR wszName, DWORD uFlags)

IWbemPathKeyList::RemoveKey メソッドは、wszName パラメーターに一致するキーを削除します。

wszNameLPWSTRin削除するキーの名前。
uFlagsDWORDin予約済みです。0 (ゼロ) を指定する必要があります。

戻り値

このメソッドは、メソッド呼び出しの状態を示す HRESULT を返します。

vtbl 9 HRESULT RemoveAllKeys(DWORD uFlags)

IWbemPathKeyList::RemoveAllKeys メソッドは、すべてのキーを削除します。

uFlagsDWORDin予約済みです。0 (ゼロ) を指定する必要があります。

戻り値

このメソッドは、メソッド呼び出しの状態を示す HRESULT を返します。

vtbl 10 HRESULT MakeSingleton(BYTE bSet)

IWbemPathKeyList::MakeSingleton メソッドは、キーをシングルトンにするかどうかを制御します。

bSetBYTEinTRUE の場合、キーはシングルトンになります。FALSE の場合、キーはシングルトンではなくなります。

戻り値

このメソッドは、メソッド呼び出しの状態を示す HRESULT を返します。

vtbl 11 HRESULT GetInfo(DWORD uRequestedInfo, ULONGLONG* puResponse)

IWbemPathKeyList::GetInfo メソッドは、キーの状態ビットを取得します。

uRequestedInfoDWORDin予約済みです。0 (ゼロ) を指定する必要があります。
puResponseULONGLONG*out

キーの状態。次のビットが、利用可能な値を示します。

WBEMPATH_INFO_IS_COMPOUND

複合キーが使用されています。

WBEMPATH_INFO_HAS_V2_REF_PATHS

1 つ以上のキーが CIM_REFERENCE を持っています。

WBEMPATH_INFO_HAS_IMPLIED_KEY

どこかでキー名が欠落しています。

WBEMPATH_INFO_CONTAINS_SINGLETON

パス内に 1 つ以上のシングルトンがあります。

戻り値

このメソッドは、メソッド呼び出しの状態を示す HRESULT を返します。

vtbl 12 HRESULT GetText(INT lFlags, DWORD* puBuffLength, LPWSTR pszText)

IWbemPathKeyList::GetText メソッドは、キーの一覧をテキストとして取得します。

lFlagsINTin

テキストの形式を制御するフラグ。有効なフラグの値を次に示します。

WBEMPATH_QUOTEDTEXT

文字列のキー値を引用符で囲みます。

WBEMPATH_TEXT

使用されません。

puBuffLengthDWORD*inout呼び出し元は、バッファーが保持できる文字数をこの値に設定します。成功すると、NULL 終端文字を含む、バッファーにコピーされた文字数が設定されます。
pszTextLPWSTRoutテキストのコピー先となるバッファー。

戻り値

このメソッドは、メソッド呼び出しの状態を示す HRESULT を返します。

解説(Remarks)

このメソッドは、バッファーに NULL ポインターを渡し、そのサイズ パラメーターを 0 (ゼロ) に設定することで、必要なバッファーのサイズを調べるために使用できます。戻り時には、バッファーのサイズ パラメーターに、文字列とその NULL 終端文字を格納するために必要なバッファーのサイズが示されます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IWbemPathKeyList "{9AE62877-7544-4BB0-AA26-A13824659ED6}"
#usecom global IWbemPathKeyList IID_IWbemPathKeyList "{}"
#comfunc global IWbemPathKeyList_GetCount       3 var
#comfunc global IWbemPathKeyList_SetKey         4 wstr,int,int,sptr
#comfunc global IWbemPathKeyList_SetKey2        5 wstr,int,int,var
#comfunc global IWbemPathKeyList_GetKey         6 int,int,var,var,var,sptr,var
#comfunc global IWbemPathKeyList_GetKey2        7 int,int,var,var,var,var
#comfunc global IWbemPathKeyList_RemoveKey      8 wstr,int
#comfunc global IWbemPathKeyList_RemoveAllKeys  9 int
#comfunc global IWbemPathKeyList_MakeSingleton  10 int
#comfunc global IWbemPathKeyList_GetInfo        11 int,var
#comfunc global IWbemPathKeyList_GetText        12 int,var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。