ReloadFile Method

TestStand 2017 Help

Edition Date: November 2017

Part Number: 370052W-01

»View Product Info

Download Help (Windows Only)
NI TestStand 2014 Help
NI TestStand 2014 SP1 Help
TestStand 2016 Help
TestStand 2016 SP1 Help
TestStand 2017 Help

Syntax

ApplicationMgr.ReloadFile ( file, options = 0)

Return Value

Boolean

Returns True when the file was reloaded. This method returns False when the TestStand Engine cannot unload the file, when an ApplicationMgr.QueryReloadSequenceFile event cancels the operation, or when TestStand prompts the user and the user cancels the operation.

Purpose

Reloads the specified file.

When the file is reloaded, this method returns a reference to the newly loaded version of the file in the file parameter. This method supports only sequence files the Application Manager control opens. For all other files, this method returns False.

Remarks

TestStand generates an ApplicationMgr.QueryReloadSequenceFile event to allow the application to cancel the reload operation or specify to prompt the user to reload the file.

When you specify ReloadFileOption_NoOptions for the options parameter for this method and an ApplicationMgr.QueryReloadSequenceFile event does not alter the opt parameter of the event, TestStand does not prompt to reload the file.

When you specify ReloadFileOption_OnlyIfModifiedInMemory or ReloadFileOption_OnlyIfModifiedOnDisk for the options parameter to this method and an ApplicationMgr.QueryReloadSequenceFile event does not alter the opt parameter of the event, TestStand prompts the user to reload the file.

Parameters

file As PropertyObjectFile

[In/Out] Specifies a reference to the file you want to reload. The reference changes to the reloaded version of the file when TestStand reloads the file.

options As Long

[In] Specifies one or more ReloadFileOptions constants. Use the bitwise-OR operator to specify multiple options. Pass 0 to reload the file unconditionally.

This parameter has a default value of 0.


See Also

ApplicationMgr.QueryReloadSequenceFile event

ApplicationMgr.AutomaticallyReloadModifiedFiles

ApplicationMgr.ReloadModifiedSequenceFilesEx

ReloadFileOptions

SequenceFile.CanUnload

SequenceFile.IsExecuting

WAS THIS ARTICLE HELPFUL?

Not Helpful