NtpSessionInfoCommand Object


Description:

Save NTP session info.

Can be used with Command Sequencer: Yes

GUI Command Name: NTP: Save Session Info

Parents: Sequencer, StcSystem

NtpSessionInfoCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
BlockList

List of block handles on which to get NTP session information.

Type: handle

Default: 0

FileName

Filename to which the session information results will be saved.

Type: outputFilePath

Default: sessions.csv

SaveToFile

Save NTP session information results to a file.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Save NTP session information results to file.

FALSE

Do not save NTP session information results to file.

TimestampFilename

Include a timestamp as part of the filename.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Include timestamp as part of the filename.

FALSE

Do not include timestamp as part of the filename.

NtpSessionInfoCommand Read-Only Attributes

Read-Only Attribute Description
Common Read-Only Attributes ElapsedTime, EndTime, ProgressCurrentStep, ProgressCurrentStepName, ProgressCurrentValue, ProgressDisplayCounter, ProgressMaxValue, ProgressStepsCount, StartTime, State, Status