#include <eim.h>
int eimListAssociations(EimHandle * eim,
enum EimAssociationType associationType,
EimIdentifierInfo * idName,
unsigned int lengthOfListData,
EimList * listData,
EimRC * eimrc)
Service Program Name: QSYS/QSYEIMThe eimListAssociations() function returns a list of associations for a given EIM identifier. This can be used to find all of the associated identities for an individual in the enterprise.
The list returned contains only the information that the user has authority to access.
| EIM_ALL_ASSOC (0) | List all target, source, and administrative associations. |
| EIM_TARGET (1) | List target associations. |
| EIM_SOURCE (2) | List source associations. |
| EIM_SOURCE_AND_TARGET (3) | List both source and target associations. |
| EIM_ADMIN (4) | List administrative associations. |
enum EimIdType {
EIM_UNIQUE_NAME,
EIM_ENTRY_UUID,
EIM_NAME
};
typedef struct EimIdentifierInfo
{
union {
char * uniqueName;
char * entryUUID;
char * name;
} id;
enum EimIdType idtype;
} EimIdentifierInfo;
idtype indicates which identifier name is provided. Use of the uniqueName provides the best performance. Specifying an idtype of EIM_NAME does not guarantee that a unique EIM identifier will be found. Therefore, use of EIM_NAME may result in an error.
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 EimAssociation structures. firstEntry is used to get to the first EimAssociation structure in the linked list.
EimList structure:
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;
EimAssociation structure:
typedef struct EimAssociation
{
unsigned int nextEntry; /* Displacement to next entry. This
byte offset is relative to the
start of this structure */
enum EimAssociationType associationType; /* Type of association */
EimListData registryType; /* Registry type */
EimListData registryName; /* Registry name */
EimListData registryUserName; /* Registry user name */
} EimAssociation;
EimListData structure:
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;
The return value from the API. Following each return value is the list of possible values for the messageCatalogMessageID field in the eimrc parameter for that value.
| EIMERR_ACCESS (1) | Insufficient access to EIM data. |
| EIMERR_IDNAME_AMBIGUOUS (20) | More than 1 EIM Identifier was found that matches the requested Identifier name. |
| EIMERR_NOIDENTIFIER (25) | EIM Identifier not found or insufficient access to EIM data. |
| EIMERR_NOLOCK (26) | Unable to allocate internal system object. |
| EIMERR_DATA_CONVERSION (13) | Error occurred when converting data between code pages. |
| EIMERR_ASSOC_TYPE_INVAL (4) | Association type is not valid. |
| EIMERR_EIMLIST_SIZE (16) | Length of EimList is not valid. EimList must be at least 20 bytes in length. |
| EIMERR_HANDLE_INVAL (17) | EimHandle is not valid. |
| EIMERR_IDNAME_TYPE_INVAL (52) | The EimIdType value is not valid. |
| EIMERR_PARM_REQ (34) | Missing required parameter. Please check API documentation. |
| EIMERR_PTR_INVAL (35) | Pointer parameter is not valid. |
| EIMERR_SPACE (41) | Unexpected error accessing parameter. |
| EIMERR_NOMEM (27) | No memory available. Unable to allocate required space. |
| EIMERR_NOT_CONN (31) | Not connected to LDAP. Use eimConnect() API and try the request again. |
| EIMERR_LDAP_ERR (23) | Unexpected LDAP error. %s |
| EIMERR_UNEXP_OBJ_ VIOLATION (56) | Unexpected object violation. |
| EIMERR_UNKNOWN (44) | Unknown error or unknown system state. |
The following example will list the associations for an identifier.
Note: By using the code examples, you agree to the terms of the Code license and disclaimer information.
#include <eim.h>
#include <stddef.h>
#include <stdio.h>
#include <stdlib.h>
void printListResults(EimList * list);
void printAssociationType(int type);
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;
EimIdentifierInfo x;
/* Get eim handle from input arg. */
/* This handle is already connected to EIM. */
handle = (EimHandle *)argv[1];
/* Set up error structure. */
memset(eimerr,0x00,100);
err = (EimRC *)eimerr;
err->memoryProvidedByCaller = 100;
/* Set up identifier information */
x.idtype = EIM_UNIQUE_NAME;
x.id.uniqueName = "mjones";
/* Get associations for this identifier */
if (0 != (rc = eimListAssociations(handle,
EIM_ALL_ASSOC,
&x,
1000,
list,
err)))
{
printf("List Association error = %d", rc);
return -1;
}
/* Print the results */
printListResults(list);
return 0;
}
void printListResults(EimList * list)
{
int i;
EimAssociation * 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 = (EimAssociation *)((char *)list + list->firstEntry);
for (i = 0; i < list->entriesReturned; i++)
{
printf("\n");
printf("===============\n");
printf("Entry %d.\n", i);
/* Association type */
printAssociationType(entry->associationType);
/* Print out results */
printListData("Registry Type",
entry,
offsetof(EimAssociation, registryType));
printListData("Registry Name",
entry,
offsetof(EimAssociation, registryName));
printListData("Registry User Name",
entry,
offsetof(EimAssociation, registryUserName));
/* advance to next entry */
entry = (EimAssociation *)((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(" Admin Association.\n");
break;
default:
printf("ERROR - unknown association type.\n");
break;
}
}
void printListData(char * fieldName,
void * entry,
int offset)
{
EimListData * listData;
char * data;
int dataLength;
printf(" %s = ",fieldName);
/* Address the EimListData object */
listData = (EimListData *)((char *)entry + offset);
/* Print out results */
data = (char *)entry + listData->disp;
dataLength = listData->length;
if (dataLength > 0)
printf("%.*s\n",dataLength, data);
else
printf("Not found.\n");
}
[ Back to top | Security APIs | APIs by category ]