MI_Operation_GetInstance function (mi.h)

Article
10/13/2021

Gets a synchronous result for an instance operation.

Syntax

MI_INLINE MI_Result MI_Operation_GetInstance(
  [in]            MI_Operation      *operation,
                  const MI_Instance **instance,
  [out, optional] MI_Boolean        *moreResults,
  [out, optional] MI_Result         *result,
                  const MI_Char     **errorMessage,
                  const MI_Instance **completionDetails
);

Parameters

[in] operation

The operation handle returned from instance session operations.

instance

Returned instance. This value may be Null even if the operation succeeds. The returned instance is valid until the next call to MI_Operation_GetInstance or MI_Operation_Close. If the instance needs to be stay active across these calls, then the class needs to be cloned via MI_Instance_Clone.

[out, optional] moreResults

Returned Boolean value indicating if more results are available. A value of MI_TRUE means that more results can be retrieved. This function must be called until moreResults has a value of MI_FALSE (even if the operation is canceled via MI_Operation_Cancel). Calling MI_Operation_Close before retrieving the last result where moreResults is set to MI_FALSE will cause the MI_Operation_Close function to stop responding.

[out, optional] result

Returned value indicating the success or failure of the function call. A value of MI_RESULT_OK indicates success. Otherwise, the returned errorMessage value should be used to determine the cause of failure.

errorMessage

In the case of an error, this returned value provides additional debugging information as to the cause of failure. This error message has the same lifetime as the classResult value.

completionDetails

In the case of an error, this returned value provides additional error information - typically in the form of a CIM_Error object (or a derived class). This returned instance has the same lifetime as the classResult value. If this value is needs to stay active longer, then the value needs to be cloned via MI_Instance_Clone.

Return value

None

Remarks

This function is called to get all synchronous results for all instance operations except subscriptions, where MI_Operation_GetIndication should be used. This function will block until a result is available. It should be called until the moreResults parameter is returned with a value of MI_FALSE. It is an error to call this function if an instance callback is registered.

Requirements

Requirement	Value
Minimum supported client	Windows 8
Minimum supported server	Windows Server 2012
Target Platform	Windows
Header	mi.h
Redistributable	Windows Management Framework 3.0 on Windows Server 2008 R2 with SP1, Windows 7 with SP1, and Windows Server 2008 with SP2

Share via