Export (0) Print
Expand All
Expand Minimize

MI_Session_EnumerateInstances function

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_opt_  MI_OperationOptions *options,
  _In_opt_z_ const MI_Char *namespaceName,
  _In_z_ const MI_Char *className,
  MI_Boolean keysOnly,
  _In_opt_  MI_OperationCallbacks *callbacks,
  _Out_     MI_Operation *operation
);

Parameters

session [in]

Session handle returned from MI_Application_NewSession.

flags

Polymorphic and runtime type information (RTTI) flags.

options [in, optional]

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.

callbacks [in, optional]

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.

operation [out]

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.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Redistributable

Windows Management Framework 3.0 on Windows Server 2008 R2 with SP1, Windows 7 with SP1, and Windows Server 2008 with SP2

Header

Mi.h

See also

MI_OperationCallbacks
MI_Application_NewSession
MI_Operation_GetInstance
MI_Operation_Cancel
MI_Operation_Close

 

 

Show:
© 2014 Microsoft