91 lines
4.7 KiB
HTML
91 lines
4.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="cwbSV_GetErrTextIndexed" />
|
|
<meta name="DC.Relation" scheme="URI" content="rzaiksvcapilist5.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="cwbsv_geterrtextindexed" />
|
|
<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>cwbSV_GetErrTextIndexed</title>
|
|
</head>
|
|
<body id="cwbsv_geterrtextindexed"><a name="cwbsv_geterrtextindexed"><!-- --></a>
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
|
<h1 class="topictitle1">cwbSV_GetErrTextIndexed</h1>
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4>
|
|
<p>Returns the message text associated with the error index provided. An index
|
|
value of 1 will retrieve the lowest-level (for example, the oldest) message
|
|
that is associated with the error handle. An index value of "cwbSV_GetErrCount()'s
|
|
returned errorCount" will retrieve the top-level (for example, the most recent)
|
|
message associated with the error handle.</p>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4>
|
|
<pre>
|
|
unsigned int CWB_ENTRY cwbSV_GetErrTextIndexed(
|
|
cwbSV_ErrHandle errorHandle,
|
|
unsigned long errorIndex,
|
|
char *errorText,
|
|
unsigned long errorTextLength,
|
|
unsigned long *returnLength);</pre>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Parameters</h4>
|
|
<dl><dt class="dlterm">cwbSV_ErrHandle errorHandle - input</dt>
|
|
<dd>Handle that was returned by a previous call to the cwbSV_CreateErrHandle()
|
|
function.</dd>
|
|
<dt class="dlterm">unsigned long errorIndex - input</dt>
|
|
<dd>Index value that indicates which error text to return if multiple errors
|
|
are associated with the error handle.</dd>
|
|
<dt class="dlterm">char * errorText - input/output</dt>
|
|
<dd>Pointer to a buffer that will receive the error message text that is
|
|
stored in the error that is identified by the index.</dd>
|
|
<dt class="dlterm">unsigned long errorTextLength - input</dt>
|
|
<dd>Length of the receive buffer passed in. It should include space for
|
|
the ending null character. If the buffer is too small, the value will be truncated,
|
|
and CWB_BUFFER_OVERFLOW and returnLength will be set.</dd>
|
|
<dt class="dlterm">unsigned long * returnLength - input/output</dt>
|
|
<dd>Optional, may be NULL. A return address to store the number of bytes
|
|
needed to hold the output string if the receive buffer is too small.</dd>
|
|
</dl>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Return Codes</h4>
|
|
<p>The following list shows common return values.</p>
|
|
|
|
<dl><dt class="dlterm">CWB_OK</dt>
|
|
<dd>Successful completion.</dd>
|
|
<dt class="dlterm">CWB_BUFFER_OVERFLOW</dt>
|
|
<dd>Output buffer too small, data truncated.</dd>
|
|
<dt class="dlterm">CWB_INVALID_POINTER</dt>
|
|
<dd>NULL passed on output parameter.</dd>
|
|
<dt class="dlterm">CWB_INVALID_HANDLE</dt>
|
|
<dd>Handle is not valid.</dd>
|
|
<dt class="dlterm">CWBSV_NO_ERROR_MESSAGES</dt>
|
|
<dd>No error messages associated with error handle.</dd>
|
|
</dl>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4>
|
|
<p>Valid index values are from 1 to cwbSV_GetErrCount()'s return value. Index
|
|
values less than 1 act as if 1 was passed. Index values greater than cwbSV_GetErrCount()
|
|
act as if errorCount was passed.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaiksvcapilist5.htm" title="Use these APIs to retrieve message text associated with error handles">Serviceability API list: Retrieving message text</a></div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html> |