MI_Session_AssociatorInstances function (mi.h)

Finds instances that are associated with the specific key instance.

Syntax

MI_INLINE void MI_Session_AssociatorInstances(
  [in]           MI_Session            *session,
                 MI_Uint32             flags,
  [in, optional] MI_OperationOptions   *options,
                 const MI_Char         *namespaceName,
  [in]           const MI_Instance     *instanceKey,
                 const MI_Char         *assocClass,
                 const MI_Char         *resultClass,
                 const MI_Char         *role,
                 const MI_Char         *resultRole,
                 MI_Boolean            keysOnly,
  [in, optional] MI_OperationCallbacks *callbacks,
  [out]          MI_Operation          *operation
);

Parameters

[in] session

Handle created from a call to MI_Application_NewSession.

flags

Runtime type information (RTTI) flags.

[in, optional] options

Optional MI_OperationOptions value that specifies options such as timeouts and how to control the CIM semantics. Specify NULL if no operation options are to be sent.

namespaceName

A null-terminated string that contains the optional namespace name to carry out the operation. If none is specified the server will pick a default. The namespace cannot include a computer name. It can only be in the form of namespace names separated by a slash character, for instance root/cimv2.

[in] instanceKey

An MI_Instance that represents the class name and the keys of the instance where the association will start.

assocClass

A null-terminated string that represents the optional value that specifies to only map the association via this association class. If this value is NULL, then any association classes will be used.

resultClass

A null-terminated string that represents the optional values that restricts the result set to only this class. Specify NULL if no filtering is wanted.

role

A null-terminated string that represents the property name in the association object that points to our key object.

resultRole

A null-terminated string that represents the property name in the association object that points to the resultant class.

keysOnly

If set to MI_TRUE the operation will only retrieve the key properties of the instances. Otherwise, specify MI_FALSE.

[in, optional] callbacks

Optional MI_OperationCallbacks structure that defines the operational callbacks to receive the instance result and CIM semantics. For asynchronous operation, the callback must be specified. For synchronous operation, specify NULL; the client must then call MI_Operation_GetInstance to retrieve the results.

[out] operation

Operation handle that must be closed with a call to MI_Operation_Close once the operation is finished and all results have been received. The handle can be used to cancel the operation with a call to MI_Operation_Cancel.

Return value

None

Remarks

An association is a relationship between two objects. It is represented with a third object containing two properties, each being a reference to one of those two related objects. The role parameter is the association object's reference property, pointing to the object being associated. The resultRole parameter points to the other, resultant object.

Requirements

See also

MI_Application_NewSession

MI_Operation_Cancel

MI_Operation_Close

MI_Operation_GetInstance