Section 4. trace log – MagTek MAGTEK User Manual
Page 51
45
SECTION 4. TRACE LOG
The trace log is a file that logs the communications between the driver and a device. The trace
log is used for helping application and device developers during the device development phase.
It can be used for diagnosing problems with existing applications. The log can capture complete
blocks transmitted and received by the driver or just the application message portion of blocks.
The trace file is a text file and can be read using a standard text editor.
The trace log utility can be enabled and configured using device instance properties. Details of
these properties are in the device instance properties section of this document. These properties
control enabling/disabling logging of the entire block, enabling/disabling logging of only the
application message portion of the block, the name and path of the trace log file, the size of the
trace log file and clearing of the trace log file. The properties are
Port.TraceEnabled,
Core.TraceEnabled, TraceFilePath, MaxTraceFileSize and AppendTraceFile
respectively.
Each line in the trace file has the following format:
C
R
L
F
where each field is described below:
The datetime stamp format is as follows:
MM/dd/YYY
hh:mm:ss:ms
Under Windows 98, Me, time is calculated at GMT.
Under Windows 2000, NT and XP time is the local time.
Origin of entry:
MSG – application message portion of block
FRM – entire block including frame
Direction of data with respect to the host:
In – incoming
Out
-
outgoing
:
Data logged in hexadecimal format.
C
R
L
F:
Carriage Return / Line Feed
The following is an example of a trace entry for an application message request and response
(Device application Get Model Number property):