MI_Session_ReferenceInstances function (mi.h)

Finds the association object that references the specified key instance.

Syntax

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

Parameters

[in] session

Session handle returned from 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

An optional, null-terminated string that represents the 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 a namespace name separated by a slash mark character (/). For example, the following would be a valid namespaceName value: root/cimv2.

[in] instanceKey

An MI_Instance that represents the class name and the keys of the instance where the reference operation is to start.

resultClass

An optional, null-terminated string that represents the value that restricts the result set to only this association class. Specify Null if no filtering is wanted.

role

An optional, null-terminated string that represents the value that specifies which property name in the association class to use to reference the key class.

keysOnly

Boolean value where MI_TRUE means to retrieve only the instance keys. Otherwise, all properties will be retrieved.

[in, optional] callbacks

Optional MI_OperationCallbacks structure that defines the operational callbacks to receive the instance result and CIM semantics. To carry out the operation asynchronously, the structure's instanceResult callback member must be specified. If that structure member is not specified, the client must call the MI_Operation_GetInstance function to retrieve the results.

[out] operation

Returned operation handle that must be closed via MI_Operation_Close once complete. Calling MI_Operation_Cancel before it is complete will cause the operation to shutdown. MI_Operation_Close and MI_Operation_Cancel can be called from any operation.

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 difference between this function and the MI_Session_AssociatorInstances function is that this function looks for the association object itself, while the MI_Session_AssociatorInstances function looks for the instances associated with the key object.

Requirements

See also

MI_Application_NewSession

MI_OperationCallbacks

MI_Operation_Cancel

MI_Operation_Close

MI_Operation_GetInstance

MI_Session_AssociatorInstances