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

81 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="cwbCO_GetHostCCSID" />
<meta name="DC.Relation" scheme="URI" content="rzaikcommapilist4.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="cwbco_gethostccsid" />
<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>cwbCO_GetHostCCSID</title>
</head>
<body id="cwbco_gethostccsid"><a name="cwbco_gethostccsid"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">cwbCO_GetHostCCSID</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Returns the associated CCSID of the iSeries™ system
that is represented by the given system object that was in use when the signon
to the iSeries system
occurred, and that is associated with the user ID that is set in the system
object.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
UINT CWB_ENTRY cwbCO_GetHostCCSID(
cwbCO_SysHandle system,
PULONG pCCSID );</pre>
</div>
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">cwbCO_SysHandle system - input</dt>
<dd>Handle that previously was returned from <span class="apiname">cwbCO_CreateSystem</span> or <span class="apiname">cwbCO_CreateSystemLike</span>.
It identifies the iSeries system.</dd>
<dt class="dlterm">PULONG pCCSID - output</dt>
<dd>The host CCSID is copied into here if successful.</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_API_HANDLE</dt>
<dd>Invalid system handle.</dd>
<dt class="dlterm">CWB_INVALID_POINTER</dt>
<dd>the CCSID pointer is NULL.</dd>
<dt class="dlterm">CWB_DEFAULT_HOST_CCSID_USED </dt>
<dd>Host CCSID 500 is returned because this API is unable to determine the
host CCSID appropriate for the user ID as set in the system object.</dd>
<dt class="dlterm">CWB_USER_TIMEOUT</dt>
<dd></dd>
<dt class="dlterm">CWB_SSL_JAVA_ERROR</dt>
<dd></dd>
<dt class="dlterm">CWB_USER_TIMEOUT_SENDRCV</dt>
<dd></dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Usage</h4><p>This API does not make or require an active
connection to the host system to retrieve the associated CCSID value. However,
it does depend on a prior successful connection to the host system by using
the same user ID as is set in the specified system object. This is because
the CCSID that is returned is the one from the specific user profile, NOT
the iSeries system's
default CCSID. To retrieve a host CCSID without requiring a user ID, call <span class="apiname">cwbNL_GetHostCCSID</span>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikcommapilist4.htm" title="Use the APIs to get and set other system object attributes, or determine if the attributes are restricted by policies.">Communications and security: Get and set attribute APIs</a></div>
</div>
</div>
</body>
</html>