WIA Trace Viewer Tool

WIA Trace Viewer Tool

[This is preliminary documentation and subject to change.]

S= UMMARY

<= o:p>

Wiatr= cvw.exe is an application that allows developers to view WIA trace output. This application supports filtering by process ID, thread ID, and module name. It also supports changing WIA traci= ng parameters for each module. By default, it opens the following trace file: %WINDIR%\Debug\WIA\wiatrace.log.

C= ommand Line Parameters

<= o:p>

The WIA Trace Viewer tool can be launched in default mode (without command-line parameters), which opens %WINDIR%\Debug\WIA\wiatrace.log, loads all entries from it, and then displa= ys it in the UI.

Usage: wiatrcvw [-i ini= file] [-m maskfile] tracefile

= wiatrcvw -f [module.ext]

= wiatrcvw -t [filename.log]

-i inifile

Specify an alternate initialization file. Default: %userprofile%\Application Data\wiatrcvw.ini

-m maskfile

Specify an alternate mask file. Default: %userprofile%\Application Data\wiatrcvw.ini

-f [module.ext]

Display the module trace flags for all modules, or the optional module specified as an argument, and then exit the program.

-t [filename.log]

Truncate the supplied trace file. If a file is not specified, trunca= te %WINDIR%\Debug\WIA\wiatrace.log.

tracefile

Trace file to read during startup. Default: %WINDIR%\Debug\WIA\wiatrace.log

<= o:p>

UI Elements

<= o:p>

The user interface is divided i= nto five sections:

· = Menu.

· = Toolbar.

· = Tree view of process and thread IDs.

· = List of modules.

· = Actual trace view.

Menu:

File= > Open &nb= sp; = &nb= sp; Opens another trace file for viewing.

File= > Save As… = ; &n= bsp; = ; Save trace file under different name.

File= > Save Selection As.. = ; <= /span>Save highlighted portion of the trace to file.

File= > Close &n= bsp; = ; &n= bsp; Close current trace file.

File= > Truncate “xxx.log” &= nbsp; &nbs= p; Truncate all records from current trace file.

File= > Monitor File Changes = ; = Put WiaTrcVw.exe into a mode where it will continually refresh the display as t= race file changes. Default is to wait for an explicit refresh from the user (F5)= .

File= > Exit &nb= sp; = &nb= sp; Close the application.

Edit= > Copy &nb= sp; = &nb= sp; Copy highlighted rows from trace view (as text).

Edit= > Select All &nb= sp; = &nb= sp; Select all rows of trace view.

Edit= > Find &nb= sp; = &nb= sp; Sear= ch for given text through trace file.

Edit= > Find Next &nbs= p; &= nbsp; &nbs= p; Search again.

Edit= > Go To Line… &n= bsp; = ; Skip to absolute position in trace file.

Edit= > Find Previous Error = &nb= sp; Find last error statement before current trace line.

Edit= > Find Next Error &nbs= p; &= nbsp; Find next error statement after current trace line.

Edit= > Debug Process = &nb= sp; Launch ntsd.exe attached to currently selected process.

Edit= > Edit File &nbs= p; &= nbsp; &nbs= p; Launch default editor for the source file name that is contained in current trace = file entry.

Edit= > Properties &nb= sp; = &nb= sp; Show detailed information on current trace file entry.

View= > Refresh = &nb= sp; = Reload current trace file.

View= > Select Just This Thread &n= bsp; Display only trace file entries generated by current thread.

View= > Select Just This Process &= nbsp; Display only trace file entries generated by current process.

View= > Select Just This Module &n= bsp; Display only trace file entries generated by current module.

View= > Select All Trace Criteria = Remove all filters (display entire trace file).

View= > Set Current Module Flags &= nbsp; Open dialog box that allows users to set/reset trace flags for currently selected module.

View= > Set Module Flags &nb= sp; = Open dialog box that allows users to set/reset trace flags for all registered modules.

View= > Show Filter Pane &nb= sp; = Show/hide filter pane (tree view of process and thread IDs and list of modules). Defa= ult: Show.

View= > Options… = ; &n= bsp; = ; Show dialog for setting various options:

<= span style=3D'mso-list:Ignore'>–

The previous pane displays the processes and threads within a trace file. Each process and thread includes= a check box which can be used to filter out or include trace output when going into trace view. In this example, logged trace information from process 2948 and from thread 2132 in process 3784 will not be displayed.

Modules:

The previous pane displays all registered modules that are present in current trace file. As for processes/threads, each module can be turned on and turned off (which is ve= ry helpful in terms of filtering unwanted content from trace file).=

Trace Text:

The previous pane displays form= atted and indented trace file content. Each thread’s trace is displayed in = different colors. The icons represent the severity of the message:<= /p>

Function Entry

Function Exit

3D"*" Trace statement

3D"*" Warning statement=

Error statement

<= o:p>

M= odule Trace Settings Dialog

<= o:p>

The Module Trace Setting dialog displays four tabs.

General

Displays the module name, and a= llows users to set a maximum trace array size and trace level for each module.

Flags

This is most important tab. It = allows setting and resetting trace flags for given module. Flags are:

<= span style=3D'mso-list:Ignore'>–o&nb= sp; Error

= o&nb= sp; Warning

= o&nb= sp; Object Tracking Output

= o&nb= sp; Trace

= o&nb= sp; Function Entry/Exit<= /span>

<= span style=3D'mso-list:Ignore'>–o&nb= sp; DebugBreak on Error<= /span>

= o&nb= sp; Wrap File

= o&nb= sp; Append Trace File

= o&nb= sp; No Trace Array

= o&nb= sp; Only Trace Array

= o&nb= sp; Indent Debugger String

<= span style=3D'mso-list:Ignore'>–o&nb= sp; Filename and Line Number

= o&nb= sp; Timestamp

= o&nb= sp; Process and Thread ID

= o&nb= sp; Module Name

= o&nb= sp; Project Identifier

= o&nb= sp; Severity Identifier<= /span>

= o&nb= sp; Trace Mask

o Indenting

Trace Masks

Sets custom trace masks for each module.

Debug Heap

Controls debug heap parameters.= It is recommended that you use the def= ault parameter values.