435 lines
15 KiB
HTML
435 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>eimRetrieveConfiguration()--Retrieve EIM Configuration</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>eimRetrieveConfiguration()--Retrieve EIM Configuration</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 eimRetrieveConfiguration(unsigned int <em>lengthOfEimConfig</em>,
|
|
EimConfig * <em>configData</em>,
|
|
int <em>ccsid</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>eimRetrieveConfiguration()</strong> function
|
|
retrieves the EIM configuration information for this system.</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>
|
|
|
|
<p>No authorization is required.</p>
|
|
|
|
|
|
<!-- ============================================================== -->
|
|
<!-- -->
|
|
<!-- P A R A M E T E R S -->
|
|
<!-- -->
|
|
<!-- ============================================================== -->
|
|
<br>
|
|
<h3>Parameters</h3>
|
|
|
|
<dl>
|
|
|
|
<!-- ============================================================== -->
|
|
<!-- lengthOfEimConfig -->
|
|
<!-- ============================================================== -->
|
|
<dt><strong>lengthOfEimConfig</strong> (Input)</dt>
|
|
|
|
<dd>The number of bytes provided by the caller for the configuration information.
|
|
Minimal size required is 36 bytes.
|
|
|
|
<br><br></dd>
|
|
|
|
<!-- ============================================================== -->
|
|
<!-- configData -->
|
|
<!-- ============================================================== -->
|
|
<dt><strong>configData</strong> (Output)</dt>
|
|
|
|
<dd>A pointer to the data to be returned.
|
|
<p>The EimConfig structure contains information about the returned data.
|
|
The API will return as much data as space has been provided.</p>
|
|
|
|
<p>EimConfig structure:</p>
|
|
<pre>
|
|
typedef struct EimConfig
|
|
{
|
|
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. */
|
|
int enable; /* Flag to indicate if enabled to
|
|
participate in EIM domain
|
|
0 = not enabled
|
|
1 = enabled */
|
|
EimListData ldapURL; /* ldap URL for domain controller */
|
|
EimListData localRegistry; /* Local system registry */
|
|
EimListData kerberosRegistry; /* Kerberos registry */
|
|
|
|
EimListData x509Registry; /* X.509 registry */
|
|
|
|
} EimConfig;
|
|
</pre>
|
|
|
|
<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>
|
|
|
|
</dd>
|
|
|
|
<!-- ============================================================== -->
|
|
<!-- ccsid -->
|
|
<!-- ============================================================== -->
|
|
<dt><strong>ccsid </strong> (Input)</dt>
|
|
|
|
<dd>The ccsid for the output data. If the ccsid is 0 or 65535 the
|
|
default job ccsid will be used.
|
|
<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 -->
|
|
<!-- -->
|
|
<!-- ============================================================== -->
|
|
<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>
|
|
|
|
<!-- ============================================================== -->
|
|
<!-- EBADDATA -->
|
|
<!-- ============================================================== -->
|
|
<dt><strong>EBADDATA </strong></dt>
|
|
|
|
<dd>eimrc is not valid.<br>
|
|
<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="25 75" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>EIMERR_CCSID_INVAL (8)</em></td>
|
|
<td align="left" valign="top">CCSID is outside of valid range or CCSID is not supported.</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left" valign="top"><em>EIMERR_CONFIG_SIZE (10)</em></td>
|
|
<td align="left" valign="top">Length of EimConfig 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>
|
|
</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>
|
|
|
|
<!-- ============================================================== -->
|
|
<!-- 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>
|
|
|
|
<!-- ============================================================== -->
|
|
<!-- -->
|
|
<!-- 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="eimsetconfiguration.htm">eimSetConfiguration()</a>
|
|
--Set EIM Configuration<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 retrieves the configuration information and
|
|
prints out the results..
|
|
</p>
|
|
|
|
<pre>
|
|
#include <eim.h>
|
|
#include <stddef.h>
|
|
#include <stdio.h>
|
|
#include <stdlib.h>
|
|
|
|
void printListData(char * fieldName,
|
|
void * entry,
|
|
int offset);
|
|
|
|
int main (int argc, char *argv[])
|
|
{
|
|
int rc;
|
|
char eimerr[100];
|
|
EimRC * err;
|
|
char listData[4000];
|
|
EimConfig * list = (EimConfig * ) listData;
|
|
|
|
<em>/* Set up error structure. */</em>
|
|
memset(eimerr,0x00,100);
|
|
err = (EimRC *)eimerr;
|
|
err->memoryProvidedByCaller = 100;
|
|
|
|
<em>/* Get configuration information */</em>
|
|
if (0 != (rc = eimRetrieveConfiguration(4000,
|
|
list,
|
|
0,
|
|
err)))
|
|
{
|
|
printf("Retrieve configuration error = %d", rc);
|
|
return -1;
|
|
}
|
|
|
|
<em>/* Print the results */</em>
|
|
printf("___________\n");
|
|
printf(" bytesReturned = %d\n", list->bytesReturned);
|
|
printf(" bytesAvailable = %d\n", list->bytesAvailable);
|
|
printf("\n");
|
|
|
|
if (0 == list->enable)
|
|
printf("Disabled.\n");
|
|
else
|
|
printf("Enabled.\n");
|
|
|
|
printListData("ldap URL",
|
|
list,
|
|
offsetof(EimConfig, ldapURL));
|
|
printListData("local Registry",
|
|
list,
|
|
offsetof(EimConfig, localRegistry));
|
|
printListData("kerberos registry",
|
|
list,
|
|
offsetof(EimConfig, kerberosRegistry));
|
|
|
|
printListData("x.509 registry",
|
|
list,
|
|
offsetof(EimConfig, x509Registry));
|
|
|
|
|
|
return 0;
|
|
}
|
|
|
|
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: 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>
|
|
|