Syntax

ResultLogger.DeferrableRename( path)

Return Value

Boolean

A return value of True indicates that the rename operation succeeded and that the ResultLogger object updated the corresponding path property and renamed the TestStand results ( .tsr ) file on disk. A return value of False indicates that the rename operation failed and that the ResultLogger object did not update the corresponding path property and deferred renaming the file.

Purpose

Calling this method is similar to assigning a new value to the ResultLogger.Path property. However, when you use this method, the ResultLogger object does not update the path property and execution continues if renaming the underlying file fails, such as in the case of remote file systems that do not support the rename operation. If the initial renaming operation fails, the ResultLogger object defers updating the path property. The ResultLogger object updates the path property and the name of the file on disk when the ResultLogger object closes or the ResultLogger.ContinueInNewFile method is invoked. If at this point the rename operation remains impossible, the ResultLogger object simulates renaming the file by copying the file to the new path and deleting the existing file.

While a deferred renaming operation is pending, if the value of the ResultLogger.Path property changes or an additional call to the ResultLogger.DeferrableRename method occurs, the ResultLogger object cancels any previously deferred renaming operation.

Remarks

National Instruments recommends using the ResultLogger.Path property directly instead of the ResultLogger.DeferrableRename method whenever possible. The ResultLogger.DeferrableRename method is generally useful only in situations in which you repeatedly rename a single file to indicate status. For example, the default offline results generator process model plug-in uses the ResultLogger.DeferrableRename method to update the range of UUT serial numbers stored in the TestStand results ( .tsr ) file as UUTs execute.

Parameters

path As String

[In] Specifies the absolute path to use to rename the TestStand results ( .tsr ) file, such as C:\OfflineResults\MyResults.tsr .

See Also

ResultLogger.Close

ResultLogger.ContinueInNewFile

ResultLogger.Path