97 lines
6.2 KiB
HTML
97 lines
6.2 KiB
HTML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE html
|
|
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html lang="en-us" xml:lang="en-us">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<meta name="security" content="public" />
|
|
<meta name="Robots" content="index,follow" />
|
|
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
|
|
<meta name="DC.Type" content="reference" />
|
|
<meta name="DC.Title" content="History log and trace files" />
|
|
<meta name="abstract" content="History logs and trace files allow you to log information about your programs." />
|
|
<meta name="description" content="History logs and trace files allow you to log information about your programs." />
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikappsv.htm" />
|
|
<meta name="copyright" content="(C) Copyright IBM Corporation 1999, 2006" />
|
|
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 1999, 2006" />
|
|
<meta name="DC.Format" content="XHTML" />
|
|
<meta name="DC.Identifier" content="logs" />
|
|
<meta name="DC.Language" content="en-us" />
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
|
<!-- US Government Users Restricted Rights -->
|
|
<!-- Use, duplication or disclosure restricted by -->
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
|
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
|
|
<link rel="stylesheet" type="text/css" href="./ic.css" />
|
|
<title>History log and trace files</title>
|
|
</head>
|
|
<body id="logs"><a name="logs"><!-- --></a>
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
|
<h1 class="topictitle1">History log and trace files</h1>
|
|
<div><p>History logs and trace files allow you to log information about
|
|
your programs.</p>
|
|
<div class="section"><h4 class="sectiontitle">History log:</h4><p>The log functions allow you to write
|
|
message text to the <span class="keyword">iSeries™ Access for Windows<sup>®</sup></span> History
|
|
Log. The message text needs to be displayable ASCII character data.</p>
|
|
<p><span class="keyword">iSeries Access for Windows</span> has instrumented all of its
|
|
programs to log messages to the <span class="keyword">iSeries Access for Windows</span> History
|
|
Log. Messages also are logged by the DLLs that are supplied with the product.</p>
|
|
<p>The
|
|
History Log is a file where message text strings are logged through the <span class="apiname">cwbSV_LogMessageText</span> API.
|
|
The log provides a history of activity that has taken place on the client
|
|
workstation.</p>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Trace files:</h4><p>The trace functions allow you to log
|
|
low-level events that occur as your program runs. For example, you can track
|
|
various return codes that were received from calling other functions. If your
|
|
program is sending and receiving data, you may want to log the significant
|
|
fields of the data (for example, function byte or bytes, and data length)
|
|
to aid in debugging if something goes wrong. Use the <strong>Detailed data trace</strong> function
|
|
(<span class="apiname">cwbSV_LogTraceData</span>) to accomplish this. </p>
|
|
<p>Another
|
|
form of trace, the <strong>Entry Point trace</strong> function, allows you to track
|
|
entry into and exit from your routines. <span class="keyword">iSeries Access for Windows</span> defines
|
|
two different types of entry point trace points: </p>
|
|
<dl><dt class="dlterm">API trace point:</dt>
|
|
<dd>Use the API (application programming interface) trace point to track entry
|
|
and exit from routines that you externalize to other programs. </dd>
|
|
<dt class="dlterm">SPI trace point:</dt>
|
|
<dd>Use the SPI (system programming interface) trace point to track entry
|
|
and exit from key internal routines of the program that you want to trace.</dd>
|
|
</dl>
|
|
<p>The key piece of information that is provided on the APIs
|
|
is a one-byte eventID. It allows you to identify which API or SPI is being
|
|
entered or exited. Data such as input values can be traced on entry, as well
|
|
as tracing output values on exit from a routine. These trace functions are
|
|
intended to be used in pairs (for example, <span class="apiname">cwbSV_LogAPIEntry</span> and <span class="apiname">cwbSV_LogAPIExit</span>)
|
|
in the routines that utilize them. These types of trace points provide a record
|
|
of flow of control through the code.</p>
|
|
<p><span class="keyword">iSeries Access for Windows</span> has
|
|
instrumented the procedural APIs described in this topic with Entry/Exit API
|
|
trace points. When one of these procedural APIs is called, entry and exit
|
|
trace points are logged to the Entry Point trace file if tracing is active.
|
|
The Entry/Exit SPI trace logs internal calling sequences. The Detailed data
|
|
trace function logs data which is useful in debugging problems.</p>
|
|
<p><span class="keyword">iSeries Access for Windows</span> supports the following types
|
|
of traces: </p>
|
|
<dl><dt class="dlterm">Detailed (Data):</dt>
|
|
<dd>Allows you to trace a buffer of information at a point in your code via
|
|
the <span class="apiname">cwbSV_LogTraceData</span> API. This buffer can be a mixture
|
|
of ASCII and/or binary values (for example, C-struct). The data is logged
|
|
in binary form.</dd>
|
|
<dt class="dlterm">Entry/Exit (API):</dt>
|
|
<dd>A specialized form of trace which allows you to trace entry into and exit
|
|
from your externalized routines via the <span class="apiname">cwbSV_LogAPIEntry</span> and <span class="apiname">cwbSV_LogAPIExit</span> APIs.</dd>
|
|
<dt class="dlterm">Entry/Exit (SPI):</dt>
|
|
<dd>A specialized form of trace that allows you to trace entry into and exit
|
|
from your key internal routines by using the <span class="apiname">cwbSV_LogSPIEntry</span> and <span class="apiname">cwbSV_LogSPIExit</span> APIs.</dd>
|
|
</dl>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikappsv.htm" title="The iSeries Access for Windows Serviceability application programming interfaces (APIs) allow you to log service file messages and events within your program.">iSeries Access for Windows Serviceability APIs</a></div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html> |