82 lines
5.1 KiB
HTML
82 lines
5.1 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="Error code parameter" />
|
||
|
|
<meta name="abstract" content="An API error code parameter is a variable-length structure that is common to all of the system APIs." />
|
||
|
|
<meta name="description" content="An API error code parameter is a variable-length structure that is common to all of the system APIs." />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="conParameter.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="errorcodeformat.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="errorexceptions.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="errorjoblog.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="conQSYSINC.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="../apis/ile1a6.htm" />
|
||
|
|
<meta name="copyright" content="(C) Copyright IBM Corporation 1998, 2006" />
|
||
|
|
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 1998, 2006" />
|
||
|
|
<meta name="DC.Format" content="XHTML" />
|
||
|
|
<meta name="DC.Identifier" content="error" />
|
||
|
|
<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>Error code parameter</title>
|
||
|
|
</head>
|
||
|
|
<body id="error"><a name="error"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">Error code parameter</h1>
|
||
|
|
<div><p>An API error code parameter is a variable-length structure that
|
||
|
|
is common to all of the system APIs.</p>
|
||
|
|
<div class="section"><p>The error code parameter controls how errors are returned to the
|
||
|
|
application. The parameter must be initialized before the program calls the
|
||
|
|
API. Depending on how the error code structure is set, this parameter either
|
||
|
|
returns information associated with an error condition or causes errors to
|
||
|
|
be returned as exception messages.</p>
|
||
|
|
<p>For some APIs, the error code parameter
|
||
|
|
is optional. If you do not code the optional error code parameter, the API
|
||
|
|
returns diagnostic and escape messages. If you code the optional error code
|
||
|
|
parameter, the API can either signal exceptions or return the exception information
|
||
|
|
in the error code parameter.</p>
|
||
|
|
<div class="note"><span class="notetitle">Notes:</span> <ol><li>The ILE CEE APIs use feedback codes and conditions.</li>
|
||
|
|
<li>The UNIX<sup>®</sup>-type
|
||
|
|
APIs and the National Language Data Conversion APIs use <em>errno</em> to report
|
||
|
|
error conditions.</li>
|
||
|
|
</ol>
|
||
|
|
</div>
|
||
|
|
<p>The error code structure is provided in the QSYSINC library
|
||
|
|
and is called QUSEC.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<ul class="ullinks">
|
||
|
|
<li class="ulchildlink"><strong><a href="errorcodeformat.htm">Error code parameter format</a></strong><br />
|
||
|
|
Most iSeries™ APIs
|
||
|
|
include an error code parameter to return error codes and exception data to
|
||
|
|
the application. The error code parameter can be one of two variable-length
|
||
|
|
structures, format ERRC0100 or format ERRC0200.</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="errorexceptions.htm">Examples: Receiving error conditions</a></strong><br />
|
||
|
|
These examples illustrate receiving error conditions</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="errorjoblog.htm">Using the job log to diagnose API errors</a></strong><br />
|
||
|
|
Sometimes an API may issue one or more messages that state that the API failed, and the messages may direct you to see the previously listed messages in the job log. If your application program needs to determine the cause of the error message, you can use the Receive Message (RCVMSG) command or the Receive Message APIs to receive the messages that explain the reason for the error.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="conParameter.htm" title="After you have found the API that you want to use, you need to code a call to an API and pass to the API the required set of parameters appropriate for that API.">API parameters</a></div>
|
||
|
|
</div>
|
||
|
|
<div class="relconcepts"><strong>Related concepts</strong><br />
|
||
|
|
<div><a href="conQSYSINC.htm" title="The QSYSINC (system include) library provides all source includes for APIs shipped with i5/OS.">Include files and the QSYSINC library</a></div>
|
||
|
|
</div>
|
||
|
|
<div class="relref"><strong>Related reference</strong><br />
|
||
|
|
<div><a href="../apis/ile1a6.htm">i5/OS Messages and the ILE CEE API Feedback Code</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|