Navigation Functions

GotoEvent()

Forces the application to jump to some trace event and shows it in the main trace view.

GotoEvent(level, index)
GotoEvent()

Remarks

If no parameters are specified, the application jumps to the current event being processed by VSE.

If wrong parameters are specified (for example, index exceeding the maximal index for the specified transaction level), the function does nothing and an error message is sent to the output window.

Example

  …
  if(Something == interesting) GotoEvent(); # Go to the current event.
  …
  if(SomeCondition) 
  {
    interesting_level  = in.Level;
    interesting_index = in.Index;
  }
…
OnFinishScript()
{
  …
  # Go to the interesting event.
  GotoEvent(interesting_level, interesting_index); 
}

SetMarker()

Sets a marker for some trace event.

SetMarker(marker_text)
SetMarker(marker_text, level, index)

Remarks

If no parameters are specified, other than marker_text, the application sets the marker to the current event being processed by VSE.

If the wrong parameters are specified (for example, index exceeding the maximal index for the specified transaction level), the function does nothing and an error message is sent to the output window.

Example

…
# Set marker to the current event.
if(Something == interesting) SetMarker("!!! Something cool !!!");
…
if(SomeCondition) 
{ 	 
  interesting_level = in.Level;
  interesting_index = in.Index;
}
…
OnFinishScript()
{
  …
  # Set marker to the interesting event.
  SetMarker("  !!! Cool Marker !!! ", interesting_level, interesting_index); 
  
  # Go to the interesting event.
  GotoEvent(interesting_level, interesting_index);
} 

MarkerContainsText()

Checks if the current trace event contains the specified text.

MarkerContainsText()
MarkerContainsText( text )

Remarks

If no parameter is specified, the function will check whether or not the trace event has any markers.

Example

…
# Check if the current event has marker.
if( MarkerContainsText() ) 
{
  ReportText(“ There is a marker!”);

  # Check if the current trace event marker contains “Triggered” phrase.
  If( MarkerContainsText(“Triggered”) )
    {
      ReportText(“ Current marker already has <Triggered> text!”);
    }
}
…