MI_Session_EnumerateInstances function (mi.h)

Enumerate all instances (on the server represented by the session) that are associated with a class.

Syntax

MI_INLINE void MI_Session_EnumerateInstances(
  [in]           MI_Session            *session,
                 MI_Uint32             flags,
  [in, optional] MI_OperationOptions   *options,
                 const MI_Char         *namespaceName,
                 const MI_Char         *className,
                 MI_Boolean            keysOnly,
  [in, optional] MI_OperationCallbacks *callbacks,
  [out]          MI_Operation          *operation
);

Parameters

[in] session

Session handle returned from MI_Application_NewSession.

flags

Polymorphic and 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.

className

A null-terminated string that represents the name of the class for which the instances are to be enumerated.

keysOnly

Boolean value where MI_TRUE results in retrieving only the key properties of the instances. Otherwise, all instance 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 must be specified. If this callback is not specified, then 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

Requirements

See also

MI_Application_NewSession

MI_OperationCallbacks

MI_Operation_Cancel

MI_Operation_Close

MI_Operation_GetInstance