<!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>eimAddApplicationRegistry()--Add an Application Registry to the EIM Domain</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 Therese Dalton 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> eimAddApplicationRegistry()--Add an Application Registry to the EIM Domain</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 eimAddApplicationRegistry(EimHandle * <em>eim</em>, char * <em>registryName</em>, char * <em>registryType</em>, char * <em>description</em>, char * <em>systemRegistryName</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>eimAddApplicationRegistry()</strong> function adds an application registry to the EIM domain. An application registry is a subset of a system registry. These can be used to manage which applications can be used by a user in a registry. Once added, this registry is participating in the EIM domain. Mapping associations can only be made with identities in registries that are currently participating in the EIM domain.</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> </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> <!-- ============================================================== --> <!-- registryName --> <!-- ============================================================== --> <dt><strong>registryName</strong> (Input)</dt> <dd>The name for this application registry. This name needs to be unique within the EIM domain.<br> <br> </dd> <!-- ============================================================== --> <!-- registryType --> <!-- ============================================================== --> <dt><strong>registryType</strong> (Input)</dt> <dd>A string form of an OID that represents the registry type and a user name normalization method. The normalization method is necessary because some registries are case-independent and others are case-dependent. EIM uses this information to make sure the appropriate search occurs. When a registry is case-independent registry user names are converted to uppercase. See eim.h for a list of predefined types. A user can define their own registry type. Refer to Registry Type section below.<br> <br> <img src="delta.gif" alt="Start of change"> A type of EIM_REGTYPE_GROUP_REGISTRY_IG ("1.3.18.0.2.33.17-caseIgnore") or EIM_REGTYPE_GROUP_REGISTRY_EX ("1.3.18.0.2.33.18-caseExact") cannot be specified. <img src="deltaend.gif" alt="End of change"> <br> <br> </dd> <!-- ============================================================== --> <!-- description --> <!-- ============================================================== --> <dt><strong>description</strong> (Input)</dt> <dd>The description for this new application registry entry. This parameter may be NULL.<br> <br> </dd> <!-- ============================================================== --> <!-- systemRegistryName --> <!-- ============================================================== --> <dt><strong>systemRegistryName</strong> (Input)</dt> <dd>The name of the system registry of which this application registry is a subset.<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> <br> <!-- ============================================================== --> <!-- --> <!-- 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>EIM registry entry already exists.<br> <br> <table cellpadding="5"> <!-- cols="30 70" --> <tr> <td align="left" valign="top"><em>EIMERR_REGISTRY_EXISTS (37)</em></td> <td align="left" valign="top">Registry entry already exists in EIM.</td> </tr> </table> <br> </dd> <!-- ============================================================== --> <!-- EINVAL --> <!-- ============================================================== --> <dt><strong>EINVAL</strong></dt> <dd>Input parameter was not valid.<br> <br> <table cellpadding="5"> <!-- cols="30 70" --> <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_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_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"><img src="delta.gif" alt="Start of change"><em>EIMERR_REGTYPE_INVAL (62)</em></td> <td align="left" valign="top">Registry type is not valid.<img src="deltaend.gif" alt="End of change"></td> </tr> </table> <br> </dd> <!-- ============================================================== --> <!-- ENOENT --> <!-- ============================================================== --> <dt><strong>ENOENT</strong></dt> <dd>System registry not found.<br> <br> <table cellpadding="5"> <!-- cols="25 75" --> <tr> <td align="left" valign="top"><em>EIMERR_NO_SYSREG (33)</em></td> <td align="left" valign="top">System registry not found.</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>User Defined Registry Type</h3> <p>The registry type is comprised of two pieces: a string form of an OID that represents the registry type and a user name normalization method. The normalization method is necessary because some registries are case-independent and others are case-dependent. Platforms can define their own registry type. They would first define a unique OID for their registry and then concatenate it with the predefined normalization methods. Refer to eim.h for the supported normalization methods.</p> <p>Example:</p> <pre> #define MYREGOID "7.6.5.4.3.2.1" MyRegType = MYREGOID + EIM_NORM_CASE_IGNORE; </pre> <h3>Restrictions</h3> <p>There is a restriction on the characters allowed for registry 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="eimaddsystemregistry.htm">eimAddSystemRegistry()</a> --Add a System Registry to the EIM Domain<br> <br> </li> <li><img src="delta.gif" alt="Start of change"><a href="eimaddgroupregistry.htm">eimAddGroupRegistry()</a> --Add a Group Registry to the EIM Domain<img src="deltaend.gif" alt="End of change"><br> <br> </li> <li><a href="eimremoveregistry.htm">eimRemoveRegistry()</a> --Remove a Registry from the EIM Domain<br> <br> </li> <li><a href="eimchangeregistry.htm">eimChangeRegistry()</a> --Change EIM Registry<br> <br> </li> <li><a href="eimlistregistries.htm">eimListRegistries()</a> --List EIM Registries<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 creates a new EIM application registry.</p> <pre> #include <eim.h> #include <stdio.h> int main(int argc, char *argv[]) { int rc; char eimerr[100]; EimRC * err; EimHandle * handle; <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 application registry */</em> if (0 != (rc = eimAddApplicationRegistry(handle, "MyXXXRegistry", EIM_REGTYPE_OS400, "For XXX applications", "MyRegistry", err))) printf("Add application registry 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>