Feedback

  • Contents
  • Index
 

MIC Object to String

This MIC tool returns a string based handle to any valid MIC Object, which uses reference counted handles.

Note:  This can be a dangerous operation. Once you turn an object into a string, there is no more referential integrity - the original object can go out of scope and you may not know it. You must be careful if you are working with MIC objects as strings instead of the handle variable. You can not use these strings across threads (e.g. in a new custom notification).

Inputs

MIC Object

Specify any valid MIC object (moMicObject).

Outputs

MIC Object Handle

The MIC Object string (sMicObjectHandle) handle does not cause a reference count to occur against the source MIC object.  This string is valid only as long as the original MIC object is valid.  In order to keep the original object in scope, the original MIC Object variable must exist in an active ancestor handler.

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 as a string.

Failure

If the MIC object is out of scope or an invalid name. Some error codes associated with this include:

Exit Code: 0x80070006

Exit Text: Invalid handle

Reason: The MIC Object string that was passed is invalid.

Related Topics

MIC Load Object

MIC is Object Valid

MIC Object From String

MIC Save Object