friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
14ed2849c6
ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/eimgetassociatedidentifiers.htm

827 lines
29 KiB
HTML
Raw Blame History

<!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>eimGetAssociatedIdentifiers()--Get Associated EIM identifiers</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. -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- Created by Carol Budnik on 17 July 2001 -->
<!-- Edited by Kersten Jan 02 -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!--Java sync-link-->
<script type="text/javascript" language="javascript" src="../rzahg/synch.js">
</script>
<a name="Top_Of_Page"></a>
<!-- ============================================================== -->
<!-- -->
<!-- -->
<!-- ============================================================== -->
<h2>eimGetAssociatedIdentifiers()
--Get Associated EIM identifiers</h2>
<!-- ============================================================== -->
<!-- -->
<!-- S Y N T A X / P A R M T A B L E -->
<!-- -->
<!-- ============================================================== -->
<div class="box" style="width: 80%;">
<br>
&nbsp;&nbsp;Syntax
<pre>
#include &lt;eim.h&gt;
int eimGetAssociatedIdentifiers(EimHandle * <em>eim</em>,
enum EimAssociationType <em>associationType</em>,
char * <em>registryName</em>,
char * <em>registryUserName</em>,
unsigned int <em>lengthOfListData</em>,
EimList * <em>listData</em>,
EimRC * <em>eimrc</em>)
</pre>
&nbsp;&nbsp;Service Program Name: QSYS/QSYEIM<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<!-- ============================================================== -->
<!-- -->
<!-- D E S C R I P T I O N -->
<!-- -->
<!-- ============================================================== -->
<p>The <strong>eimGetAssociatedIdentifiers()</strong> function returns a list
of the identifiers. Given a registry name and user name within that user
registry, return the EIM identifier associated with it.</p>
<p>It is possible that more than one person is associated with a specific
identifier. This occurs when users share identities (and possibly passwords)
within a single instance of a user registry. While this practice is not
condoned, it does happen. This creates an ambiguous result.</p>
<p>
<img src="delta.gif" alt="Start of change">
If there are no specific associations for the registry name and user name
within that registry to an EIM identifer, then group registries will be used.
If the specified registry is a member of any group registries, then
this API will return any EIM identifiers associated with the group
registry (or registries) and the registry user name.
<img src="deltaend.gif" alt="End of change">
</p>
<br>
<!-- ============================================================== -->
<!-- -->
<!-- A U T H O R I T I E S A N D L O C K S -->
<!-- -->
<!-- ============================================================== -->
<h3>Authorities and Locks</h3>
<dl>
<dt><em>EIM Data</em></dt>
<dd>Access to EIM data is controlled by EIM access groups. LDAP administrators
also have access to EIM data. The access groups whose members have authority to
the EIM data for this API follow:
<ul>
<li>EIM Administrator</li>
<li>EIM Registries Administrator</li>
<li>EIM Identifiers Administrator</li>
<li>EIM Mapping Lookup</li>
<li>EIM authority to an individual registry</li>
</ul>
<p>The list returned contains only the information that the user has authority
to access.</p>
</dd>
</dl>
<br>
<!-- ============================================================== -->
<!-- -->
<!-- P A R A M E T E R S -->
<!-- -->
<!-- ============================================================== -->
<h3>Parameters</h3>
<!-- ============================================================== -->
<!-- eim -->
<!-- ============================================================== -->
<dl>
<dt><strong>eim</strong>&nbsp;&nbsp;(Input)</dt>
<dd>The EIM handle returned by a previous call to eimCreateHandle(). A valid
connection is required for this function.<br>
<br>
</dd>
<!-- ============================================================== -->
<!-- associationType -->
<!-- ============================================================== -->
<dt><strong>associationType</strong>&nbsp;&nbsp;(Input)</dt>
<dd>The type of association to be retrieved. Valid values are:<br>
<br>
<table cellpadding="5">
<!-- cols="35 65" -->
<tr>
<td align="left" valign="top"><em>EIM_ALL_ASSOC (0)</em></td>
<td align="left" valign="top">Retrieve all
target, source, and administrative
associations.</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIM_TARGET (1)</em></td>
<td align="left" valign="top">Retrieve target associations.</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIM_SOURCE (2)</em></td>
<td align="left" valign="top">Retrieve source associations.</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIM_SOURCE_AND_TARGET (3)</em></td>
<td align="left" valign="top">Retrieve source and target associations.</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIM_ADMIN (4)</em></td>
<td align="left" valign="top">Retrieve administrative associations.</td>
</tr>
</table>
<br>
<br>
</dd>
<!-- ============================================================== -->
<!-- registry name -->
<!-- ============================================================== -->
<dt><strong>registryName</strong>&nbsp;&nbsp;(Input)</dt>
<dd>The registry name for the lookup.
A NULL parameter indicates that the <samp>localRegistry</samp>
set by the eimSetConfiguration() API or the
eimSetConfigurationExt() API should be used.
<br>
<br>
</dd>
<!-- ============================================================== -->
<!-- registry user name -->
<!-- ============================================================== -->
<dt><strong>registryUserName</strong>&nbsp;&nbsp;(Input)</dt>
<dd>The registry user name for the lookup.<br>
<br>
</dd>
<!-- ============================================================== -->
<!-- lengthOfListData -->
<!-- ============================================================== -->
<dt><strong>lengthOfListData</strong>&nbsp;&nbsp;(Input)</dt>
<dd>The number of bytes provided by the caller for the <em>listData</em>
parameter. The minimum size required is 20 bytes<br>
<br>
</dd>
<!-- ============================================================== -->
<!-- listData -->
<!-- ============================================================== -->
<dt><strong>listData</strong>&nbsp;&nbsp;(Output)</dt>
<dd>A pointer to the EimList structure.
<p>The EimList structure contains information about the returned data. The API
will return as much data as space has been provided. The data returned is a
linked list of EimIdentifier structures. firstEntry is used to get to the first
EimIdentifier structure in the linked list.</p>
<!-- ============================================================== -->
<!-- -->
<!-- EimList -->
<!-- ============================================================== -->
<p>EimList structure:</p>
<pre>
typedef struct EimList
{
unsigned int bytesReturned; /* Number of bytes actually returned
by the API */
unsigned int bytesAvailable; /* Number of bytes of available data
that could have been returned by
the API */
unsigned int entriesReturned; /* Number of entries actually
returned by the API */
unsigned int entriesAvailable; /* Number of entries available to be
returned by the API */
unsigned int firstEntry; /* Displacement to the first linked
list entry. This byte offset is
relative to the start of the
EimList structure. */
} EimList;
</pre>
<!-- ============================================================== -->
<!-- EimIdentifier -->
<!-- ============================================================== -->
<p>EimIdentifier structure:</p>
<pre>
typedef struct EimIdentifier
{
unsigned int nextEntry; /* Displacement to next entry. This
byte offset is relative to the
start of this structure */
EimListData uniquename; /* Unique name */
EimListData description; /* Description */
EimListData entryUUID; /* UUID */
EimSubList names; /* EimIdentifierName sublist */
EimSubList additionalInfo; /* EimAddlInfo sublist */
enum EimAssociationType type; /* Association type */
<img src="delta.gif" alt="Start of change">
EimListData groupRegistry; /* Group registry used to get the
identifier. */
<img src="deltaend.gif" alt="End of change">
} EimIdentifier;
</pre>
<p>Identifiers may have several name attributes as well as several
additional information attributes. In the EimIdentity structure, the names
EimSubList gives addressability to a linked list of EimIdentifierName
structures.</p>
<!-- ============================================================== -->
<!-- EimIdentifierName -->
<!-- ============================================================== -->
<p>EimIdentifierName structure:</p>
<pre>
typedef struct EimIdentifierName
{
unsigned int nextEntry; /* Displacement to next entry. This
byte offset is relative to the
start of this structure */
EimListData name; /* Name */
} EimIdentifierName;
</pre>
<p>The additionalInfo EimSubList gives addressability to a linked list of
EimAddlInfo structures.</p>
<!-- ============================================================== -->
<!-- EimAddlInfo -->
<!-- ============================================================== -->
<p>EimAddlInfo structure:</p>
<pre>
typedef struct EimAddlInfo
{
unsigned int nextEntry; /* Displacement to next entry. This
byte offset is relative to the
start of this structure */
EimListData addlInfo; /* Additional info */
} EimAddlInfo;
</pre>
<!-- ============================================================== -->
<!-- EimSubList -->
<!-- ============================================================== -->
<p>EimSubList structure:</p>
<pre>
typedef struct EimSubList
{
unsigned int listNum; /* Number of entries in the list */
unsigned int disp; /* Displacement to sublist. This
byte offset is relative to the
start of the parent structure;
that is, the structure containing
this structure. */
} EimSubList;
</pre>
<!-- ============================================================== -->
<!-- EimListData -->
<!-- ============================================================== -->
<p>EimListData structure:</p>
<pre>
typedef struct EimListData
{
unsigned int length; /* Length of data */
unsigned int disp; /* Displacement to data. This byte
offset is relative to the start of
the parent structure; that is, the
structure containing this
structure. */
} EimListData;
</pre>
</dd>
<!-- ============================================================== -->
<!-- eimrc -->
<!-- ============================================================== -->
<dt><strong>eimrc</strong>&nbsp;&nbsp;(Input/Output)</dt>
<dd>The structure in which to return error code information. If the return
value is not 0, eimrc is set with additional information. This parameter may be
NULL. For the format of the structure, see <a href="eimrc.htm">EimRC--EIM
Return Code Parameter</a>.<br>
<br>
</dd>
</dl>
<!-- ============================================================== -->
<!-- -->
<!-- R E T U R N V A L U E -->
<!-- -->
<!-- ============================================================== -->
<h3>Return Value</h3>
<p>The return value from the API. Following each return value is the list of
possible values for the <samp>messageCatalogMessageID</samp> field in the
<em>eimrc</em> parameter for that value.</p>
<dl><!-- ============================================================== -->
<!-- 0 -->
<!-- ============================================================== -->
<dt><strong>0</strong></dt>
<dd>Request was successful.<br>
<br>
</dd>
<!-- ============================================================== -->
<!-- EACCES -->
<!-- ============================================================== -->
<dt><strong>EACCES</strong></dt>
<dd>Access denied. Not enough permissions to access data.<br>
<br>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>EIMERR_ACCESS (1)</em></td>
<td align="left" valign="top">Insufficient access to EIM data.</td>
</tr>
</table>
<br>
</dd>
<!-- ============================================================== -->
<!-- EBADDATA -->
<!-- ============================================================== -->
<dt><strong>EBADDATA</strong></dt>
<dd>eimrc is not valid.<br>
<br>
</dd>
<!-- ============================================================== -->
<!-- EBADNAME -->
<!-- ============================================================== -->
<dt><strong>EBADNAME</strong></dt>
<dd>Registry not found or insufficient access to EIM data.<br>
<br>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>EIMERR_NOREG (28)</em></td>
<td align="left" valign="top">EIM Registry not found or insufficient access to
EIM data.</td>
</tr>
</table>
<br>
</dd>
<!-- ============================================================== -->
<!-- EBUSY -->
<!-- ============================================================== -->
<dt><strong>EBUSY</strong></dt>
<dd>Unable to allocate internal system object.<br>
<br>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>EIMERR_NOLOCK (26)</em></td>
<td align="left" valign="top">Unable to allocate internal system object.</td>
</tr>
</table>
<br>
</dd>
<!-- ============================================================== -->
<!-- ECONVERT -->
<!-- ============================================================== -->
<dt><strong>ECONVERT</strong></dt>
<dd>Data conversion error.<br>
<br>
<table cellpadding="5">
<!-- cols="35 65" -->
<tr>
<td align="left" valign="top"><em>EIMERR_DATA_CONVERSION (13)</em></td>
<td align="left" valign="top">Error occurred when converting data between code
pages.</td>
</tr>
</table>
<br>
</dd>
<!-- ============================================================== -->
<!-- EINVAL -->
<!-- ============================================================== -->
<dt><strong>EINVAL</strong></dt>
<dd>Input parameter was not valid.<br>
<br>
<table cellpadding="5">
<!-- cols="35 65" -->
<tr>
<td align="left" valign="top" nowrap><em>EIMERR_ASSOC_TYPE_INVAL (4)</em></td>
<td align="left" valign="top">Association type is not valid.</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIMERR_EIMLIST_SIZE (16)</em></td>
<td align="left" valign="top">Length of EimList is not valid. EimList must be
at least 20 bytes in length.</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIMERR_HANDLE_INVAL (17)</em></td>
<td align="left" valign="top">EimHandle is not valid.</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIMERR_PARM_REQ (34)</em></td>
<td align="left" valign="top">Missing required parameter. Please check API
documentation.</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIMERR_PTR_INVAL (35)</em></td>
<td align="left" valign="top">Pointer parameter is not valid.</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIMERR_SPACE (41)</em></td>
<td align="left" valign="top">Unexpected error accessing parameter.</td>
</tr>
</table>
<br>
</dd>
<!-- ============================================================== -->
<!-- ENOMEM -->
<!-- ============================================================== -->
<dt><strong>ENOMEM</strong></dt>
<dd>Unable to allocate required space.<br>
<br>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>EIMERR_NOMEM (27)</em></td>
<td align="left" valign="top">No memory available. Unable to allocate required
space.</td>
</tr>
</table>
<br>
</dd>
<!-- ============================================================== -->
<!-- ENOTCONN -->
<!-- ============================================================== -->
<dt><strong>ENOTCONN</strong></dt>
<dd>LDAP connection has not been made.<br>
<br>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>EIMERR_NOT_CONN (31)</em></td>
<td align="left" valign="top">Not connected to LDAP. Use eimConnect() API and
try the request again.</td>
</tr>
</table>
<br>
</dd>
<!-- ============================================================== -->
<!-- EUNKNOWN -->
<!-- ============================================================== -->
<dt><strong>EUNKNOWN</strong></dt>
<dd>Unexpected exception.<br>
<br>
<table cellpadding="5">
<!-- cols="40 60" -->
<tr>
<td align="left" valign="top"><em>EIMERR_LDAP_ERR (23)</em></td>
<td align="left" valign="top">Unexpected LDAP error. %s</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIMERR_UNEXP_OBJ_ VIOLATION (56)</em></td>
<td align="left" valign="top">Unexpected object violation.</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIMERR_UNKNOWN (44)</em></td>
<td align="left" valign="top">Unknown error or unknown system state.</td>
</tr>
</table>
</dd>
</dl>
<br>
<!-- ============================================================== -->
<!-- -->
<!-- U S A G E N O T E S -->
<!-- -->
<!-- ============================================================== -->
<!-- ============================================================== -->
<!-- -->
<!-- R E L A T E D I N F O R M A T I O N -->
<!-- -->
<!-- ============================================================== -->
<h3>Related Information</h3>
<ul>
<li><a href="eimaddidentifier.htm">eimAddIdentifier()</a>--Add EIM
Identifier<br>
<br>
</li>
<li><a href="eimchangeidentifier.htm">eimChangeIdentifier()</a>--Change EIM
Identifier<br>
<br>
</li>
<li><a href="eimremoveidentifier.htm">eimRemoveIdentifier()</a>--Remove EIM
Identifier<br>
<br>
</li>
<li><a href="eimlistidentifiers.htm">eimListIdentifiers()</a>--List EIM
Identifiers<br>
<br>
</li>
</ul>
<br>
<!-- ============================================================== -->
<!-- -->
<!-- E X A M P L E -->
<!-- -->
<!-- ============================================================== -->
<h3>Example</h3>
<p>See <a href="../apiref/aboutapis.htm#codedisclaimer">Code disclaimer information</a>
for information pertaining to code examples.</p>
<p>The following example will list all of the identifiers associated with the
registry, MyRegistry, and a user of carolb.</p>
<pre>
#include &lt;eim.h&gt;
#include &lt;stddef.h&gt;
#include &lt;stdio.h&gt;
#include &lt;stdlib.h&gt;
void printListResults(EimList * list);
void printSubListData(char * fieldName,
void * entry,
int offset);
void printListData(char * fieldName,
void * entry,
int offset);
void printAssociationType(int type);
int main(int argc, char *argv[])
{
int rc;
char eimerr[100];
EimRC * err;
EimHandle * handle;
char listData[1000];
EimList * list = (EimList * ) listData;
<em>/* Get eim handle from input arg. */</em>
<em>/* This handle is already connected to EIM. */</em>
handle = (EimHandle *)argv[1];
<em>/* Set up error structure. */</em>
memset(eimerr,0x00,100);
err = (EimRC *)eimerr;
err-&gt;memoryProvidedByCaller = 100;
<em>/* Get associated identifiers */</em>
if (0 != (rc = eimGetAssociatedIdentifiers(handle,
EIM_ALL_ASSOC,
&quot;MyRegistry&quot;,
&quot;carolb&quot;,
1000,
list,
err)))
{
printf(&quot;Get Associated Identifers error = %d&quot;, rc);
return -1;
}
<em>/* Print the results */</em>
printListResults(list);
return 0;
}
void printListResults(EimList * list)
{
int i;
EimIdentifier * entry;
printf(&quot;___________\n&quot;);
printf(&quot; bytesReturned = %d\n&quot;, list-&gt;bytesReturned);
printf(&quot; bytesAvailable = %d\n&quot;, list-&gt;bytesAvailable);
printf(&quot; entriesReturned = %d\n&quot;, list-&gt;entriesReturned);
printf(&quot; entriesAvailable = %d\n&quot;, list-&gt;entriesAvailable);
printf(&quot;\n&quot;);
entry = (EimIdentifier *)((char *)list + list-&gt;firstEntry);
for (i = 0; i &lt; list-&gt;entriesReturned; i++)
{
printf(&quot;\n&quot;);
printf(&quot;===============\n&quot;);
printf(&quot;Entry %d.\n&quot;, i);
<em>/* Print out results */</em>
printListData(&quot;Unique name&quot;,
entry,
offsetof(EimIdentifier, uniquename));
printListData(&quot;description&quot;,
entry,
offsetof(EimIdentifier, description));
printListData(&quot;entryUUID&quot;,
entry,
offsetof(EimIdentifier, entryUUID));
printSubListData(&quot;Names&quot;,
entry,
offsetof(EimIdentifier, names));
printSubListData(&quot;Additional Info&quot;,
entry,
offsetof(EimIdentifier, additionalInfo));
printAssociationType(entry-&gt;type);
printListData(&quot;Group registry&quot;,
entry,
offsetof(EimIdentifier, groupRegistry));
<em>/* advance to next entry */</em>
entry = (EimIdentifier *)((char *)entry + entry-&gt;nextEntry);
}
printf(&quot;\n&quot;);
}
void printSubListData(char * fieldName,
void * entry,
int offset)
{
int i;
EimSubList * subList;
EimAddlInfo * subentry;
// Address the EimSubList object */
subList = (EimSubList *)((char *)entry + offset);
if (subList-&gt;listNum &gt; 0)
{
subentry = (EimAddlInfo *)((char *)entry + subList-&gt;disp);
for (i = 0; i &lt; subList-&gt;listNum; i++)
{
<em>/* Print out results */</em>
printListData(fieldName,
subentry,
offsetof(EimAddlInfo, addlInfo));
<em>/* advance to next entry */</em>
subentry = (EimAddlInfo *)((char *)subentry +
subentry-&gt;nextEntry);
}
}
}
void printListData(char * fieldName,
void * entry,
int offset)
{
EimListData * listData;
char * data;
int dataLength;
printf(&quot; %s = &quot;,fieldName);
<em>/* Address the EimListData object */</em>
listData = (EimListData *)((char *)entry + offset);
<em>/* Print out results */</em>
data = (char *)entry + listData-&gt;disp;
dataLength = listData-&gt;length;
if (dataLength &gt; 0)
printf(&quot;%.*s\n&quot;,dataLength, data);
else
printf(&quot;Not found.\n&quot;);
}
void printAssociationType(int type)
{
switch(type)
{
case EIM_SOURCE:
printf(" Source Association.\n");
break;
case EIM_ADMIN:
printf(" Admin Association.\n");
break;
case EIM_TARGET:
printf(" Target Association.\n");
break;
default:
printf("ERROR - unknown association type.\n");
break;
}
}
</pre>
<br>
<!-- ============================================================== -->
<!-- -->
<!-- F O O T E R -->
<!-- -->
<!-- ============================================================== -->
<hr>
API introduced: V5R2
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"sec.htm">Security APIs</a> | <a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</center>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink