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

84 lines
4.3 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="cwbNL_GetLangName" />
<meta name="DC.Relation" scheme="URI" content="rzaikgennlsapis.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="cwbnl_getlangname" />
<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>cwbNL_GetLangName</title>
</head>
<body id="cwbnl_getlangname"><a name="cwbnl_getlangname"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">cwbNL_GetLangName</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Return the descriptive name of a language
setting.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
unsigned int CWB_ENTRY cwbNL_GetLangName(
char *lang,
char *resultPtr,
unsigned short resultLen,
unsigned short *requiredLen,
cwbSV_ErrHandle errorHandle);</pre>
</div>
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">char * lang - input</dt>
<dd>Address of the ASCIIZ string representing the language.</dd>
<dt class="dlterm">char * resultPtr - output</dt>
<dd>Pointer to the buffer to contain the result.</dd>
<dt class="dlterm">unsigned short resultLen - input</dt>
<dd>Length of the result buffer. Recommended size is CWBNL_MAX_NAME_SIZE.</dd>
<dt class="dlterm">unsigned short * requiredLen - output</dt>
<dd>Actual length of the result. If requiredLen &gt; resultLen, the return
value will be CWB_BUFFER_OVERFLOW.</dd>
<dt class="dlterm">cwbSV_ErrHandle errorHandle - input</dt>
<dd>Any returned messages will be written to this object. It is created with
the <span class="apiname">cwbSV_CreateErrHandle()</span> API. The messages may be retrieved
through the <span class="apiname">cwbSV_GetErrText()</span> API. If the parameter is
set to zero, no messages will be retrievable.</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_INVALID_HANDLE</dt>
<dd>Invalid handle.</dd>
<dt class="dlterm">CWB_INVALID_POINTER</dt>
<dd>NULL passed on output parameter.</dd>
<dt class="dlterm">CWB_NOT_ENOUGH_MEMORY</dt>
<dd>Insufficient memory.</dd>
<dt class="dlterm">CWB_BUFFER_OVERFLOW</dt>
<dd>Output buffer too small, data truncated.</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Usage</h4><p>The language must be a value returned from
one of the following APIs: </p>
<ul><li><span class="apiname">cwbNL_GetLang</span></li>
<li><span class="apiname">cwbNL_FindFirstLang</span></li>
<li><span class="apiname">cwbNL_FindNextLang</span></li>
</ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikgennlsapis.htm" title="Find information about iSeries Access for Windows general NLS APIs.">iSeries Access for Windows general NLS APIs list</a></div>
</div>
</div>
</body>
</html>