95 lines
5.2 KiB
HTML
95 lines
5.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_GetUserID" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaiksyslistcommapis2.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_getuserid" />
|
||
|
|
<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_GetUserID</title>
|
||
|
|
</head>
|
||
|
|
<body id="cwbco_getuserid"><a name="cwbco_getuserid"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1"><span class="apiname">cwbCO_GetUserID</span></h1>
|
||
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Get signon or default user ID of the input
|
||
|
|
system as it is configured and possibly connected in the currently active
|
||
|
|
environment. This API is obsolete, and has been replaced.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
|
||
|
|
unsigned int CWB_ENTRY cwbCO_GetUserID(
|
||
|
|
LPCSTR systemName,
|
||
|
|
char *userID,
|
||
|
|
unsigned int userID_Type,
|
||
|
|
unsigned long *bufferSize);</pre>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">LPCSTR systemName - input</dt>
|
||
|
|
<dd>Pointer to a buffer that contains the system name.</dd>
|
||
|
|
<dt class="dlterm">char *userID - output</dt>
|
||
|
|
<dd>Pointer to a buffer where the desired userID of the system is returned.
|
||
|
|
This buffer should be large enough to hold at least CWBCO_MAX_USER_ID + 1
|
||
|
|
characters, including the terminating NULL character.</dd>
|
||
|
|
<dt class="dlterm">unsigned int userID_Type - input</dt>
|
||
|
|
<dd>Specify whether current user ID of connected system (CWBCO_CURRENT_USER_ID)
|
||
|
|
or default user ID of configured system (CWBCO_DEFAULT_USER_ID) is to be returned.</dd>
|
||
|
|
<dt class="dlterm">unsigned long * bufferSize - input/output</dt>
|
||
|
|
<dd>Pointer to a value that indicates the size of the userID buffer. If the
|
||
|
|
buffer is not big enough, the value needed is returned.</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_POINTER</dt>
|
||
|
|
<dd>One or more input pointers are invalid.</dd>
|
||
|
|
<dt class="dlterm">CWB_INVALID_PARAMETER</dt>
|
||
|
|
<dd>The value for userID_Type is invalid.</dd>
|
||
|
|
<dt class="dlterm">CWB_BUFFER_OVERFLOW</dt>
|
||
|
|
<dd>Not enough room in userID buffer to store the user ID. Use *bufferSize
|
||
|
|
to determine the correct size. No error message is logged to the History Log
|
||
|
|
since the caller is expected to recover from this error and continue.</dd>
|
||
|
|
<dt class="dlterm">CWBCO_SYSTEM_NOT_CONNECTED</dt>
|
||
|
|
<dd>The system of the "current user ID" is not connected.</dd>
|
||
|
|
<dt class="dlterm">CWBCO_SYSTEM_NOT_CONFIGURED</dt>
|
||
|
|
<dd>The system of the "default user ID" is not configured in the currently
|
||
|
|
active environment.</dd>
|
||
|
|
<dt class="dlterm">CWBCO_INTERNAL_ERROR</dt>
|
||
|
|
<dd>Internal error.</dd>
|
||
|
|
<dt class="dlterm">CWB_NOT_ENOUGH_MEMORY</dt>
|
||
|
|
<dd>Insufficient memory; may have failed to allocate temporary buffer.</dd>
|
||
|
|
<dt class="dlterm">CWB_NON_REPRESENTABLE_UNICODE_CHAR</dt>
|
||
|
|
<dd>One or more input Unicode characters have no representation in the codepage
|
||
|
|
being used.</dd>
|
||
|
|
<dt class="dlterm">CWB_API_ERROR</dt>
|
||
|
|
<dd>General API failure.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4><p>If the default user ID is specified, and none
|
||
|
|
was entered when the connection was configured, CWB_OK will be returned and
|
||
|
|
the user ID sent back to the caller will be the empty string, "\0". The user
|
||
|
|
ID retrieved will be that of the specified system from the currently active
|
||
|
|
environment.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaiksyslistcommapis2.htm" title="Use these APIs to obtain information about individual systems that are configured or connected in the current process. Unless the environment name is passed as a parameter, these APIs work only with the currently active environment.">Communications: System information APIs</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|