StartTrace Method

In This Topic

Starts capturing data coming from the host to a disk file.

Syntax

Visual Basic
C#

'Declaration
 
Function StartTrace( _
   ByVal fileName As String, _
   ByVal fileExistsOption As TraceFileExistsOption, _
   ByVal formatOption As TraceFormatOption _
) As ReturnCode

'Usage
 
Dim instance As ITerminal
Dim fileName As String
Dim fileExistsOption As TraceFileExistsOption
Dim formatOption As TraceFormatOption
Dim value As ReturnCode
 
value = instance.StartTrace(fileName, fileExistsOption, formatOption)

ReturnCode StartTrace( 
   string fileName,
   TraceFileExistsOption fileExistsOption,
   TraceFormatOption formatOption
)

Parameters

fileName: Specifies the file to which data is written.
fileExistsOption: Specifies what to do if the file already exists. The default is OpenError.
formatOption: Specifies what kind of trace to perform. The default is TraceDefault.

Return Value

ReturnCode value indicates success or error conditions.

Remarks

Data being transmitted to the host can also be captured. The captured data includes all escape sequences and control codes, but does not include flow control, such as Xon/Xoff characters. The data is captured in binary format and is not translated in any way.

Reference

ITerminal Interface
ITerminal Members

Send Feedback