460 lines
15 KiB
HTML
460 lines
15 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>eimCreateHandle()--Create an EIM Handle</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>eimCreateHandle()--Create an EIM
|
||
|
|
Handle</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 eimCreateHandle(EimHandle * <em>eim</em>,
|
||
|
|
char * <em>ldapURL</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>eimCreateHandle()</strong> function is used to allocate
|
||
|
|
an EimHandle structure, which is used to identify the EIM connection
|
||
|
|
and to maintain per-connection information. The EimHandle structure
|
||
|
|
should be passed on subsequent calls to other EIM operations.</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>
|
||
|
|
|
||
|
|
<p>If a NULL is not passed for the ldapURL parameter,
|
||
|
|
then the caller of the API must have *SECADM special authority.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- P A R A M E T E R S -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
|
||
|
|
<h3>Parameters</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- eim -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<dt><strong>eim</strong> (Output)</dt>
|
||
|
|
|
||
|
|
<dd>
|
||
|
|
The pointer to an EIM handle to be returned. This handle is used as input
|
||
|
|
for other EIM APIs. The handle is temporary; you can use it only in the job
|
||
|
|
that created it.
|
||
|
|
<br><br></dd>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- ldapURL -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<dt><strong>ldapURL</strong> (Input)</dt>
|
||
|
|
|
||
|
|
<dd>A uniform resource locator (URL) that contains the EIM host information.
|
||
|
|
A NULL parameter indicates that the <samp>ldapURL</samp> information
|
||
|
|
set by the eimSetConfiguration() API should be used.
|
||
|
|
This URL has the following format:
|
||
|
|
|
||
|
|
<pre>
|
||
|
|
ldap://host:port/dn
|
||
|
|
or
|
||
|
|
ldaps://host:port/dn
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<p>where:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li><samp>host:port</samp> is the name of the host on which the EIM domain
|
||
|
|
controller is running with an optional port number.</li>
|
||
|
|
|
||
|
|
<li><samp>dn</samp> is the distinguished name of the domain to work with.</li>
|
||
|
|
|
||
|
|
<li><samp>ldaps</samp> indicates that this host/port combination uses SSL and
|
||
|
|
TLS.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>Examples:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>ldap://systemx:389/ibm-eimDomainName=myEimDomain,o=myCompany,c=us</li>
|
||
|
|
|
||
|
|
<li>ldaps://systemy:636/ibm-eimDomainName=thisEimDomain</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 -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
|
||
|
|
<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.<br>
|
||
|
|
<br>
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="25 75" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>EIMERR_AUTH_ERR (7)</em></td>
|
||
|
|
<td align="left" valign="top">Insufficient authority for the operation.</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>
|
||
|
|
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- 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_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_URL_NODN (45)</em></td>
|
||
|
|
<td align="left" valign="top">URL has no dn (required).</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>EIMERR_URL_NODOMAIN (46)</em></td>
|
||
|
|
<td align="left" valign="top">URL has no domain (required).</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>EIMERR_URL_NOHOST (47)</em></td>
|
||
|
|
<td align="left" valign="top">URL does not have a host.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>EIMERR_URL_NOTLDAP (49)</em></td>
|
||
|
|
<td align="left" valign="top">URL does not begin with ldap.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em> EIMERR_INVALID_DN (66)</em></td>
|
||
|
|
<td align="left" valign="top">Distinguished Name (DN) 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>
|
||
|
|
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- ENOSYS -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<dt><strong>ENOSYS </strong></dt>
|
||
|
|
|
||
|
|
<dd>EIM is not configured.<br>
|
||
|
|
<br>
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="25 75" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>EIMERR_NOTCONFIG (30)</em></td>
|
||
|
|
<td align="left" valign="top">EIM environment is not configured. Run
|
||
|
|
eimSetConfiguration() 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>
|
||
|
|
</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="eimdestroyhandle.htm">eimDestroyHandle()</a>--Destroy an EIM
|
||
|
|
Handle<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="eimgetattribute.htm">eimGetAttribute()</a>--Get EIM Attributes<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="eimsetattribute.htm">eimSetAttribute()</a>--Set EIM Attributes<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="eimconnecttomaster.htm">eimConnectToMaster()</a>--Connect to EIM
|
||
|
|
Master Domain<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="eimconnect.htm">eimConnect()</a>--Connect to 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 creates an EIM handle.</p>
|
||
|
|
|
||
|
|
<pre>
|
||
|
|
#include <eim.h>
|
||
|
|
#include <stdio.h>
|
||
|
|
|
||
|
|
int main(int argc, char *argv[])
|
||
|
|
{
|
||
|
|
int rc;
|
||
|
|
char eimerr[100];
|
||
|
|
EimRC * err;
|
||
|
|
EimHandle handle;
|
||
|
|
EimHandle handle2;
|
||
|
|
char * ldapURL = "ldap://eimsystem:389/ibm-eimDomainName=myEimDomain,o=mycompany,c=us";
|
||
|
|
|
||
|
|
<em>/* Set up error structure. */</em>
|
||
|
|
memset(eimerr,0x00,100);
|
||
|
|
err = (EimRC *)eimerr;
|
||
|
|
err->memoryProvidedByCaller = 100;
|
||
|
|
|
||
|
|
|
||
|
|
<em>/* Create a new eim handle. Use the eim configuration URL */</em>
|
||
|
|
if (0 != (rc = eimCreateHandle(&handle,
|
||
|
|
NULL,
|
||
|
|
err)))
|
||
|
|
printf("Create handle error = %d", rc);
|
||
|
|
|
||
|
|
<em>/* Create a new eim handle. Use the specified URL */</em>
|
||
|
|
if (0 != (rc = eimCreateHandle(&handle2,
|
||
|
|
ldapURL,
|
||
|
|
err)))
|
||
|
|
printf("Create handle 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>
|
||
|
|
|