This group of functions covers VSE capabilities to export data into trace files.
CreateTraceFile()
Creates a trace file.
CreateTraceFile( file_path )
|
Parameters |
|
|---|---|
|
file_path |
Full path to the trace file to be created. (For ‘\’ use ‘\\’) |
Return Values
The "handle" to the trace file to be used in other trace-file-related functions.
Remarks
If file_path contains just a file name (such as test.usb), the trace file is created in the application folder.
Example
…
set trace_handle = 0;
…
# Create a trace file in "C:\\data_output.usb".
trace_handle = CreateTraceFile("C:\\data_output.usb");
…
# Add the current trace event (frame) to the trace file.
AddEventToTraceFile(trace_handle);
…
CloseTraceFile(trace_handle); # Close the file.
…
CloseTraceFile()
Closes an open trace file. All attempts to add trace data to a closed trace file are ignored.
CloseTraceFile( tracefile_handle )
|
Parameters |
|
|---|---|
|
tracefile_handle |
Trace file "handle" returned by the CreateTraceFile() function. |
Example
…
set trace_handle = 0;
…
# Create a trace file in "C:\\data_output.usb".
trace_handle = CreateTraceFile("C:\\data_output.usb");
…
# Add the current trace event (frame) to the trace file.
AddEventToTraceFile(trace_handle);
…
CloseTraceFile(trace_handle); # Close the file.
…
AddEventToTraceFile()
Adds the current trace event (such as frames) to the trace file.
AddEventToTraceFile ( tracefile_handle )
|
Parameters |
|
|---|---|
|
tracefile_handle |
Trace file "handle" returned by the CreateTraceFile() function. |
Remarks
If this function is called multiple times for the same event, only the first call adds an event to the trace file. All the other calls are ignored.
Example
…
set trace_handle = 0;
…
# Create a trace file in "C:\\data_output.usb".
trace_handle = CreateTraceFile("C:\\data_output.usb");
…
# Add the current trace event (frame) to the trace file.
AddEventToTraceFile(trace_handle);
…
CloseTraceFile(trace_handle); # Close the file.
…
OpenTraceFile()
Opens a trace file in the application.
OpenTraceFile (tracefile_path)
|
Parameters |
|
|---|---|
|
tracefile_path |
Path to a trace file to open. |
Remarks
If tracefile_path contains just a file name (such as test.usb), VSE looks for a trace file with such a name in the application folder.
Example
…
set trace_handle = 0;
…
# Create a trace file in "C:\\data_output.usb".
trace_handle = CreateTraceFile("C:\\data_output.usb");
…
# Add the current trace event (frame) to the trace file.
AddEventToTraceFile(trace_handle);
…
CloseTraceFile(trace_handle); # Close the trace file.
…
# Instruct the application to open the trace file "C:\\data_output.usb".
OpenTraceFile("C:\\data_output.usb");