CaptionSources Enumeration

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

These constants specify types of caption sources. Each caption source provides text that describes an aspect of the current application state. You can use these constants to connect a caption to a Label or StatusBarPane using the ApplicationMgr.ConnectCaption, ExecutionViewMgr.ConnectCaption, or SequenceFileViewMgr.ConnectCaption method.

To obtain the text of a caption without connecting it to a control, call the ApplicationMgr.GetCaptionText, ExecutionViewMgr.GetCaptionText, or SequenceFileViewMgr.GetCaptionText method.

A caption source applies to all manager controls unless the help for the enumeration element specifies the particular manager control or controls with which it applies.

  • CaptionSource_BatchSerialNumber–(Value: 4) Displays the batch serial number for the batch that contains the current execution. A process model sends the batch serial number through the UIMsg_ModelState_Identified UIMessageCode. This caption source applies only to the ExecutionView Manager control.
  • CaptionSource_BatchState–(Value: 6) Displays a description of the execution state of the batch that contains the current execution. For example, this caption might display Initializing, Testing, Waiting, or Completed [Passed]. This caption source applies only to the ExecutionView Manager control.
  • CaptionSource_BatchStatus–(Value: 5) Displays the batch result status for the batch that contains the current execution. A process model sends the batch status through the UIMsg_ModelState_TestingComplete UIMessageCode. This caption source applies only to the ExecutionView Manager control.
  • CaptionSource_CurrentCallStackEntry–(Value: 26) Displays a name that identifies the current call stack item in the foreground thread in the current execution. This caption source applies only to the ExecutionView Manager control.
  • CaptionSource_CurrentExecution–(Value: 24) Displays a name that identifies the current execution. This caption source applies only to the ExecutionView Manager control.
  • CaptionSource_CurrentProcessModelFile–(Value: 27) Displays the path name of the process model file for the currently executing or currently selected sequence file. When you pass True to the long name option for the caption, the caption displays the full path name. Otherwise, the caption displays the base filename.
  • CaptionSource_CurrentSequence–(Value: 13) Displays the name of the currently executing or currently selected sequence. This caption source applies to the ExecutionView Manager and SequenceFileView Manager controls.
  • CaptionSource_CurrentSequenceComment–(Value: 14) Displays the comment for the currently executing or currently selected sequence. This caption source applies to the ExecutionView Manager and SequenceFileView Manager controls.
  • CaptionSource_CurrentSequenceFile–(Value: 11) Displays the path name of the currently executing or currently selected sequence file with a read-only, locked, executing, or modified file state suffix. When you pass True to the long name option for the caption, the caption displays the full path name. Otherwise, the caption displays the base filename. This caption source applies to the ExecutionView Manager and SequenceFileView Manager controls.
  • CaptionSource_CurrentSequenceFile_FileStateOnly–(Value: 33) Displays only the read-only, locked, executing, or modified file state of the currently executing or currently selected sequence file. This caption source applies to the ExecutionView Manager and SequenceFileView Manager controls.
  • CaptionSource_CurrentSequenceFile_WithoutFileState–(Value: 32) Displays the path name of the currently executing or currently selected sequence file without a file state suffix. When you pass True to the long name option for the caption, the caption displays the full path name. Otherwise, the caption displays the base filename. This caption source applies to the ExecutionView Manager and SequenceFileView Manager controls.
  • CaptionSource_CurrentSequenceFileComment–(Value: 12) Displays the comment for the currently executing or currently selected sequence file. This caption source applies to the ExecutionView Manager and SequenceFileView Manager controls.
  • CaptionSource_CurrentStep–(Value: 16) Displays the name of the current step in the current execution. This caption source applies only to the ExecutionView Manager control.
  • CaptionSource_CurrentStepComment–(Value: 17) Displays the comment for the current step in the current execution. This caption source applies only to the ExecutionView Manager control.
  • CaptionSource_CurrentStepGroup–(Value: 15) Displays the name of the currently executing or currently selected step group. This caption source applies to the ExecutionView Manager and SequenceFileView Manager controls.
  • CaptionSource_CurrentStepIndex_ZeroBased–(Value: 18) Displays the zero-based index of the current step in the current execution. This caption source applies only to the ExecutionView Manager control.
  • CaptionSource_CurrentTestIndex_OneBased–(Value: 19) Displays the one-based index of the current step in the current execution. This caption source applies only to the ExecutionView Manager control.
  • CaptionSource_CurrentThread–(Value: 25) Displays a name that identifies the foreground thread in the current execution. This caption source applies only to the ExecutionView Manager control.
  • CaptionSource_Date–(Value: 31) Displays the current date. When you pass True to the long name option for the caption, the caption displays the system long date format. Otherwise, the caption displays the system short date format.
  • CaptionSource_EngineEnvironment–(Value: 34) Displays the path name of the current TestStand environment. When you pass True to the long name option for the caption, the caption displays the full path name. Otherwise, the caption displays the base filename.
  • CaptionSource_MacroExpression–(Value: 1) Displays the evaluated result of a format expression that can contain macros that specify text from other caption sources. You can use this caption source to combine text from multiple caption sources. Place the macros that specify other caption sources within string constants in the format expression for the caption text or caption connection you create with this caption source. The following are the available macros:

    Macro, Caption Source, Specifies caption source long name

    %UUTSerialNumber%, CaptionSource_UUTSerialNumber, no
    %UUTStatus%, CaptionSource_UUTStatus, no
    %BatchSerialNumber%, CaptionSource_BatchSerialNumber, no
    %BatchStatus%, CaptionSource_BatchStatus, no
    %BatchState%, CaptionSource_BatchState, no
    %ModelState%, CaptionSource_ModelState, no
    %UserName%, CaptionSource_UserName, no
    %ProgressText%, CaptionSource_ProgressText, no
    %ProgressPercent%, CaptionSource_ProgressPercent, no
    %CurrentSequenceFile%, CaptionSource_CurrentSequenceFile, no
    %CurrentSequence%, CaptionSource_CurrentSequence, no
    %CurrentStepGroup%, CaptionSource_CurrentStepGroup, no
    %CurrentStep%, CaptionSource_CurrentStep, no
    %CurrentStepIndex_ZeroBased%, CaptionSource_CurrentStepIndex_ZeroBased, no
    %CurrentTestIndex_OneBased%, CaptionSource_CurrentTestIndex_OneBased, no
    %NumberOfSteps%, CaptionSource_NumberOfSteps, no
    %CurrentExecution%, CaptionSource_CurrentExecution, no
    %CurrentThread%, CaptionSource_CurrentThread, no
    %CurrentCallStackEntry%, CaptionSource_CurrentCallStackEntry, no
    %CurrentProcessModelFile%, CaptionSource_CurrentProcessModelFile, no
    %UUTSerialNumberLongName%, CaptionSource_UUTSerialNumber, yes
    %UUTStatusLongName%, CaptionSource_UUTStatus, yes
    %BatchSerialNumberLongName%, CaptionSource_BatchSerialNumber, yes
    %BatchStatusLongName%, CaptionSource_BatchStatus, yes
    %BatchStateLongName%, CaptionSource_BatchState, yes
    %ModelStateLongName%,CaptionSource_ModelState,yes
    %UserNameLongName%,CaptionSource_UserName,yes
    %ProgressTextLongName%,CaptionSource_ProgressText,yes
    %ProgressPercentLongName%,CaptionSource_ProgressPercent,yes
    %CurrentSequenceFileLongName%,CaptionSource_CurrentSequenceFile,yes
    %CurrentSequenceLongName%,CaptionSource_CurrentSequence,yes
    %CurrentStepGroupLongName%,CaptionSource_CurrentStepGroup,yes
    %CurrentStepLongName%,CaptionSource_CurrentStep,yes
    %CurrentStepIndex_ZeroBasedLongName%,CaptionSource_CurrentStepIndex_ZeroBased,yes
    %CurrentTestIndex_OneBasedLongName%, CaptionSource_CurrentTestIndex_OneBased, yes
    %NumberOfStepsLongName%, CaptionSource_NumberOfSteps, yes
    %CurrentExecutionLongName%, CaptionSource_CurrentExecution, yes
    %CurrentThreadLongName%, CaptionSource_CurrentThread, yes
    %CurrentCallStackEntryLongName%, CaptionSource_CurrentCallStackEntry, yes
    %CurrentProcessModelFileLongName%, CaptionSource_CurrentProcessModelFile, yes
  • CaptionSource_ModelState–(Value: 7) Displays a description of the execution state of the current execution. For example, this caption might display Initializing, Testing, Waiting, or Completed [Passed]. This caption source applies only to the ExecutionView Manager control.
  • CaptionSource_NotASource–(Value: 0) Guaranteed to never be a valid caption source specifier.
  • CaptionSource_NumberOfSteps–(Value: 22) Displays the number of steps in the currently executing or currently selected step group. This caption source applies to the ExecutionView Manager and SequenceFileView Manager controls.
  • CaptionSource_NumberOfTests–(Value: 23) Displays the number of steps in the currently executing or currently selected step group. The description uses the word test in place of the word step. This caption source applies to the ExecutionView Manager and SequenceFileView Manager controls.
  • CaptionSource_ProgressPercent–(Value: 10) Displays the progress percentage information for the current execution. This caption indicates the progress of operations for which the execution chooses to report the amount of progress. The caption does not necessarily reflect the progress of the execution as a whole. A process model sends the progress percent through the UIMsg_ProgressPercent UIMessageCode. This caption source applies only to the ExecutionView Manager control.
  • CaptionSource_ProgressText–(Value: 9) Displays the progress message for the current execution. A process model sends the progress text through the UIMsg_ProgressText UIMessageCode. This caption source applies only to the ExecutionView Manager control.
  • CaptionSource_ReportLocation–(Value: 28) Displays the location of the report for the current execution. The Report.Location property specifies the display value for a report. This caption source applies only to the ExecutionView Manager control.
  • CaptionSource_SelectedSteps_ZeroBased–(Value: 20) Displays a description of which steps are selected. The description uses zero-based indexes. This caption source applies to the ExecutionView Manager and SequenceFileView Manager controls.
  • CaptionSource_SelectedTests_OneBased–(Value: 21) Displays a description of which steps are selected. The description uses one-based indexes and the word test in place of the word step. This caption source applies to the ExecutionView Manager and SequenceFileView Manager controls.
  • CaptionSource_TestSocketIndex–(Value: 29) Displays the zero-based index of the test socket for the current execution. Displays nothing when the execution is not participating in a multi-socket test process. A process model sends the text socket index through the UIMsg_ModelState_BeginTesting and UIMsg_ModelState_Waiting UIMessageCodes. This caption source applies only to the ExecutionView Manager control.
  • CaptionSource_Time–(Value: 30) Displays the current time using the system time format.
  • CaptionSource_UserName–(Value: 8) Displays the name of the current user. When you pass True to the long name option for the caption, the caption displays the full user name. Otherwise, the caption displays the user login name.
  • CaptionSource_UUTSerialNumber–(Value: 2) Displays the serial number of the UUT for the current execution. A process model sends the UUT serial number through the UIMsg_ModelState_Identified UIMessageCode. This caption source applies only to the ExecutionView Manager control.
  • CaptionSource_UUTStatus–(Value: 3) Displays the result status of the UUT for the current execution. A process model sends the UUT status through the UIMsg_ModelState_TestingComplete UIMessageCode. This caption source applies only to the ExecutionView Manager control.

See Also

ApplicationMgr.ConnectCaption

ApplicationMgr.GetCaptionText

ExecutionViewMgr.ConnectCaption

ExecutionViewMgr.GetCaptionText

Label

Report.Location

SequenceFileViewMgr.ConnectCaption

SequenceFileViewMgr.GetCaptionText

StatusBarPane

UIMessageCodes

WAS THIS ARTICLE HELPFUL?

Not Helpful