Метод SWbemServices.AssociatorsOf
Метод AssociatorsOf объекта SWbemServices возвращает коллекцию объектов (классов или экземпляров), называемых конечными точками, которые связаны с указанным объектом. Этот метод выполняет ту же функцию, что и запрос ASSOCIATORS OF WQL.
По умолчанию этот метод вызывается в полусинхронном режиме. Дополнительные сведения см. в разделе Вызов метода .
Описание этого синтаксиса см. в разделе Соглашения о документах для 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)
-
Текущий пользователь не имеет разрешения на просмотр одного или нескольких классов, возвращаемых вызовом.
-
wbemErrFailed — 2147749889 (0x80041001)
-
Незаданная ошибка.
-
wbemErrInvalidParameter — 2147749896 (0x80041008)
-
Указан недопустимый параметр.
-
wbemErrOutOfMemory — 2147749894 (0x80041006)
-
Недостаточно памяти для завершения операции.
-
wbemErrNotFound — 2147749890 (0x80041002)
-
Запрошенный элемент не найден.
Комментарии
Метод извлекает экземпляры управляемых ресурсов, связанных с указанным ресурсом, с помощью одного или нескольких классов ассоциаций. Вы указываете путь к объекту для исходной конечной точки, а AssociatorsOf возвращает управляемые ресурсы в противоположной конечной точке. Метод AssociatorsOf выполняет ту же функцию, что и запрос ASSOCIATORS OF WQL.
Дополнительные сведения о запросе ASSOCIATORS OF WQL, исходных экземплярах и конечных точках см. в статье ASSOCIATORS OF Statement.
Требования
Требование | Значение |
---|---|
Минимальная версия клиента |
Windows Vista |
Минимальная версия сервера |
Windows Server 2008 |
Заголовок |
|
Библиотека типов |
|
DLL |
|
CLSID |
CLSID_SWbemServices |
IID |
IID_ISWbemServices |