127 lines
8.3 KiB
HTML
127 lines
8.3 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="iSeries Access for Windows Serviceability APIs" />
|
||
|
|
<meta name="abstract" content="The iSeries Access for Windows Serviceability application programming interfaces (APIs) allow you to log service file messages and events within your program." />
|
||
|
|
<meta name="description" content="The iSeries Access for Windows Serviceability application programming interfaces (APIs) allow you to log service file messages and events within your program." />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikapiinterfaces.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaiklogs.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikerrhndls.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaiksvctypuse.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaiksvcapilist1.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaiksvcapilist2.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaiksvcapilist3.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaiksvcapilist4.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaiksvcapilist5.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaiksvcapiuseex.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikrcsvcapis.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="appsv" />
|
||
|
|
<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>iSeries Access
|
||
|
|
for Windows Serviceability
|
||
|
|
APIs</title>
|
||
|
|
</head>
|
||
|
|
<body id="appsv"><a name="appsv"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">iSeries Access
|
||
|
|
for Windows Serviceability
|
||
|
|
APIs</h1>
|
||
|
|
<div><p>The <span class="keyword">iSeries™ Access for Windows<sup>®</sup></span> Serviceability
|
||
|
|
application programming interfaces (APIs) allow you to log service file messages
|
||
|
|
and events within your program.</p>
|
||
|
|
<div class="section"><p>A set of APIs allows you to read the records from the service
|
||
|
|
files that are created. These APIs allow you to write a customized service-file
|
||
|
|
browser.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><p>The following general categories of <span class="keyword">iSeries Access for Windows</span> Serviceability
|
||
|
|
API functions are provided: </p>
|
||
|
|
<ul><li>Writing message text to the History log</li>
|
||
|
|
<li>Writing Trace entries to the Trace file</li>
|
||
|
|
<li>Reading service files</li>
|
||
|
|
<li>Retrieving message text that is associated with error handles</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Why you should use <span class="keyword">iSeries Access for Windows</span> Serviceability
|
||
|
|
APIs:</h4><p>The <span class="keyword">iSeries Access for Windows</span> Serviceability
|
||
|
|
APIs provide an efficient means of adding message logging and trace points
|
||
|
|
to your code. Incorporate these functions into programs that are shipped as
|
||
|
|
part of your product, and use them to help debug programs that are under development.
|
||
|
|
The file structure supports multiple programs (that are identified by unique
|
||
|
|
product and component strings) logging to the same files simultaneously. This
|
||
|
|
provides a complete picture of logging activity on the client workstation.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle"><span class="keyword">iSeries Access for Windows</span> Serviceability
|
||
|
|
APIs required files:</h4>
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" width="26.11683848797251%" id="d0e84">Header file</th>
|
||
|
|
<th valign="top" width="29.896907216494846%" id="d0e86">Import library</th>
|
||
|
|
<th valign="top" width="43.986254295532646%" id="d0e88">Dynamic Link Library</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" width="26.11683848797251%" headers="d0e84 ">cwbsv.h</td>
|
||
|
|
<td valign="top" width="29.896907216494846%" headers="d0e86 ">cwbapi.lib</td>
|
||
|
|
<td valign="top" width="43.986254295532646%" headers="d0e88 ">cwbsv.dll</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Programmer's Toolkit:</h4><p>The Programmer's Toolkit provides
|
||
|
|
Serviceability documentation, access to the cwbsv.h header file, and links
|
||
|
|
to sample programs. To access this information, open the Programmer's Toolkit
|
||
|
|
and select <span class="menucascade"><span class="uicontrol">Error Handling</span> > <span class="uicontrol">C/C++
|
||
|
|
APIs</span></span>.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"> <div class="note"><span class="notetitle">Note:</span> By using the code examples, you agree to the terms of the <a href="codedisclaimer.htm">Code license and disclaimer information</a>.</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<ul class="ullinks">
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaiklogs.htm">History log and trace files</a></strong><br />
|
||
|
|
History logs and trace files allow you to log information about your programs.</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikerrhndls.htm">Error handles</a></strong><br />
|
||
|
|
The error handle functions allow you to create an error handle
|
||
|
|
(<span class="apiname">cwbSV_CreateErrHandle</span>) to use on <span class="keyword">iSeries Access for Windows</span> APIs
|
||
|
|
that support it.</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaiksvctypuse.htm">Typical use of Serviceability APIs</a></strong><br />
|
||
|
|
Typical uses of serviceability APIs include history logs and error handles.</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaiksvcapilist1.htm">Serviceability APIs list: Writing to history log</a></strong><br />
|
||
|
|
Use these APIs to write message text to a history log</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaiksvcapilist2.htm">Serviceability APIs list: Writing trace data</a></strong><br />
|
||
|
|
Use these APIs to write trace data to a detail trace file</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaiksvcapilist3.htm">Serviceability API list: Writing trace points</a></strong><br />
|
||
|
|
Use these APIs to write trace points to an entry/exit trace file</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaiksvcapilist4.htm">Serviceability API list: Reading service files</a></strong><br />
|
||
|
|
Use these APIs to read service files, service file records, and service file header information. Additionally, you can read history log service records, detail trace file service records, and entry/exit trace file service records.</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaiksvcapilist5.htm">Serviceability API list: Retrieving message text</a></strong><br />
|
||
|
|
Use these APIs to retrieve message text associated with error handles</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaiksvcapiuseex.htm">Example: Using iSeries Access for Windows Serviceability APIs</a></strong><br />
|
||
|
|
The following example uses the <span class="keyword">iSeries Access for Windows</span> Serviceability
|
||
|
|
APIs to log a message string to the<span class="keyword">iSeries Access for Windows</span> History
|
||
|
|
Log.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikapiinterfaces.htm" title="iSeries Access for Windows provides C/C++ application programming interfaces (APIs) for accessing iSeries resources.">iSeries Access for Windows C/C++ APIs</a></div>
|
||
|
|
</div>
|
||
|
|
<div class="relref"><strong>Related reference</strong><br />
|
||
|
|
<div><a href="rzaikrcsvcapis.htm">Serviceability APIs return codes</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|