<?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="copyright" content="(C) Copyright IBM Corporation 2005" />
<meta name="DC.rights.owner" content="(C) Copyright IBM Corporation 2005" />
<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="concept" />
<meta name="DC.Title" content="cwbUN_GetUserAttribute" />
<meta name="DC.Relation" scheme="URI" content="rzakxapis.htm" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="rzakxcwbungetuserattribute" />
<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>cwbUN_GetUserAttribute</title>
</head>
<body id="rzakxcwbungetuserattribute"><a name="rzakxcwbungetuserattribute"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">cwbUN_GetUserAttribute</h1>
<div><p><strong>Purpose</strong></p>
<p>Returns a string that contains the value of a user profile attribute for
the current iSeries™ Navigator
user.</p>
<p><strong>Syntax</strong> </p>
<pre>CWBAPI unsigned int WINAPI cwbUN_GetUserAttribute(
USHORT usAttributeId,
const char * szSystemName,
char * szValue,
UINT cchMax
);</pre>
<p><strong>Parameters</strong></p>
<dl><dt class="dlterm">USHORT usAttributeId - input</dt>
<dd>A numeric value which identifies the user attribute value to be retrieved.
Definitions for the user attribute constants are in the header file 'CWBA4USR.H.'</dd>
<dt class="dlterm">const char * szSystemName - input</dt>
<dd>The name of the iSeries system from which to retrieve the user attribute.</dd>
<dt class="dlterm">char * szValue - output</dt>
<dd>Address of the buffer that will receive the null-terminated attribute
value string.</dd>
<dt class="dlterm">UINT cchMax - input</dt>
<dd>Size of the buffer that will receive the null-terminated value string.</dd>
</dl>
<p><strong>Return Codes</strong></p>
<p>The following list shows common return values:</p>
<dl><dt class="dlterm">CWB_OK</dt>
<dd>Successful completion.</dd>
<dt class="dlterm">CWBUN_INTERNAL_ERROR</dt>
<dd>Could not retrieve attribute value.</dd>
<dt class="dlterm">CWB_BUFFER_OVERFLOW</dt>
<dd>The buffer is too small to contain the returned string.</dd>
</dl>
<p><strong>Usage</strong></p>
<p>The value that is returned by this API is <span class="uicontrol">not</span> an
NLS string and is not translated. For example, '*NONE' will be returned instead
of 'None.'</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzakxapis.htm" title="iSeries Navigator APIs help plug-in developers obtain and manage certain types of global information.">iSeries Navigator APIs</a></div>
</div>
</div>
</body>
</html>