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

63 lines
3.8 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="About System Object Access errors" />
<meta name="abstract" content="All System Object Access APIs use return codes to report error conditions." />
<meta name="description" content="All System Object Access APIs use return codes to report error conditions." />
<meta name="DC.Relation" scheme="URI" content="rzaiksoaprogconsiderations.htm" />
<meta name="DC.Relation" scheme="URI" content="rzaikrcsoaapis.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="soahandlerrors" />
<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>About System Object Access errors</title>
</head>
<body id="soahandlerrors"><a name="soahandlerrors"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">About System Object Access errors</h1>
<div><p>All System Object Access APIs use return codes to report error
conditions.</p>
<div class="section"><p>Check for errors on each function call. In addition, certain APIs
incorporate a handle to an “error object” in their interface. The error object
is used to provide additional information for errors which occurred during
the processing of a request. Often these errors are encountered while interacting
with the iSeries™ server,
in which case the error object will contain the error message text.</p>
</div>
<div class="section"><p>If a function call returns CWBSO_ERROR_OCCURRED then the error
object will have been filled in with information that describe the error. <span class="apiname">CWBSO_GetErrMsgText</span> may
be used to retrieve the error message text. The message will have been translated
into the language that is specified for the user's execution environment.
Alternatively, the error message may be displayed to the user directly by
calling <span class="apiname">CWBSO_DisplayErrMsg</span>.</p>
</div>
<div class="section"><p>For internal processing errors, error objects automatically log
an entry in the System Object Access log file <samp class="codeph">soa.log</samp>, in
the <span class="keyword">iSeries Access for Windows<sup>®</sup></span> install directory.
This file is English only and is intended for use by IBM<sup>®</sup> personnel for problem analysis.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaiksoaprogconsiderations.htm" title="See the following topics for important SOA programming considerations.">iSeries Access for Windows System Object Access programming considerations</a></div>
</div>
<div class="relref"><strong>Related reference</strong><br />
<div><a href="rzaikrcsoaapis.htm">System Object Access APIs return codes</a></div>
</div>
</div>
</body>
</html>