553 lines
18 KiB
HTML
553 lines
18 KiB
HTML
|
<!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>eimAddIdentifier()--Add EIM Identifier</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>eimAddIdentifier()--Add EIM
|
||
|
Identifier</h2>
|
||
|
|
||
|
<!-- ============================================================== -->
|
||
|
<!-- -->
|
||
|
<!-- S Y N T A X / P A R M T A B L E -->
|
||
|
<!-- -->
|
||
|
<!-- ============================================================== -->
|
||
|
<div class="box" style="width: 80%;">
|
||
|
<br>
|
||
|
Syntax
|
||
|
|
||
|
<pre>
|
||
|
#include <eim.h>
|
||
|
|
||
|
int eimAddIdentifier(EimHandle * <em>eim</em>,
|
||
|
char * <em>name</em>,
|
||
|
enum EimIdAction <em>nameInUseAction</em>,
|
||
|
unsigned int * <em>sizeOfUniqueName</em>,
|
||
|
char * <em>uniqueName</em>,
|
||
|
char * <em>description</em>,
|
||
|
EimRC * <em>eimrc</em>)
|
||
|
|
||
|
|
||
|
</pre>
|
||
|
|
||
|
Service Program Name: QSYS/QSYEIM<br>
|
||
|
<!-- iddvc RMBR -->
|
||
|
<br>
|
||
|
Default Public Authority: *USE<br>
|
||
|
<!-- iddvc RMBR -->
|
||
|
<br>
|
||
|
Threadsafe: Yes<br>
|
||
|
<!-- iddvc RMBR -->
|
||
|
<br>
|
||
|
</div>
|
||
|
|
||
|
<!-- ============================================================== -->
|
||
|
<!-- -->
|
||
|
<!-- D E S C R I P T I O N -->
|
||
|
<!-- -->
|
||
|
<!-- ============================================================== -->
|
||
|
<p>The <strong>eimAddIdentifier()</strong> function creates an identifier in
|
||
|
EIM related to a specific person or entity within an enterprise. This
|
||
|
identifier is used to manage information and identify relationships for a
|
||
|
specific user or identity.</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 Identifiers Administrator</li>
|
||
|
</ul>
|
||
|
</dd>
|
||
|
</dl>
|
||
|
|
||
|
<br>
|
||
|
<!-- ============================================================== -->
|
||
|
<!-- -->
|
||
|
<!-- P A R A M E T E R S -->
|
||
|
<!-- -->
|
||
|
<!-- ============================================================== -->
|
||
|
|
||
|
<h3>Parameters</h3>
|
||
|
|
||
|
<dl><!-- ============================================================== -->
|
||
|
<!-- eim -->
|
||
|
<!-- ============================================================== -->
|
||
|
<dt><strong>eim</strong> (Input)</dt>
|
||
|
|
||
|
<dd>The EIM handle returned by a previous call to eimCreateHandle(). A valid
|
||
|
connection is required for this function.<br>
|
||
|
<br>
|
||
|
</dd>
|
||
|
|
||
|
<!-- ============================================================== -->
|
||
|
<!-- name -->
|
||
|
<!-- ============================================================== -->
|
||
|
<dt><strong>name</strong> (Input)</dt>
|
||
|
|
||
|
<dd>A name to be used for this identifier.<br>
|
||
|
<br>
|
||
|
</dd>
|
||
|
|
||
|
<!-- ============================================================== -->
|
||
|
<!-- nameInUseAction -->
|
||
|
<!-- ============================================================== -->
|
||
|
<dt><strong>nameInUseAction</strong> (Input)</dt>
|
||
|
|
||
|
<dd>The name for the new identifier must be unique. This value indicates the
|
||
|
action to be taken if the provided name is already being used. Possible values
|
||
|
are:
|
||
|
<br><br>
|
||
|
<table width="100%">
|
||
|
<tr>
|
||
|
<td align="left" valign="top"><em>EIM_FAIL (0)</em></td>
|
||
|
<td align="left" valign="top">Do not generate a unique name, return an
|
||
|
error.</td>
|
||
|
</tr>
|
||
|
|
||
|
<tr>
|
||
|
<td align="left" valign="top"><em>EIM_GEN_UNIQUE (1)</em></td>
|
||
|
<td align="left" valign="top">Generate a unique name.</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
|
||
|
<br>
|
||
|
</dd>
|
||
|
|
||
|
<!-- ============================================================== -->
|
||
|
<!-- sizeOfUniqueName -->
|
||
|
<!-- ============================================================== -->
|
||
|
<dt><strong>sizeOfUniqueName</strong> (Input/Output)</dt>
|
||
|
|
||
|
<dd>The size of the field in which to return the unique name. This parameter is
|
||
|
ignored if <em>nameInUseAction</em> is EIM_FAIL.
|
||
|
|
||
|
<p>At input it is the size provided by the caller. On output it contains the
|
||
|
actual size returned. This value should be the size of the <em>name</em>
|
||
|
parameter plus an additional 20 bytes.</p>
|
||
|
</dd>
|
||
|
|
||
|
<!-- ============================================================== -->
|
||
|
<!-- uniqueName -->
|
||
|
<!-- ============================================================== -->
|
||
|
<dt><strong>uniqueName</strong> (Output)</dt>
|
||
|
|
||
|
<dd>The space to return the unique identifier for this new EIM identifier. This
|
||
|
parameter is ignored if <em>nameInUseAction</em> is EIM_FAIL.<br>
|
||
|
<br>
|
||
|
</dd>
|
||
|
|
||
|
<!-- ============================================================== -->
|
||
|
<!-- description -->
|
||
|
<!-- ============================================================== -->
|
||
|
<dt><strong>description</strong> (Input)</dt>
|
||
|
|
||
|
<dd>Description for the new EIM identifier. This parameter may be NULL.<br>
|
||
|
<br>
|
||
|
</dd>
|
||
|
|
||
|
<!-- ============================================================== -->
|
||
|
<!-- eimrc -->
|
||
|
<!-- ============================================================== -->
|
||
|
<dt><strong>eimrc</strong> (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>
|
||
|
|
||
|
<!-- ============================================================== -->
|
||
|
<!-- 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>
|
||
|
|
||
|
<!-- ============================================================== -->
|
||
|
<!-- EEXIST -->
|
||
|
<!-- ============================================================== -->
|
||
|
<dt><strong>EEXIST</strong></dt>
|
||
|
|
||
|
<dd>Identifier already exists.<br>
|
||
|
<br>
|
||
|
<table cellpadding="5">
|
||
|
<!-- cols="30 70" -->
|
||
|
<tr>
|
||
|
<td align="left" valign="top"><em>EIMERR_IDENTIFIER_EXISTS (19)</em></td>
|
||
|
<td align="left" valign="top">EIM Identifier already exists by this name.</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"><em>EIMERR_CHAR_INVAL (21)</em></td>
|
||
|
<td align="left" valign="top">A restricted character was used in the object
|
||
|
name. Check the API for a list of restricted characters.</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_IDACTION_INVAL (18)</em></td>
|
||
|
<td align="left" valign="top">Name in use action 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_UNIQUE_SIZE (43)</em></td>
|
||
|
<td align="left" valign="top">Length of unique name is not valid.</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>
|
||
|
|
||
|
<!-- ============================================================== -->
|
||
|
<!-- EROFS -->
|
||
|
<!-- ============================================================== -->
|
||
|
<dt><strong>EROFS</strong></dt>
|
||
|
|
||
|
<dd>LDAP connection is for read only. Need to connect to master.<br>
|
||
|
<br>
|
||
|
|
||
|
|
||
|
<table cellpadding="5">
|
||
|
<!-- cols="25 75" -->
|
||
|
<tr>
|
||
|
<td align="left" valign="top"><em>EIMERR_READ_ONLY (36)</em></td>
|
||
|
<td align="left" valign="top">LDAP connection is for read only. Use
|
||
|
eimConnectToMaster() to get a write connection.</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
|
||
|
<br>
|
||
|
</dd>
|
||
|
|
||
|
<!-- ============================================================== -->
|
||
|
<!-- EUNKNOWN -->
|
||
|
<!-- ============================================================== -->
|
||
|
<dt><strong>EUNKNOWN</strong></dt>
|
||
|
|
||
|
<dd>Unexpected exception.<br>
|
||
|
<br>
|
||
|
<table cellpadding="5">
|
||
|
<!-- cols="25 75" -->
|
||
|
<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_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 -->
|
||
|
<!-- -->
|
||
|
<!-- ============================================================== -->
|
||
|
|
||
|
<h3>Restrictions</h3>
|
||
|
|
||
|
<p>There is a restriction on the characters allowed for identifier name.</p>
|
||
|
|
||
|
<p>The following characters are special characters that are not allowed in
|
||
|
object names. They also should not be used in object attributes that would be
|
||
|
used for a search operation.</p>
|
||
|
|
||
|
|
||
|
<pre>
|
||
|
, = + < > # ; \ * "
|
||
|
</pre>
|
||
|
|
||
|
|
||
|
<!-- ============================================================== -->
|
||
|
<!-- -->
|
||
|
<!-- 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="eimremoveidentifier.htm">eimRemoveIdentifier()</a>--Remove EIM
|
||
|
Identifier<br>
|
||
|
<br>
|
||
|
</li>
|
||
|
|
||
|
<li><a href="eimchangeidentifier.htm">eimChangeIdentifier()</a>--Change EIM
|
||
|
Identifier<br>
|
||
|
<br>
|
||
|
</li>
|
||
|
|
||
|
<li><a href="eimlistidentifiers.htm">eimListIdentifiers()</a>--List EIM
|
||
|
Identifiers<br>
|
||
|
<br>
|
||
|
</li>
|
||
|
|
||
|
<li><a href="eimgetassociatedidentifiers.htm">eimGetAssociatedIdentifiers()</a>
|
||
|
--Get Associated 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 add an EIM identifier.</p>
|
||
|
|
||
|
<pre>
|
||
|
#include <eim.h>
|
||
|
#include <stdio.h>
|
||
|
|
||
|
int main(int argc, char *argv[])
|
||
|
{
|
||
|
int rc;
|
||
|
char eimerr[100];
|
||
|
EimRC * err;
|
||
|
EimHandle * handle;
|
||
|
|
||
|
char unique[30];
|
||
|
unsigned int sizeOfUnique = 30;
|
||
|
|
||
|
<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->memoryProvidedByCaller = 100;
|
||
|
|
||
|
<em>/* Add new identifier of Mary Smith */</em>
|
||
|
if (0 != (rc = eimAddIdentifier(handle,
|
||
|
"Mary Smith",
|
||
|
EIM_GEN_UNIQUE,
|
||
|
&sizeOfUnique,
|
||
|
unique,
|
||
|
"The coolest person",
|
||
|
err)))
|
||
|
printf("Add identifier error = %d", rc);
|
||
|
|
||
|
return 0;
|
||
|
}
|
||
|
</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>
|
||
|
|