ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzaik_5.4.0.1/rzaiksvctypuse.htm

59 lines
3.7 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="Typical use of Serviceability APIs" />
<meta name="abstract" content="Typical uses of serviceability APIs include history logs and error handles." />
<meta name="description" content="Typical uses of serviceability APIs include history logs and error handles." />
<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="svctypuse" />
<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>Typical use of Serviceability APIs</title>
</head>
<body id="svctypuse"><a name="svctypuse"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">Typical use of Serviceability APIs</h1>
<div><p>Typical uses of serviceability APIs include history logs and error
handles.</p>
<div class="section"><h4 class="sectiontitle">History log:</h4><p>Serviceability APIs provide a tracking
mechanism for activity that is taking place on the client workstation. As
a result, you can use the message-logging APIs to log messages to the <span class="keyword">iSeries™ Access for Windows<sup>®</sup></span> History Log. Examples of messages
to log include an indication that your application was started, and other
significant events. For example, a log message may indicate that a file successfully
was transferred to the iSeries server, a database query failed for some
reason, or that a job was submitted for printing.</p>
<p>The product and component
strings that you provide when you are using the Serviceability APIs allow
your messages and events to be distinguished from other entries in the service
files. The recommended hierarchy is to define a product ID, with one or many
component IDs defined under it.</p>
</div>
<div class="section"><h4 class="sectiontitle">Error handles:</h4><p>Use the error-handle parameter on <span class="keyword">iSeries Access for Windows</span> C/C++ APIs to retrieve message
text that is associated with a failure return code. This enables your application
to display the message text, instead of providing your own text for the set
of iSeries Access
return codes.</p>
</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>