<!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>eimGetAttribute()--Get EIM Attributes</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>eimGetAttribute()--Get EIM attributes</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 eimGetAttribute(EimHandle * <em>eim</em>, enum EimHandleAttr <em>attrName</em>, unsigned int <em>lengthOfEimAttribute</em>, EimAttribute * <em>attribute</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>eimGetAttribute()</strong> function is used to get attributes for this EIM handle.</p> <p>The ldap configuration file is used to retrieve information for the master host, master port, and secure port. If the host system is not a replica then the master information retrieved is the same as the host and port defined in the handle.</p> <p><br> <!-- ============================================================== --> <!-- --> <!-- A U T H O R I T I E S A N D L O C K S --> <!-- --> <!-- ============================================================== --> <!-- ============================================================== --> <!-- --> <!-- P A R A M E T E R S --> <!-- --> <!-- ============================================================== --></p> <br> <!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. --> <!-- Instead, use the commented out coding below to indicate NONE. --> <h3>Authorities and Locks</h3> <!-- Use this if there are no authorities and locks. --> <p>None.</p> <br> <h3>Parameters</h3> <dl><!-- ============================================================== --> <!-- eim --> <!-- ============================================================== --> <dt><strong>eim</strong> (Input)</dt> <dd>The EIM handle returned by a previous call to eimCreateHandle().<br> <br> </dd> <!-- ============================================================== --> <!-- attrName --> <!-- ============================================================== --> <dt><strong>attrName</strong> (Input)</dt> <dd>The name of the attribute to retrieve. Following are valid values:<br> <br> <table cellpadding="5"> <!-- cols="35 65" --> <tr> <td align="left" valign="top"><em>EIM_HANDLE_CCSID (0)</em></td> <td align="left" valign="top">This is the CCSID of character data passed by the caller of EIM APIs with the specified EimHandle. The returned field is a 4 byte integer.</td> </tr> <tr> <td align="left" valign="top"><em>EIM_HANDLE_DOMAIN (1)</em></td> <td align="left" valign="top">The EIM domain name.</td> </tr> <tr> <td align="left" valign="top"><em>EIM_HANDLE_HOST (2)</em></td> <td align="left" valign="top">The host system for the EIM domain.</td> </tr> <tr> <td align="left" valign="top"><em>EIM_HANDLE_PORT (3)</em></td> <td align="left" valign="top">The port for the EIM connection. The returned field is a 4 byte integer.</td> </tr> <tr> <td align="left" valign="top"><em>EIM_HANDLE_SECPORT (4)</em></td> <td align="left" valign="top">Security type for this connection. The returned field is a 4 byte integer. Possible values: <ul> <li>0 - Non-SLL</li> <li>1- Port uses SSL</li> </ul> </td> </tr> <tr> <td align="left" valign="top"><em>EIM_HANDLE_MASTER_HOST (5)</em></td> <td align="left" valign="top">If the EIM_HANDLE_HOST is a replica LDAP server, this value will indicate the master LDAP server.</td> </tr> <tr> <td align="left" valign="top"><em>EIM_HANDLE_MASTER_PORT (6)</em></td> <td align="left" valign="top">If the EIM_HANDLE_HOST is a replica LDAP server, this value will indicate the port for the master LDAP server. The returned field is a 4 byte integer.</td> </tr> <tr> <td align="left" valign="top" nowrap><em>EIM_HANDLE_MASTER_SECPORT (7)</em></td> <td align="left" valign="top">If the EIM_HANDLE_HOST is a replica LDAP server, this value will indicate the security type for the master LDAP server. The returned field is a 4 byte integer.</td> </tr> </table> <br> </dd> <!-- ============================================================== --> <!-- lengthOfEimAttribute --> <!-- ============================================================== --> <dt><strong>lengthOfEimAttribute</strong> (Input)</dt> <dd>The number of bytes provided by the caller for the attribute information. Minimum size required is 16 bytes.<br> <br> </dd> <!-- ============================================================== --> <!-- attribute --> <!-- ============================================================== --> <dt><strong>attribute</strong> (Output)</dt> <dd>A pointer to the data to be returned. <p>The EimAttribute structure contains information about the returned data. The API will return as much data as space has been provided.</p> <!-- ============================================================== --> <!-- EimAttribute --> <!-- ============================================================== --> <p>EimAttribute structure:</p> <pre> typedef struct EimAttribute { 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 */ EimListData attribute; /* handle attribute */ } EimAttribute; </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> </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. 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> <!-- ============================================================== --> <!-- 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_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_ATTRIB_SIZE (53)</em></td> <td align="left" valign="top">Length of EimAttribute is not valid.</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> </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. When configured for SSL we cannot retrieve the master information until a connection has been established to the configured system.<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> <!-- ============================================================== --> <!-- ENOTSUP --> <!-- ============================================================== --> <dt><strong>ENOTSUP</strong></dt> <dd>Attribute type is not supported.<br> <br> <table cellpadding="5"> <!-- cols="35 65" --> <tr> <td align="left" valign="top"><em>EIMERR_ATTR_NOTSUPP (6)</em></td> <td align="left" valign="top">Attribute not supported.</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="eimcreatehandle.htm">eimCreateHandle()</a>--Create an EIM Handle<br> <br> </li> <li><a href="eimdestroyhandle.htm">eimDestroyHandle()</a>--Destroy an EIM Handle<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 will get the domain for the EIM handle.</p> <pre> #include <eim.h> #include <stddef.h> #include <stdio.h> #include <stdlib.h> int main(int argc, char *argv[]) { int rc; char eimerr[100]; EimRC * err; EimHandle * handle; char * data; char * listData[1000]; EimAttribute * list = (EimAttribute *) 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 EIM domain name */</em> if (0 != (rc = eimGetAttribute(handle, EIM_HANDLE_DOMAIN, 1000, list, err))) printf("Get Attribute error = %d", rc); <em>/* Print results */</em> printf(" Bytes returned = %d.\n", list->bytesReturned); printf(" Bytes available = %d.\n", list->bytesAvailable); printf(" Attr size = %d.\n", list->attribute.length); printf(" Attr disp = %d.\n", list->attribute.disp); data = (char * )list + list->attribute.disp; printf(" %s = %s.\n", "domain name", data); 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>