GetEngineConfigFile Method

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Syntax

Engine.GetEngineConfigFile ( configFileType)

Return Value

PropertyObjectFile

Purpose

Returns the PropertyObjectFile that contains settings, such as station options or search directories.

Remarks

Engine.GetEngineConfigFile provides direct access to TestStand Engine configuration files. Use this API with caution, particularly when changing settings. It is possible to put the configuration into an invalid state using this API. In most cases, there is a more appropriate, higher-level API that should be preferred. For example, prefer Engine.StationOptions when working with station options, or Engine.SearchDirectories when working with search directories.

Parameters

configFileType As PropertyObjectFileTypes

[In] Specifies the engine configuration file to return. Supported options are FileType_GeneralEngineConfigFile, FileType_SearchDirectoriesConfigFile, FileType_AdaptersConfigFile, FileType_TypePalettesConfigFile, FileType_CustomConfigFile, FileType_UsersFile, and FileType_StationGlobalsFile. Passing any other value results in a run time error.


See Also

PropertyObjectFileContentTypes

Engine.StationOptions

Engine.SearchDirectories

WAS THIS ARTICLE HELPFUL?

Not Helpful