Contents
Index

MIC Object From String

This MIC tool returns an MIC Object from an MIC Object string handle. This operation will not succeed if called from a thread that did not create the MIC Object.

Inputs

MIC Object Handle

This required string (sMicObjectHandle) is an object handle obtained by a call to MIC Object to String. This tool step will fail if the original object this string represents is no longer in scope.

Outputs

MIC Object

The MIC object (moMicObject) based on the specified string handle. When this tool returns an MIC Object, it causes a reference count against that target object. Once this occurs, the original MIC Object from which the string handle was taken can fall out of scope.

Exit Code

An Exit Code (iExitCode) of 0 (zero) indicates success and a non-zero code indicates an error or other condition about the results of this tool step.

Exit Text

The exit text string (sExitText) corresponds to the Exit Code. When the Exit Code is 0, the Exit Text is "Success."

Exit Paths

Success

If it returns a valid MIC object handle.

Failure

If the MIC object is out of scope or an invalid name. Some common error codes could include:

Exit Code: 0x80070057

Exit Text: One or more arguments are invalid

Reason: The MIC Object string value was empty.

Exit Code: 0x80070006

Exit Text: Invalid handle

Reason: The MIC Object string that was passed is invalid. This may be due to the referenced object having been deleted by going out-of-scope, or the object exists on another thread.