windows-server-2003/sdktools/trace/traceview/traceviewhelp/traceeventconsumptioninterf...

<html>

<head>
<meta http-equiv=Content-Type content="text/html; charset=windows-1252">
<meta name=Generator content="Microsoft Word 10 (filtered)">
<title>Creating Trace Log Sessions</title>

<style>
<!--
 /* Font Definitions */
 @font-face
	{font-family:"MS Sans Serif";
	panose-1:0 0 0 0 0 0 0 0 0 0;}
 /* Style Definitions */
 p.MsoNormal, li.MsoNormal, div.MsoNormal
	{margin:0in;
	margin-bottom:.0001pt;
	font-size:12.0pt;
	font-family:"Times New Roman";}
h1
	{margin-top:12.0pt;
	margin-right:0in;
	margin-bottom:3.0pt;
	margin-left:0in;
	page-break-after:avoid;
	font-size:16.0pt;
	font-family:Arial;
	font-weight:bold;}
h3
	{margin-right:0in;
	margin-left:0in;
	font-size:13.5pt;
	font-family:"Times New Roman";
	font-weight:bold;}
h4
	{margin-top:12.0pt;
	margin-right:0in;
	margin-bottom:3.0pt;
	margin-left:0in;
	page-break-after:avoid;
	font-size:14.0pt;
	font-family:"Times New Roman";
	font-weight:bold;}
a:link, span.MsoHyperlink
	{color:blue;
	text-decoration:underline;}
a:visited, span.MsoHyperlinkFollowed
	{color:blue;
	text-decoration:underline;}
p
	{margin-right:0in;
	margin-left:0in;
	font-size:12.0pt;
	font-family:"Times New Roman";}
@page Section1
	{size:8.5in 11.0in;
	margin:1.0in 1.25in 1.0in 1.25in;}
div.Section1
	{page:Section1;}
 /* List Definitions */
 ol
	{margin-bottom:0in;}
ul
	{margin-bottom:0in;}
-->
</style>

</head>

<body lang=EN-US link=blue vlink=blue>

<div class=Section1>

<h1><span style='font-size:24.0pt;font-family:"Times New Roman"'>Trace Event
Consumption Interface</span></h1>

<p>The TraceView command-line interface uses the following command-line syntax:</p>

<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; traceview
[action] [options] | [-h | -help | -?]</p>

<p>The possible actions for the TraceView command-line interface are broken
down into three categories:</p>

<ul style='margin-top:0in' type=disc>
 <li class=MsoNormal>Control</li>
 <li class=MsoNormal>Consumption</li>
 <li class=MsoNormal style='margin-bottom:12.0pt'>Parsing</li>
</ul>

<p class=MsoNormal>The Consumption actions are used to control the receipt,
formatting, and display of trace events from an active trace event provider or
providers.&nbsp; The following table describes the trace event consumption
interface options:</p>

<p class=MsoNormal>&nbsp;</p>

<p class=MsoNormal>&nbsp;</p>

