UnserializeObjectsAndTypes Method
Syntax
Engine.UnserializeObjectsAndTypes ( stream, typesUsed, reservedParam = 0, handlerType = ConflictHandler_Error)
Return Value
Returns the array of property objects that were unserialized.
Purpose
Converts a string of serialized objects into an array of property objects and a TypeUsageList containing types that are used by the PropertyObjects.
Remarks
Call this method to convert the return value of SerializeObjects into an array of property objects and a list of types. Typically, you use the SerializeObjects and UnserializeObjects methods to put TestStand data on the Windows clipboard and to get data from it.
If you insert the array of property objects that UnserializeObjectsAndTypes returns into a property object file, you should add the types it uses to the file. You can also add the types to the file by calling TypeUsageList.Union on the object that PropertyObjectFile.TypeUsageList returns. Pass the typesUsed output value as the unionTypeUsageList parameter to TypeUsageList.Union.
When you unserialize a step or a sequence, you should call Step.CreateNewUniqueStepId, Sequence.CreateNewUniqueStepIds, or Engine.CreateNewUniqueStepIds to replace the unique step Id with a new unique Id.
Parameters
stream As String
[In] Specifies the serialized objects created by SerializeObjects.
typesUsed As TypeUsageList
[Out] Returns the list of types used by the serialized objects.
reservedParam As long
[In] Pass 0.
This parameter has a default value of 0.
handlerType As TypeConflictHandlerTypes
[In] Specifies how to handle type conflicts in the stream.
This parameter has a default value of ConflictHandler_Error.
See Also
PropertyObjectFile.TypeUsageList