Open Capture File

You are here: Commands > Capture File Analysis/Reporting > Open Capture File

Open Capture File

The Open Capture File command tells Frontline software to open the specified capture file. The Open Capture File command has one parameter indicating the path and name of the file to open. The following is an example of the command string for this command.

Open Capture File;C:\MyFiles\newfile.cfa

If an error occurs – which could be due to the file not existing, a failure notification response is sent from the server. The form for the failure notification response is the following.

Open Capture File;FAILED;Timestamp=10/26/2009 4:13:54 PM;Reason=File (C:\temp\abc.cfa) does not exist

A successful attempt opening the capture file results in a successful notification response. The form for the successful notification response is the following.

Open capture file;SUCCEEDED;Timestamp=10/26/2009 4:27:38 PM

By default, the successful notification response is sent immediately after the capture file is opened successfully. However the frame compiler may run for several minutes after a large capture file is opened. If an HTML Export command or Export command is sent before the frame compiler completes, the exported file will not contain all the frames.

If it is important to wait for the frame compiler to complete before proceeding the optional Notify= parameter specification can be used to delay sending the success notification. The format for using the Notify= parameter is as follows:

Notify=< 0 | 1>

Where:

0 : Indicates the default behavior of sending the success notification immediately after the capture file is successfully opened.

1 : Indicates to send the success notification after the frame compiler has finished compiling all the frames.

Following is an example of the command format to wait until the frame compiler has finished would:

Open Capture File;C:\users\public\documents\Frontline Test Equipment\My Capture Files\my cap.cfa;Notify=1

If an invalid Notify= value is specified the following failure notification response is sent:

OPEN CAPTURE FILE;FAILED;Timestamp=8/23/2012 4:03:34 PM;Reason=Reason=Invalid Notify option