<table class=MsoTableGrid border=1 cellspacing=0 cellpadding=0 width=648
 style='width:6.75in;margin-left:-.05in;border-collapse:collapse;border:none'>
 <tr>
  <td width=192 valign=bottom style='width:2.0in;border:solid windowtext 1.0pt;
  padding:0in 5.4pt 0in 5.4pt'>
  <p>Consumption Actions:</p>
  </td>
  <td width=456 valign=bottom style='width:4.75in;border:solid windowtext 1.0pt;
  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
  <p>&nbsp;</p>
  </td>
 </tr>
 <tr>
  <td width=192 valign=bottom style='width:2.0in;border:solid windowtext 1.0pt;
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
  <p>-process</p>
  </td>
  <td width=456 valign=bottom style='width:4.75in;border-top:none;border-left:
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
  padding:0in 5.4pt 0in 5.4pt'>
  <p>Consume trace events</p>
  </td>
 </tr>
 <tr>
  <td width=192 valign=bottom style='width:2.0in;border:solid windowtext 1.0pt;
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
  <p>&nbsp;</p>
  </td>
  <td width=456 valign=bottom style='width:4.75in;border-top:none;border-left:
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
  padding:0in 5.4pt 0in 5.4pt'>
  <p>&nbsp;</p>
  </td>
 </tr>
 <tr>
  <td width=192 valign=bottom style='width:2.0in;border:solid windowtext 1.0pt;
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
  <p>Consumption Options:</p>
  </td>
  <td width=456 valign=bottom style='width:4.75in;border-top:none;border-left:
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
  padding:0in 5.4pt 0in 5.4pt'>
  <p>&nbsp;</p>
  </td>
 </tr>
 <tr>
  <td width=192 valign=bottom style='width:2.0in;border:solid windowtext 1.0pt;
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
  <p>-o &lt;file&gt;</p>
  </td>
  <td width=456 valign=bottom style='width:4.75in;border-top:none;border-left:
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
  padding:0in 5.4pt 0in 5.4pt'>
  <p>Output filename for listing file</p>
  </td>
 </tr>
 <tr>
  <td width=192 valign=bottom style='width:2.0in;border:solid windowtext 1.0pt;
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
  <p>-display</p>
  </td>
  <td width=456 valign=bottom style='width:4.75in;border-top:none;border-left:
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
  padding:0in 5.4pt 0in 5.4pt'>
  <p>Display output</p>
  </td>
 </tr>
 <tr>
  <td width=192 valign=bottom style='width:2.0in;border:solid windowtext 1.0pt;
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
  <p>-displayonly</p>
  </td>
  <td width=456 valign=bottom style='width:4.75in;border-top:none;border-left:
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
  padding:0in 5.4pt 0in 5.4pt'>
  <p>Display output. Don't write to file</p>
  </td>
 </tr>
 <tr>
  <td width=192 valign=bottom style='width:2.0in;border:solid windowtext 1.0pt;
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
  <p>-nosummary</p>
  </td>
  <td width=456 valign=bottom style='width:4.75in;border-top:none;border-left:
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
  padding:0in 5.4pt 0in 5.4pt'>
  <p>Don't create the summary file</p>
  </td>
 </tr>
 <tr>
  <td width=192 valign=bottom style='width:2.0in;border:solid windowtext 1.0pt;
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
  <p>-noprefix</p>
  </td>
  <td width=456 valign=bottom style='width:4.75in;border-top:none;border-left:
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
  padding:0in 5.4pt 0in 5.4pt'>
  <p>Suppress any defined TRACE_FORMAT_PREFIX</p>
  </td>
 </tr>
 <tr>
  <td width=192 valign=bottom style='width:2.0in;border:solid windowtext 1.0pt;
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
  <p>-ods</p>
  </td>
  <td width=456 valign=bottom style='width:4.75in;border-top:none;border-left:
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
  padding:0in 5.4pt 0in 5.4pt'>
  <p>Display output using OutputDebugString</p>
  </td>
 </tr>
 <tr>
  <td width=192 valign=bottom style='width:2.0in;border:solid windowtext 1.0pt;
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
  <p>-summaryonly</p>
  </td>
  <td width=456 valign=bottom style='width:4.75in;border-top:none;border-left:
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
  padding:0in 5.4pt 0in 5.4pt'>
  <p>Don't create the listing file</p>
  </td>
 </tr>
 <tr>
  <td width=192 valign=bottom style='width:2.0in;border:solid windowtext 1.0pt;
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
  <p>-tmf &lt;file&gt;</p>
  </td>
  <td width=456 valign=bottom style='width:4.75in;border-top:none;border-left:
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
  padding:0in 5.4pt 0in 5.4pt'>
  <p>Extract trace format information from specified TMF file</p>
  </td>
 </tr>
 <tr>
  <td width=192 valign=bottom style='width:2.0in;border:solid windowtext 1.0pt;
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
  <p>-pdb &lt;file&gt;</p>
  </td>
  <td width=456 valign=bottom style='width:4.75in;border-top:none;border-left:
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
  padding:0in 5.4pt 0in 5.4pt'>
  <p>Extract trace format information from specified PDB file</p>
  </td>
 </tr>
 <tr>
  <td width=192 valign=bottom style='width:2.0in;border:solid windowtext 1.0pt;
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
  <p>-p &lt;path&gt;</p>
  </td>
  <td width=456 valign=bottom style='width:4.75in;border-top:none;border-left:
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
  padding:0in 5.4pt 0in 5.4pt'>
  <p>TMF file search path</p>
  </td>
 </tr>
 <tr>
  <td width=192 valign=bottom style='width:2.0in;border:solid windowtext 1.0pt;
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
  <p>-v</p>
  </td>
  <td width=456 valign=bottom style='width:4.75in;border-top:none;border-left:
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
  padding:0in 5.4pt 0in 5.4pt'>
  <p>Verbose Display</p>
  </td>
 </tr>
</table>

<p class=MsoNormal>&nbsp;</p>

<p class=MsoNormal>&nbsp;</p>

<p class=MsoNormal style='margin-left:.25in'>&nbsp;</p>

<table class=MsoNormalTable border=0 cellspacing=0 cellpadding=0 width=873
 style='width:654.65pt'>
 <tr style='height:.05in'>
  <td style='background:aqua;padding:.75pt .75pt .75pt .75pt;height:.05in'>
  <p class=MsoNormal style='line-height:3.6pt'><span style='font-size:2.0pt'>&nbsp;</span></p>
  </td>
 </tr>
</table>

<p><b><span style='font-size:10.0pt;font-family:"MS Sans Serif"'>� Microsoft Corporation
2002</span></b></p>

<h3><span style='font-weight:normal'>&nbsp;</span></h3>

</div>

</body>

</html>