ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/QVCCSID.htm

111 lines
3.3 KiB
HTML
Raw Permalink Normal View History

2024-04-02 14:02:31 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>QtqValidateCCSID()--Validate CCSID API</title>
<!-- Begin Header Records ========================================== -->
<!-- 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. -->
<!-- NETMG2 SCRIPT A converted by B2H R4.1 (346) (CMS) by HOLTJM at -->
<!-- RCHVMW2 on 29 Jan 1999 at 10:01:37 -->
<!--File Edited December 2001 -->
<!--End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<a name="Top_Of_Page"></a>
<!-- Java sync-link -->
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<h2>QtqValidateCCSID()--Validate CCSID API</h2>
<div class="box" style="width: 60%;">
<br>
&nbsp;&nbsp;Syntax<br>
<!-- iddvc RMBR -->
<br>
<pre>
int <strong>QtqValidateCCSID (<em>CCSID</em>)
</strong>
int CCSID;
</pre>
<br>
&nbsp;&nbsp;Service Program: QTQUSF<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The <strong>QtqValidateCCSID()</strong> function determines if the specified CCSID is supported by the iSeries server. If the CCSID is supported, the encoding scheme for the CCSID is returned.</p>
<br>
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
<!-- Instead, use the commented out coding below to indicate NONE. -->
<h3>Authorities and Locks</h3>
<!-- Use this if there are no authorities and locks. -->
<p>None.</p>
<br>
<h3>Parameters</h3>
<dl>
<dt><strong>CCSID</strong></dt>
<dd>INPUT
<p>An integer that represents the CCSID to be validated. Valid CCSID values are in the range 1 through 65535.</p></dd>
</dl>
<br>
<h3>Return Value</h3>
<p>If successful, <strong>QtqValidateCCSID()</strong> returns a positive integer that represents the encoding scheme of the specified CCSID. For more information on encoding schemes, see the <a href="../nls/rbagsglobalmain.htm">Globalization</a> topic in the iSeries Information Center.</p>
<p>If unsuccessful, <strong>QtqValidateCCSID()</strong> returns one of the following values:</p>
<dl>
<dt><strong>0</strong></dt>
<dd>Special purpose.
<p>The input CCSID is a special-purpose CCSID as defined by CDRA.</p></dd>
<dt><strong>-1</strong></dt>
<dd>CCSID not found.
<p>The input CCSID is not recognized by the system.</p></dd>
<dt><strong>-2</strong></dt>
<dd>Out of range.
<p>The input CCSID is out of the supported range of 1 to 65535.</p></dd>
</dl>
<hr>
API introduced: V3R7
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center">
<a href="#Top_Of_Page">Top</a>
| <a href="nls1.htm">National Language Support APIs</a>
| <a href="aplist.htm">APIs by category</a>
</tr>
</table>
</center>
</body>
</html>