88 lines
5.1 KiB
HTML
88 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="CWBSO_GetErrMsgText" />
|
|
<meta name="DC.Relation" scheme="URI" content="rzaiksoaapilist.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="cwbso_geterrmsgtext" />
|
|
<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>CWBSO_GetErrMsgText</title>
|
|
</head>
|
|
<body id="cwbso_geterrmsgtext"><a name="cwbso_geterrmsgtext"><!-- --></a>
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
|
<h1 class="topictitle1"><span class="apiname">CWBSO_GetErrMsgText</span></h1>
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Retrieves the message text from an error
|
|
handle. This API should only be called when CWBSO_ERROR_OCCURRED is the return
|
|
value from a call to another API. In this case there is an error message
|
|
associated with the error handle.</p>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
|
|
unsigned int CWB_ENTRY CWBSO_GetErrMsgText(
|
|
CWBSO_ERR_HANDLE errorHandle ,
|
|
char far* lpszMsgBuffer ,
|
|
unsigned long ulBufferLength,
|
|
unsigned long far* lpulBytesNeeded); </pre>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">CWBSO_ERR_HANDLE errorHandle - input</dt>
|
|
<dd>A handle to an error object. If an error occurs that there is error text
|
|
for, this handle may be used to retreive the error message and message help.</dd>
|
|
<dt class="dlterm">char far* lpszMsgBuffer - output</dt>
|
|
<dd>A long pointer to the output buffer where the message text will be placed.
|
|
The message text that is returned by this API will be translated text. The
|
|
output buffer is not changed when the return code is not set to CWBSO_NO_ERROR.</dd>
|
|
<dt class="dlterm">unsigned long ulBufferLength - input</dt>
|
|
<dd>The size, in bytes, of the output buffer argument.</dd>
|
|
<dt class="dlterm">unsigned long far* lpulBytesNeeded - output</dt>
|
|
<dd>A long pointer to an unsigned long that will be set to the number of bytes
|
|
needed to place the entire message text in the output buffer. When this value
|
|
is less than or equal to the size of output buffer that is specified, the
|
|
entire message text is placed in the output buffer. When this value is greater
|
|
than the size of output buffer that is specified, the output buffer contains
|
|
a null string. The output buffer is not changed beyond the bytes that are
|
|
needed for the message text. This value is set to zero when the return code
|
|
is not set to CWBSO_NO_ERROR.</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">CWBSO_NO_ERROR</dt>
|
|
<dd>No error occurred.</dd>
|
|
<dt class="dlterm">CWBSO_BAD_ERR_HANDLE</dt>
|
|
<dd>The error handle that is specified is not valid.</dd>
|
|
<dt class="dlterm">CWBSO_NO_ERROR_MESSAGE</dt>
|
|
<dd>The error handle that is specified contains no error message.</dd>
|
|
<dt class="dlterm">CWBSO_GET_MSG_FAILED</dt>
|
|
<dd>The error message text could not be retrieved.</dd>
|
|
</dl>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4><p><span class="apiname">CWBSO_CreateErrorHandle</span> must
|
|
be called prior to calling this API. The error handle that is returned by <span class="apiname">CWBSO_CreateErrorHandle</span> must
|
|
be passed as input to this API. For errors which occurred on the iSeries™ server,
|
|
the message text will be in the language that is specified for the user's
|
|
execution environment. All other message text will be in the language that
|
|
is specified in the Windows<sup>®</sup> Control Panel on the user's
|
|
personal computer.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaiksoaapilist.htm" title="The following System Object Access APIs for iSeries Access for Windows are listed alphabetically.">System Object Access APIs for iSeries Access for Windows List</a></div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html> |