857 lines
30 KiB
HTML
857 lines
30 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>eimListRegistryAssociations()--List EIM Registry Associations</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 -->
|
||
|
<!-- 030224 HTML cleanup by JET -->
|
||
|
<!-- 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>eimListRegistryAssociations()--List EIM Registry Associations</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 eimListRegistryAssociations(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>
|
||
|
|
||
|
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>eimListRegistryAssociations()</strong> function
|
||
|
lists association information for the registry or domain.
|
||
|
</p>
|
||
|
|
||
|
|
||
|
<!-- ============================================================== -->
|
||
|
<!-- -->
|
||
|
<!-- A U T H O R I T I E S A N D L O C K S -->
|
||
|
<!-- -->
|
||
|
<!-- ============================================================== -->
|
||
|
<br>
|
||
|
<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.</dd>
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
<!-- ============================================================== -->
|
||
|
<!-- -->
|
||
|
<!-- P A R A M E T E R S -->
|
||
|
<!-- -->
|
||
|
<!-- ============================================================== -->
|
||
|
<br>
|
||
|
<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>
|
||
|
|
||
|
<!-- ============================================================== -->
|
||
|
<!-- associationType -->
|
||
|
<!-- ============================================================== -->
|
||
|
<dt><strong>associationType</strong> (Input)</dt>
|
||
|
|
||
|
<dd>The type of associations to be listed.
|
||
|
<p>
|
||
|
<img src="delta.gif" alt="Start of change">
|
||
|
EIM version 2 must be supported by the local EIM APIs to specify a policy association type
|
||
|
(see <a href="eimgetversion.htm">eimGetVersion()</a>--Get EIM Version).
|
||
|
<img src="deltaend.gif" alt="End of change">
|
||
|
</p>
|
||
|
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">List all associations.</td>
|
||
|
</tr>
|
||
|
|
||
|
<tr>
|
||
|
<td align="left" valign="top"><em>EIM_TARGET (1)</em></td>
|
||
|
<td align="left" valign="top">List target associations.</td>
|
||
|
</tr>
|
||
|
|
||
|
<tr>
|
||
|
<td align="left" valign="top"><em>EIM_SOURCE (2)</em></td>
|
||
|
<td align="left" valign="top">List source associations.</td>
|
||
|
</tr>
|
||
|
|
||
|
<tr>
|
||
|
<td align="left" valign="top"><em>EIM_SOURCE_AND_TARGET (3)</em></td>
|
||
|
<td align="left" valign="top">List source and target associations.</td>
|
||
|
</tr>
|
||
|
|
||
|
<tr>
|
||
|
<td align="left" valign="top"><em>EIM_ADMIN (4)</em></td>
|
||
|
<td align="left" valign="top">List administrative associations.</td>
|
||
|
</tr>
|
||
|
|
||
|
<tr>
|
||
|
<td align="left" valign="top"><em>EIM_ALL_POLICY_ASSOC (5)</em></td>
|
||
|
<td align="left" valign="top">List all policy associations.</td>
|
||
|
</tr>
|
||
|
|
||
|
<tr>
|
||
|
<td align="left" valign="top"><em>EIM_CERT_FILTER_POLICY (6)</em></td>
|
||
|
<td align="left" valign="top">List certificate filter policy associations.</td>
|
||
|
</tr>
|
||
|
|
||
|
<tr>
|
||
|
<td align="left" valign="top"><em>EIM_DEFAULT_REG_POLICY (7)</em></td>
|
||
|
<td align="left" valign="top">List default registry policy associations.</td>
|
||
|
</tr>
|
||
|
|
||
|
<tr>
|
||
|
<td align="left" valign="top" nowrap><em>EIM_DEFAULT_DOMAIN_POLICY (8)</em></td>
|
||
|
<td align="left" valign="top">List default domain policy associations.</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
<br>
|
||
|
|
||
|
</dd>
|
||
|
|
||
|
<!-- ============================================================== -->
|
||
|
<!-- registryName -->
|
||
|
<!-- ============================================================== -->
|
||
|
<dt><strong>registryName</strong> (Input)</dt>
|
||
|
|
||
|
<dd>The name of the registry for which to list association information.
|
||
|
If a NULL value is specified, then association information for the
|
||
|
entire domain will be listed. The <em>registryUserName</em> parameter
|
||
|
must also be NULL if this parameter is NULL.
|
||
|
<br>
|
||
|
<br>
|
||
|
If the <em>registryUserName</em> parameter is NULL, then for
|
||
|
policy associations, the association information
|
||
|
will include policy associations where the registry is the source
|
||
|
registry or the target registry.
|
||
|
If the <em>registryUserName</em> parameter is not NULL, then
|
||
|
the association information will include policy associations where
|
||
|
the registry is the target registry.
|
||
|
<br>
|
||
|
<br>
|
||
|
</dd>
|
||
|
|
||
|
<!-- ============================================================== -->
|
||
|
<!-- registryUserName -->
|
||
|
<!-- ============================================================== -->
|
||
|
<dt><strong>registryUserName</strong> (Input)</dt>
|
||
|
|
||
|
<dd>The name of the registry user name for which to list association information.
|
||
|
<br>
|
||
|
<br>
|
||
|
</dd>
|
||
|
|
||
|
<!-- ============================================================== -->
|
||
|
<!-- lengthOfListData -->
|
||
|
<!-- ============================================================== -->
|
||
|
<dt><strong>lengthOfListData</strong> (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> (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 EimRegistryAssociation structures. firstEntry is used to get
|
||
|
to the first EimRegistryAssociation 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>
|
||
|
|
||
|
<!-- ============================================================== -->
|
||
|
<!-- EimRegistryAssociation -->
|
||
|
<!-- ============================================================== -->
|
||
|
<p>EimRegistryAssociation structure:</p>
|
||
|
|
||
|
<pre>
|
||
|
typedef struct EimRegistryAssociation
|
||
|
{
|
||
|
unsigned int nextEntry; /* Displacement to next entry. This
|
||
|
byte offset is relative to the
|
||
|
start of this structure */
|
||
|
enum EimAssociationType type; /* Type of association. */
|
||
|
EimListData registryName; /* Registry name the association
|
||
|
is defined to. */
|
||
|
EimListData registryUserName; /* Registry user name the
|
||
|
association is defined to. */
|
||
|
EimListData identifier; /* Unique name for eim identifier */
|
||
|
EimListData sourceRegistry; /* Source registry name the
|
||
|
association is defined for. */
|
||
|
EimListData filterValue; /* Filter value */
|
||
|
enum EimStatus domainPolicyAssocStatus;
|
||
|
/* Policy association status for
|
||
|
the domain:
|
||
|
0 = not enabled
|
||
|
1 = enabled */
|
||
|
enum EimStatus sourceMappingLookupStatus;
|
||
|
/* Mapping lookup status for the
|
||
|
source registry:
|
||
|
0 = not enabled
|
||
|
1 = enabled */
|
||
|
enum EimStatus targetMappingLookupStatus;
|
||
|
/* Mapping lookup status for the
|
||
|
target registry:
|
||
|
0 = not enabled
|
||
|
1 = enabled */
|
||
|
enum EimStatus targetPolicyAssocStatus;
|
||
|
/* Policy association status for
|
||
|
the target registry:
|
||
|
0 = not enabled
|
||
|
1 = enabled */
|
||
|
} EimRegistryAssociation;
|
||
|
</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>
|
||
|
<p>If the <em>type</em> field is EIM_TARGET (1), then the following
|
||
|
fields will be returned:
|
||
|
<ul>
|
||
|
<li>registryName</li>
|
||
|
<li>registryUserName</li>
|
||
|
<li>identifier</li>
|
||
|
<li>targetMappingLookupStatus</li>
|
||
|
</ul>
|
||
|
<p>If the <em>type</em> field is EIM_SOURCE (2), then the following
|
||
|
fields will be returned:
|
||
|
<ul>
|
||
|
<li>registryName</li>
|
||
|
<li>registryUserName</li>
|
||
|
<li>identifier</li>
|
||
|
<li>sourceMappingLookupStatus</li>
|
||
|
</ul>
|
||
|
<p>If the <em>type</em> field is EIM_ADMIN (4), then the following
|
||
|
fields will be returned:
|
||
|
<ul>
|
||
|
<li>registryName</li>
|
||
|
<li>registryUserName</li>
|
||
|
<li>identifier</li>
|
||
|
</ul>
|
||
|
<p>If the <em>type</em> field is EIM_CERT_FILTER_POLICY (6), then the following
|
||
|
fields will be returned:
|
||
|
<ul>
|
||
|
<li>registryName</li>
|
||
|
<li>registryUserName</li>
|
||
|
<li>sourceRegistry</li>
|
||
|
<li>filterValue</li>
|
||
|
<li>domainPolicyAssocStatus</li>
|
||
|
<li>sourceMappingLookupStatus</li>
|
||
|
<li>targetMappingLookupStatus</li>
|
||
|
<li>targetPolicyAssocStatus</li>
|
||
|
</ul>
|
||
|
<p>If the <em>type</em> field is EIM_DEFAULT_REG_POLICY (7), then the following
|
||
|
fields will be returned:
|
||
|
<ul>
|
||
|
<li>registryName</li>
|
||
|
<li>registryUserName</li>
|
||
|
<li>sourceRegistry</li>
|
||
|
<li>domainPolicyAssocStatus</li>
|
||
|
<li>sourceMappingLookupStatus</li>
|
||
|
<li>targetMappingLookupStatus</li>
|
||
|
<li>targetPolicyAssocStatus</li>
|
||
|
</ul>
|
||
|
<p>If the <em>type</em> field is EIM_DEFAULT_DOMAIN_POLICY (8), then the following
|
||
|
fields will be returned:
|
||
|
<ul>
|
||
|
<li>registryName</li>
|
||
|
<li>registryUserName</li>
|
||
|
<li>domainPolicyAssocStatus</li>
|
||
|
<li>targetMappingLookupStatus</li>
|
||
|
<li>targetPolicyAssocStatus</li>
|
||
|
</ul>
|
||
|
<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 -->
|
||
|
<!-- -->
|
||
|
<!-- ============================================================== -->
|
||
|
<br>
|
||
|
<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 name is not valid 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"><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>
|
||
|
|
||
|
<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">
|
||
|
<!-- 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="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>
|
||
|
<tr>
|
||
|
<td align="left" valign="top"><em>EIMERR_UNEXP_OBJ_ VIOLATION (56)</em></td>
|
||
|
<td align="left" valign="top">Unexpected object violation.</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</dd>
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
<!-- ============================================================== -->
|
||
|
<!-- -->
|
||
|
<!-- 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 -->
|
||
|
<!-- -->
|
||
|
<!-- ============================================================== -->
|
||
|
<br>
|
||
|
<h3>Related Information</h3>
|
||
|
|
||
|
<ul>
|
||
|
|
||
|
<li><a href="eimaddpolicyassociation.htm">eimAddPolicyAssociation()</a>
|
||
|
--Add EIM Policy Association<br>
|
||
|
<br>
|
||
|
</li>
|
||
|
|
||
|
<li><a href="eimaddassociation.htm">eimAddAssociation()</a>
|
||
|
--Add EIM Association<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 lists the default registry policies for a registry.
|
||
|
</p>
|
||
|
|
||
|
<pre>
|
||
|
#include <eim.h>
|
||
|
#include <stddef.h>
|
||
|
#include <stdio.h>
|
||
|
#include <stdlib.h>
|
||
|
|
||
|
void printAssociationType(int type);
|
||
|
void printStatus(int status);
|
||
|
void printListResults(EimList * list);
|
||
|
void printListData(char * fieldName,
|
||
|
void * entry,
|
||
|
int offset);
|
||
|
|
||
|
|
||
|
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->memoryProvidedByCaller = 100;
|
||
|
|
||
|
<em>/* Get source registry policies */</em>
|
||
|
if (0 != (rc = eimListRegistryAssociations(handle,
|
||
|
EIM_DEFAULT_REG_POLICY,
|
||
|
"MySourceRegistry",
|
||
|
NULL,
|
||
|
1000,
|
||
|
list,
|
||
|
err)))
|
||
|
{
|
||
|
printf("List EIM Registry Associations error = %d", rc);
|
||
|
return -1;
|
||
|
}
|
||
|
|
||
|
<em>/* Print the results */</em>
|
||
|
printListResults(list);
|
||
|
|
||
|
return 0;
|
||
|
|
||
|
}
|
||
|
|
||
|
void printListResults(EimList * list)
|
||
|
{
|
||
|
int i;
|
||
|
EimRegistryAssociation * entry;
|
||
|
|
||
|
printf("___________\n");
|
||
|
printf(" bytesReturned = %d\n", list->bytesReturned);
|
||
|
printf(" bytesAvailable = %d\n", list->bytesAvailable);
|
||
|
printf(" entriesReturned = %d\n", list->entriesReturned);
|
||
|
printf(" entriesAvailable = %d\n", list->entriesAvailable);
|
||
|
printf("\n");
|
||
|
|
||
|
entry = (EimRegistryAssociation *)((char *)list + list->firstEntry);
|
||
|
for (i = 0; i < list->entriesReturned; i++)
|
||
|
{
|
||
|
printf("\n");
|
||
|
printf("===============\n");
|
||
|
printf("Entry %d.\n", i);
|
||
|
|
||
|
<em>/* Print out results */</em>
|
||
|
printAssociationType(entry->type);
|
||
|
printListData("Registry Name",
|
||
|
entry,
|
||
|
offsetof(EimRegistryAssociation, registryName));
|
||
|
printListData("Registry User Name",
|
||
|
entry,
|
||
|
offsetof(EimRegistryAssociation, registryUserName));
|
||
|
printListData("EIM identifier",
|
||
|
entry,
|
||
|
offsetof(EimRegistryAssociation, identifier));
|
||
|
printListData("Source Registry",
|
||
|
entry,
|
||
|
offsetof(EimRegistryAssociation, sourceRegistry));
|
||
|
printListData("Filter Value",
|
||
|
entry,
|
||
|
offsetof(EimRegistryAssociation, filterValue));
|
||
|
printStatus("Domain policy association status",entry->domainPolicyAssocStatus);
|
||
|
printStatus("Source registry mapping lookup status",entry->sourceMappingLookupStatus);
|
||
|
printStatus("Target registry mapping lookup status",entry->targetMappingLookupStatus);
|
||
|
printStatus("Target registry policy association status",entry->targetPolicyAssocStatus);
|
||
|
|
||
|
|
||
|
<em>/* advance to next entry */</em>
|
||
|
entry = (EimRegistryAssociation *)((char *)entry + entry->nextEntry);
|
||
|
|
||
|
}
|
||
|
printf("\n");
|
||
|
|
||
|
|
||
|
}
|
||
|
|
||
|
void printAssociationType(int type)
|
||
|
{
|
||
|
switch(type)
|
||
|
{
|
||
|
case EIM_TARGET:
|
||
|
printf(" Target Association.\n");
|
||
|
break;
|
||
|
case EIM_SOURCE:
|
||
|
printf(" Source Association.\n");
|
||
|
break;
|
||
|
case EIM_ADMIN:
|
||
|
printf(" Administrative Association.\n");
|
||
|
break;
|
||
|
case EIM_CERT_FILTER_POLICY:
|
||
|
printf(" Certificate Filter Policy Association.\n");
|
||
|
break;
|
||
|
case EIM_DEFAULT_REG_POLICY:
|
||
|
printf(" Default Registry Policy Association.\n");
|
||
|
break;
|
||
|
case EIM_DEFAULT_DOMAIN_POLICY:
|
||
|
printf(" Default Domain Policy Association.\n");
|
||
|
break;
|
||
|
default:
|
||
|
printf("ERROR - unknown association type.\n");
|
||
|
break;
|
||
|
}
|
||
|
}
|
||
|
|
||
|
void printStatus(char * fieldName,
|
||
|
int status)
|
||
|
{
|
||
|
printf(" %s = ",fieldName);
|
||
|
switch(status)
|
||
|
{
|
||
|
case EIM_STATUS_NOT_ENABLED:
|
||
|
printf(" Not enabled.\n");
|
||
|
break;
|
||
|
case EIM_STATUS_ENABLED:
|
||
|
printf(" Enabled.\n");
|
||
|
break;
|
||
|
default:
|
||
|
printf("ERROR - unknown status value.\n");
|
||
|
break;
|
||
|
}
|
||
|
}
|
||
|
|
||
|
void printListData(char * fieldName,
|
||
|
void * entry,
|
||
|
int offset)
|
||
|
{
|
||
|
EimListData * listData;
|
||
|
char * data;
|
||
|
int dataLength;
|
||
|
|
||
|
printf(" %s = ",fieldName);
|
||
|
<em>/* Address the EimListData object */</em>
|
||
|
listData = (EimListData *)((char *)entry + offset);
|
||
|
|
||
|
<em>/* Print out results */</em>
|
||
|
data = (char *)entry + listData->disp;
|
||
|
dataLength = listData->length;
|
||
|
|
||
|
if (dataLength > 0)
|
||
|
printf("%.*s\n",dataLength, data);
|
||
|
else
|
||
|
printf("Not found.\n");
|
||
|
|
||
|
}
|
||
|
</pre>
|
||
|
|
||
|
<br>
|
||
|
<!-- ============================================================== -->
|
||
|
<!-- -->
|
||
|
<!-- F O O T E R -->
|
||
|
<!-- -->
|
||
|
<!-- ============================================================== -->
|
||
|
|
||
|
<hr>
|
||
|
API introduced: V5R3
|
||
|
|
||
|
<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>
|
||
|
|