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/eimchangeregistry.htm

600 lines
21 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>eimChangeRegistry()--Change EIM Registry</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> eimChangeRegistry()--Change EIM
Registry</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 eimChangeRegistry(EimHandle * <em>eim</em>,
char * <em>registryName</em>,
enum EimRegistryAttr <em>attrName</em>,
char * <em>attrValue</em>,
enum EimChangeType <em>changeType</em>,
EimRC * <em>eimrc</em>)
</pre>
&nbsp;&nbsp;Service Program Name: QSYS/QSYEIM&nbsp;&nbsp;<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>eimChangeRegistry()</strong> function changes the attribute of a
registry 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>
<li>EIM Registries Administrator</li>
<li>EIM authority to an individual registry</li>
</ul>
</dd>
</dl>
<br>
<!-- ============================================================== -->
<!-- -->
<!-- P A R A M E T E R S -->
<!-- -->
<!-- ============================================================== -->
<h3>Parameters</h3>
<dl><!-- ============================================================== -->
<!-- eim -->
<!-- ============================================================== -->
<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>
<!-- ============================================================== -->
<!-- registryName -->
<!-- ============================================================== -->
<dt><strong>registryName</strong>&nbsp;&nbsp;(Input)</dt>
<dd>The name of the registry to change.<br>
<br>
</dd>
<!-- ============================================================== -->
<!-- attrName -->
<!-- ============================================================== -->
<dt><strong>attrName</strong>&nbsp;&nbsp;(Input)</dt>
<dd>The attribute to be updated. Valid values are:
<br><br>
<table cellpadding="5">
<tr>
<td align="left" valign="top"><em>EIM_REGISTRY_DESCRIPTION (0)</em></td>
<td align="left" valign="top">Change the registry description. Valid
<em>changeType</em> is EIM_CHG (0).</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIM_REGISTRY_LABELEDURI (1)</em></td>
<td align="left" valign="top">Change the URI for the system registry. Valid
<em>changeType</em> is EIM_CHG (0).</td>
</tr>
<tr>
<td align="left" valign="top">
<em>EIM_REGISTRY_MAPPING_LOOKUP (2)</em></td>
<td align="left" valign="top">Change the indicator for whether or not the
registry supports any mapping lookup operations. By default,
the mapping lookup operations are supported. Valid
<em>changeType</em> is EIM_ENABLE (3) or EIM_DISABLE (4).
This attribute is controlled by the version of the API interface, not the domain. If
this attribute is disabled for the registry, it will only be checked in a
mapping lookup operation if the version of the mapping lookup API that is
used to access the domain supports this attribute.
<img src="delta.gif" alt="Start of change">
EIM version 2 must be supported by the local EIM APIs to specify this attribute
(see <a href="eimgetversion.htm">eimGetVersion()</a>--Get EIM Version).
<img src="deltaend.gif" alt="End of change">
</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIM_REGISTRY_POLICY_ASSOCIATIONS (3)</em></td>
<td align="left" valign="top">Change the indicator for whether or not the
registry supports policy associations in a mapping lookup. By default,
the policy associations are not supported. Valid
<em>changeType</em> is EIM_ENABLE (3) or EIM_DISABLE (4).
This attribute is controlled by the version of the API interface, not the domain. If
this attribute is enabled for the registry, it will only be checked in a
mapping lookup operation if the version of the mapping lookup API that is
used to access the domain supports this attribute.
<img src="delta.gif" alt="Start of change">
EIM version 2 must be supported by the local EIM APIs to specify this attribute
(see <a href="eimgetversion.htm">eimGetVersion()</a>--Get EIM Version).
<img src="deltaend.gif" alt="End of change">
<tr>
<td align="left" valign="top"><img src="delta.gif" alt="Start of change"><em>EIM_REGISTRY_MEMBER (4)</em></td>
<td align="left" valign="top">Change the list of registries that are members of
this group registry. The <em>registryName</em> parameter must be the name of
a registry that has a type of group registry to change this attribute.
The registry name specified in the <em>attrValue</em> parameter must exist
and cannot have a type of group registry. The normalization method for the
group registry must be the same as the normalization method for the member.
Valid <em>changeType</em> is EIM_ADD (1) or EIM_RMV (2).
EIM version 3 must be supported by the local EIM APIs to specify this attribute
(see <a href="eimgetversion.htm">eimGetVersion()</a>--Get EIM Version).
<img src="deltaend.gif" alt="End of change"></td>
</tr>
</td>
</tr>
</table>
<br>
</dd>
<!-- ============================================================== -->
<!-- attrValue -->
<!-- ============================================================== -->
<dt><strong>attrValue</strong>&nbsp;&nbsp;(Input)</dt>
<dd>The new value for the attribute.<br>
<br>
<p>If the attribute being changed is EIM_REGISTRY_MAPPING_LOOKUP or
EIM_REGISTRY_POLICY_ASSOCIATIONS, this value must be NULL.
</dd>
<!-- ============================================================== -->
<!-- changeType -->
<!-- ============================================================== -->
<dt><strong>changeType</strong>&nbsp;&nbsp;(Input)</dt>
<dd>The type of change to make. This could be add, remove, change, enable, or disable.
&nbsp; <em>attrName</em> parameter indicates which type is allowed for each
attribute.<br>
<br>
</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">
<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">
<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">
<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">
<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">
<tr>
<td align="left" valign="top"><em>EIMERR_ATTR_INVAL (5)</em></td>
<td align="left" valign="top">Attribute name is not valid.</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIMERR_CHGTYPE_INVAL (9)</em></td>
<td align="left" valign="top">This change type is not valid with the requested
attribute. Please check the API documentation.</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"><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>
<tr>
<td align="left" valign="top"><em>EIMERR_FUNCTION_NOT_SUPPORTED (70)</em></td>
<td align="left" valign="top">The specified function is not supported
by the EIM version.</td>
</tr>
</table>
<br>
</dd>
<!-- ============================================================== -->
<!-- ENOMEM -->
<!-- ============================================================== -->
<dt><strong>ENOMEM</strong></dt>
<dd>Unable to allocate required space.<br>
<br>
<table cellpadding="5">
<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">
<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">
<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">
<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></td>
</tr>
<tr>
<td align="left" valign="top">EIMERR_UNKNOWN (44)</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="eimaddsystemregistry.htm">eimAddSystemRegistry()</a> --Add a
System Registry to the EIM Domain<br>
<br>
</li>
<li><a href="eimaddapplicationregistry.htm">eimAddApplicationRegistry()</a>
--Add an Application Registry to the EIM Domain<br>
<br>
</li>
<li><a href="eimaddgroupregistry.htm"><img src="delta.gif" alt="Start of change">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="eimlistregistries.htm">eimListRegistries()</a> --List EIM
Registries<br>
<br>
</li>
<li><a href="eimchangedomain.htm">eimChangeDomain()</a> --Change EIM
Domain<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 changes the description for the registry and enables the use of policy associations for the registry.</p>
<pre>
#include &lt;eim.h&gt;
#include &lt;stdio.h&gt;
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-&gt;memoryProvidedByCaller = 100;
<em>/* Change the description for this registry */</em>
if (0 != (rc = eimChangeRegistry(handle,
&quot;MyAppRegistry&quot;,
EIM_REGISTRY_DESCRIPTION,
&quot;New description&quot;,
EIM_CHG,
err)))
printf(&quot;Change registry error = %d&quot;, rc);
<em>/* Enable the use of default registry policies. */</em>
if (0 != (rc = eimChangeRegistry(handle,
&quot;MyAppRegistry&quot;,
EIM_REGISTRY_POLICY_ASSOCIATIONS,
NULL,
EIM_ENABLE,
err)))
printf(&quot;Change registry error = %d&quot;, 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>
Reference in New Issue View Git Blame Copy Permalink