SWbemServices.AssociatorsOf メソッド
SWbemServices オブジェクトの AssociatorsOf メソッドでは、指定したオブジェクトに関連付けられているエンドポイントと呼ばれるオブジェクト (クラスまたはインスタンス) のコレクションを返します。 このメソッドは、WQL クエリ ASSOCIATORS OF が実行するのと同じ関数を実行します。
このメソッドは、既定では半同期モードで呼び出されます。 詳細については、メソッドの呼び出しに関する記事を参照してください。
この構文の説明については、「スクリプト API のドキュメント規則」を参照してください。
構文
objWbemObjectSet = .AssociatorsOf( _
ByVal strObjectPath, _
[ ByVal strAssocClass ], _
[ ByVal strResultClass ], _
[ ByVal strResultRole ], _
[ ByVal strRole ], _
[ ByVal bClassesOnly ], _
[ ByVal bSchemaOnly ], _
[ ByVal strRequiredAssocQualifier ], _
[ ByVal strRequiredQualifier ], _
[ ByVal iFlags ], _
[ ByVal objwbemNamedValueSet ] _
)
パラメーター
-
strObjectPath
-
必須。 ソース クラスまたはインスタンスのオブジェクト パスを含む文字列。 詳細については、「WMI オブジェクトの場所の説明」を参照してください。
-
strAssocClass [省略可能]
-
関連付けクラスを含む文字列。 指定した場合、このパラメーターは、返されるエンドポイントが、指定された関連付けクラスまたはこの関連付けクラスから派生したクラスを介してソースに関連付けられている必要があることを示します。
-
strResultClass [省略可能]
-
クラス名を含む文字列。 指定した場合、この任意のパラメーターは、返されるエンドポイントがこのパラメーターで指定されたクラスに属しているか、そのクラスから派生していなければならないことを示します。
-
strResultRole [省略可能]
-
プロパティ名を含む文字列。 指定した場合、このパラメーターは、返されるエンドポイントが、ソース オブジェクトとの関連付けで特定の役割を担う必要があることを示します。 役割は、関連付けの指定されたプロパティ (参照プロパティである必要があります) の名前によって定義されます。
-
strRole [省略可能]
-
プロパティ名を含む文字列。 指定した場合、このパラメーターは、返されるエンドポイントがソース オブジェクトとの関連付け (この中ではソース オブジェクトが特定の役割を担っている) に参加している必要があることを示します。 役割は、関連付けの指定されたプロパティ (参照プロパティである必要があります) の名前によって定義されます。
-
bClassesOnly [省略可能]
-
クラスの実際のインスタンスではなく、クラス名のリストを返す必要があるかを示すブール値。 これらは、エンドポイント インスタンスが属するクラスです。 このパラメーターの既定値は、FALSE です。
-
bSchemaOnly [省略可能]
-
クエリがデータではなく、スキーマに適用されるのかを示すブール値。 このパラメーターの既定値は、FALSE です。 TRUE に設定できるのは、strObjectPath パラメーターによってクラスのオブジェクト パスが指定されている場合のみです。 TRUE に設定すると、返されるエンドポイントのセットは、スキーマ内のソース クラスに適切に関連付けられているクラスを表します。
-
strRequiredAssocQualifier [省略可能]
-
修飾子名を含む文字列。 指定した場合、このパラメーターは、返されるエンドポイントが、指定した修飾子を含む関連付けクラスを介してソース オブジェクトに関連付けられている必要があることを示します。
-
strRequiredQualifier [省略可能]
-
修飾子名を含む文字列。 指定した場合、このパラメーターは、返されるエンドポイントは指定された修飾子を含まなければならないことを示します。
-
iFlags [省略可能]
-
操作に追加のフラグを指定する整数。 このパラメーターの既定値は wbemFlagReturnImmediately で、半同期モードでメソッドが呼び出されます。 このパラメーターには次の値を指定することができます。
-
wbemFlagForwardOnly (32 (0x20))
-
順方向専用の列挙子を返します。 一般的に、順方向専用の列挙子は、従来の列挙子よりもずっと高速で、使用されるメモリが少なくなりますが、SWbemObject.Clone_ の呼び出しは許可されません。
-
wbemFlagBidirectional (0 (0x0))
-
クライアントが列挙子を解放するまで、WMI で列挙のオブジェクトへのポインターが保持されます。
-
wbemFlagReturnImmediately (16 (0x10))
-
呼び出しはすぐに戻ります。
-
wbemFlagReturnWhenComplete (0 (0x0))
-
クエリが完了するまで、この呼び出しをブロックします。 このフラグでは、メソッドを同期モードで呼び出します。
-
wbemFlagUseAmendedQualifiers (131072 (0x20000))
-
WMI で基底クラス定義と一緒にクラス変更データを返すようにします。 詳細については、「WMI クラス情報のローカライズ」を参照してください。
objwbemNamedValueSet [省略可能]
通常、これは未定義です。 そうでない場合、これは SWbemNamedValueSet オブジェクトであり、その要素は、要求を処理しているプロバイダーが使用できるコンテキスト情報を表します。 このような情報をサポートする、または必要とするプロバイダーは、認識された値名、値のデータ型、許可された値、セマンティクスを文書化する必要があります。
戻り値
呼び出しが成功した場合は、SWbemObjectSet オブジェクトが返されます。
エラー コード
AssociatorsOf メソッドの完了後に、Err オブジェクトに次のリストのいずれかのエラー コードが含まれる場合があります。
注意
要素を含まないコレクションが返されても、エラーではありません。
-
wbemErrAccessDenied - 2147749891 (0x80041003)
-
現在のユーザーには、呼び出しによって返された 1 つ以上のクラスを表示する権限がありません。
-
wbemErrFailed - 2147749889 (0x80041001)
-
未定義のエラーが発生しました。
-
wbemErrInvalidParameter - 2147749896 (0x80041008)
-
無効なパラメーターが指定されました。
-
wbemErrOutOfMemory - 2147749894 (0x80041006)
-
操作を完了させるための十分なメモリがありません。
-
wbemErrNotFound - 2147749890 (0x80041002)
-
要求された項目が見つかりませんでした。
解説
このメソッドでは、1 つ以上の関連付けクラスを使用して、指定したリソースに関連付けられている管理対象リソースのインスタンスを取得します。 元のエンドポイントのオブジェクト パスを指定すると、AssociatorsOf は、反対側のエンドポイントにある管理対象リソースを返します。 AssociatorsOf メソッドは、ASSOCIATORS OF WQL クエリが実行するのと同じ関数を実行します。
ASSOCIATORS OF WQL クエリ 、ソース インスタンス、エンドポイントの詳細については、「ASSOCIATORS OF ステートメント」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント |
Windows Vista |
| サポートされている最小のサーバー |
Windows Server 2008 |
| Header |
|
| タイプ ライブラリ |
|
| [DLL] |
|
| CLSID |
CLSID_SWbemServices |
| IID |
IID_ISWbemServices |