UnserializeObjectsAndTypes Method

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Syntax

Engine.UnserializeObjectsAndTypes ( stream, typesUsed, 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 property objects and a TypeUsageList that contains types the PropertyObjects use.

Remarks

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

If you insert the array of property objects this method returns into a property object file, add the types it uses to the file. You can also 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.

typesUsed As TypeUsageList

[Out] Returns the list of types the serialized objects use.

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.UnserializeObjects

PropertyObject.Serialize

PropertyObject.UnserializeEx

PropertyObjectFile.TypeUsageList

Sequence.CreateNewUniqueStepIds

Step.CreateNewUniqueStepId

TypeConflictHandlerTypes

TypeUsageList

TypeUsageList.Union

WAS THIS ARTICLE HELPFUL?

Not Helpful