ReadPropertyObjectFile Method

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Syntax

Engine.ReadPropertyObjectFile ( path, userCancelled, handlerType = ConflictHandler_Error, options = 0)

Return Value

PropertyObjectFile

The newly created PropertyObjectFile object.

Purpose

Creates a new PropertyObjectFile object, determines the file type, and reads the object as that file type.

Remarks

Use this method to examine the internal structure, data, and types contained in a PropertyObjectFile, even if the file type is unknown. Calling this method produces the same result as calling the FileInformation.PropertyObjectFileType property, the

Engine.NewPropertyObjectFile method, and the PropertyObjectFile.ReadFile method.

You cannot read a users file, a configuration file, or a station globals file using this method. This method returns an error if the file is not a PropertyObjectFile. Use FileInformation.IsPropertyObjectFile property to determine if the file is a PropertyObjectFile.

Note  Use the Engine.GetSequenceFileEx method if you intend to open and run a sequence file. Unlike the Engine.GetSequenceFileEx method, this method does not load the sequence file into the internal cache of the engine, which might result in unexpected behavior.

Parameters

path As String

[In] Specifies the pathname of the file.

userCancelled As Boolean

[Out] Returns True if the file has type conflicts and the user cancelled the operation.

handlerType As TypeConflictHandlerTypes

[In] Specifies how to handle type conflicts.

This parameter has a default value of ConflictHandler_Error.

options As Long

[In] Pass 0 to specify the default behavior or pass one or more ReadPropertyObjectFileOptions constants. Use the bitwise-OR operator to specify multiple options.

This parameter has a default value of 0.


See Also

Engine.GetSequenceFileEx

Engine.NewPropertyObjectFile

Engine.OpenWorkspaceFile

FileInformation.IsPropertyObjectFile

FileInformation.PropertyObjectFileType

PropertyObjectFile

PropertyObjectFile.ReadFile

ReadPropertyObjectFileOptions

WAS THIS ARTICLE HELPFUL?

Not Helpful