108 lines
6.1 KiB
HTML
108 lines
6.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="cwbSV_GetErrSubstTextIndexed" />
|
||
|
|
<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_geterrsubsttextindexed" />
|
||
|
|
<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_GetErrSubstTextIndexed</title>
|
||
|
|
</head>
|
||
|
|
<body id="cwbsv_geterrsubsttextindexed"><a name="cwbsv_geterrsubsttextindexed"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">cwbSV_GetErrSubstTextIndexed</h1>
|
||
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4> <p>Returns the message substitution data for
|
||
|
|
the message identified by the index provided. This message attribute only
|
||
|
|
pertains to messages returned from the iSeries™ server. The substitution data
|
||
|
|
is the data inserted into the substitution variable fields defined for the
|
||
|
|
message. </p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4> <pre>
|
||
|
|
unsigned int CWB_ENTRY cwbSV_GetErrSubstTextIndexed(
|
||
|
|
cwbSV_ErrHandle errorHandle,
|
||
|
|
unsigned long index,
|
||
|
|
char *substitutionData,
|
||
|
|
unsigned long substitutionDataLength,
|
||
|
|
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()
|
||
|
|
API.</dd>
|
||
|
|
<dt class="dlterm">unsigned long index - input</dt>
|
||
|
|
<dd>Index value indicating which substitution data to return if multiple errors
|
||
|
|
are associated with the error handle. The valid index range is from 1 to the
|
||
|
|
number of messages contained in the error handle. The number of messages can
|
||
|
|
be obtained by calling the cwbSV_GetErrCount() API.</dd>
|
||
|
|
<dt class="dlterm">char * substitutionData - input/output</dt>
|
||
|
|
<dd>Pointer to a buffer that will receive the substitution data stored in
|
||
|
|
the error identified by the index. Note: The data returned is binary, hence
|
||
|
|
it is NOT returned as an ASCIIZ string. Any character strings contained in
|
||
|
|
the substitution data are returned as EBCDIC values.</dd>
|
||
|
|
<dt class="dlterm">unsigned long substitutionDataLength - input</dt>
|
||
|
|
<dd>Length of the receive buffer passed in. 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 data if the receive buffer is too small. It will also be
|
||
|
|
set to the actual number of bytes of output data returned upon successful
|
||
|
|
completion.</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>Invalid handle.</dd>
|
||
|
|
<dt class="dlterm">CWBSV_NO_ERROR_MESSAGES </dt>
|
||
|
|
<dd>No messages are in the error handle.</dd>
|
||
|
|
<dt class="dlterm">CWBSV_ATTRIBUTE_NOT_SET </dt>
|
||
|
|
<dd>Attribute not set in current message.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4> <p>iSeries server messages may be added
|
||
|
|
to the error handle when using the cwbRC_CallPgm() and cwbRC_RunCmd() API's.
|
||
|
|
In these cases, you can use this API to retrieve the substitution data for
|
||
|
|
the iSeries server
|
||
|
|
messages contained in the error handle. If there is no substitution data for
|
||
|
|
the message, return code CWBSV_ATTRIBUTE_NOT_SET will be returned. An index
|
||
|
|
value of 1 works with the lowest-level (i.e. oldest) message in the error
|
||
|
|
handle. An index value equal to the count returned by the cwbSV_GetErrCount()
|
||
|
|
API works with the top-level (i.e. most recent) message in the error handle.
|
||
|
|
Index values less than 1 act as if 1 was passed in. Index values greater than
|
||
|
|
the number of messages contained in the error handle act as if the returned
|
||
|
|
count value from the cwbSV_GetErrCount() API was passed in. Use the returnLength
|
||
|
|
parameter to determine the actual number of bytes returned in the substitution
|
||
|
|
data when the return code is CWB_OK. The substitution data returned on this
|
||
|
|
API could be used on a subsequent host retrieve message API call (QSYS/QMHRTVM)
|
||
|
|
to retrieve the format of the substitution data or to return secondary help
|
||
|
|
text with the substitution data added in. Host API's are called using the
|
||
|
|
cwbRC_CallPgm() API.</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>
|