UnserializeObjects Method

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Syntax

Engine.UnserializeObjects ( stream, reservedParam = 0, handlerType = ConflictHandler_Error)

Return Value

Object Array

Returns the array of unserialized property objects.

Purpose

Converts a string of serialized objects into an array of PropertyObjects.

Remarks

Call this method to convert the return value of the Engine.SerializeObjects method into an array of objects. Typically, you use the Engine.SerializeObjects method and this method to put TestStand data on the Microsoft Windows clipboard and to obtain data from it.

Use the Engine.UnserializeObjectsAndTypes method instead of this method if you intend to insert the array of property objects generated from the stream into a property object file. Also add the types the Engine.UnserializeObjectsAndTypes method returns to the file. You can add the types to the file by calling the TypeUsageList.Union method on the object the PropertyObjectFile.TypeUsageList property returns. Pass the typesUsed output value as the unionTypeUsageList parameter to TypeUsageList.Union.

When you unserialize a step or a sequence, call the Step.CreateNewUniqueStepId, Sequence.CreateNewUniqueStepIds, or Engine.CreateNewUniqueStepIds method to replace the unique step ID with a new unique ID.

Parameters

stream As String

[In] Specifies the serialized objects the Engine.SerializeObjects method creates.

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

Engine.CreateNewUniqueStepIds

Engine.SerializeObjects

Engine.UnserializeObjectsAndTypes

PropertyObject.Serialize

PropertyObject.UnserializeEx

PropertyObjectFile.TypeUsageList

Sequence.CreateNewUniqueStepIds

Step.CreateNewUniqueStepId

TypeConflictHandlerTypes

TypeUsageList.Union

WAS THIS ARTICLE HELPFUL?

Not Helpful