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

78 lines
4.2 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_SetUserIDEx" />
<meta name="DC.Relation" scheme="URI" content="rzaikcommapilist3.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_setuseridex" />
<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_SetUserIDEx</title>
</head>
<body id="cwbco_setuseridex"><a name="cwbco_setuseridex"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">cwbCO_SetUserIDEx</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>This function sets the user ID to associate
with the specified system object. This user ID will be used when connecting
to the iSeries™ server
with either the <span class="apiname">cwbCO_Signon</span> or <span class="apiname">cwbCO_Connect</span> call.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
UINT CWB_ENTRY cwbCO_SetUserIDEx(
cwbCO_SysHandle system,
LPCSTR userID );</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 server system.</dd>
<dt class="dlterm">LPCSTR userID - input</dt>
<dd>Pointer to a buffer that contains the NULL-terminated user ID. The user
ID must not be longer than CWBCO_MAX_USER_ID characters, not including the
terminating NULL character.</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 userID pointer is NULL.</dd>
<dt class="dlterm">CWB_NON_REPRESENTABLE_UNICODE_CHAR</dt>
<dd>One or more input Unicode characters have no representation in the codepage
that is being used.</dd>
<dt class="dlterm">CWB_INV_AFTER_SIGNON</dt>
<dd>Signon successfully has occurred by using the specified system object,
so this setting no longer may be changed.</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Usage</h4><p>This API cannot be used after a successful
signon has occurred for the specified system object. A signon has occurred
if either <span class="apiname">cwbCO_Signon</span> or <span class="apiname">cwbCO_Connect</span> has
been called successfully for this system object. Setting a user ID explicitly
with this API will cause any default user mode set with the <span class="apiname">cwbCO_SetDefaultUserMode</span> API
to be ignored.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikcommapilist3.htm" title="These APIs provide security validation and data.">Communication and security: Security validation and data APIs</a></div>
</div>
</div>
</body>
</html>