PropertyObject.Unserialize
- Updated2024-10-09
- 1 minute(s) read
PropertyObject.Unserialize
Syntax
PropertyObject.Unserialize( stream, objectName, RWoptions)
Purpose
Remarks
Reads the contents of an object from a stream of string data and stores the contents in the PropertyObject to which the method applies.
You cannot unserialize a stream that contains a container type into a property object that is a value type, or vice versa. This method does not return an error, but instead sets the PropertyObject on which this method operates to the default value.
If you attempt to unserialize a stream that contains a value type into a property object of a different value type, TestStand attempts to coerce the value. If the coercion is unsuccessful, TestStand sets the PropertyObject on which this method operates to the default value.
TestStand does not assign the name or flags associated with the top-level PropertyObject in the stream to the PropertyObject on which this method operates.
Parameters
stream As String
[In] Specifies an existing stream of data that stores the object.
objectName As String
[In] Specifies the name with which the object is stored in the stream.
RWoptions As Long
[In] Pass 0 to specify the default behavior, or pass one or more ReadWriteOptions constants. Use the bitwise-OR operator to specify multiple read write options.
See Also
Thread Safety of the PropertyObject API and TestStand Variables