#include <eim.h> int eimListIdentifiers(EimHandle * eim, EimIdentifierInfo * idName, unsigned int lengthOfListData, EimList * listData, EimRC * eimrc)Service Program Name: QSYS/QSYEIM
The eimListIdentifiers() function returns a list of identifiers in the EIM domain. idName can be used to filter the results returned.
The list returned contains only the information that the user has authority to access.
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 will indicate which identifier name has been provided. There is no guarantee that name will find a unique identifier. Therefore, use of name may result in multiple identifiers being returned. The id values, uniqueName, entryUUID and name may contain the wild card (*).
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 EimIdentifier structures. firstEntry is used to get to the first EimIdentifier 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;
EimIdentifier structure:
typedef struct EimIdentifier { unsigned int nextEntry; /* Displacement to next entry. This byte offset is relative to the start of this structure */ EimListData uniquename; /* Unique name */ EimListData description; /* Description */ EimListData entryUUID; /* UUID */ EimSubList names; /* EimIdentifierName sublist */ EimSubList additionalInfo; /* EimAddlInfo sublist */ enum EimAssociationType type; /* Association type - not valid */ EimListData groupRegistry; /* Group registry - not valid */ } EimIdentifier;
Identifiers may have several name attributes as well as several additional information attributes. In the EimIdentifier structure, the names EimSubList gives addressability to a linked list of EimIdentifierName structures.
EimIdentifierName structure:
typedef struct EimIdentifierName { unsigned int nextEntry; /* Displacement to next entry. This byte offset is relative to the start of this structure */ EimListData name; /* Name */ } EimIdentifierName;
The additionalInfo EimSubList gives addressability to a linked list of EimAddlInfo structures.
EimAddlInfo structure:
typedef struct EimAddlInfo { unsigned int nextEntry; /* Displacement to next entry. This byte offset is relative to the start of this structure */ EimListData addlInfo; /* Additional info */ } EimAddlInfo;
EimSubList structure:
typedef struct EimSubList { unsigned int listNum; /* Number of entries in the list */ unsigned int disp; /* Displacement to sublist. This byte offset is relative to the start of the parent structure; that is, the structure containing this structure. */ } EimSubList;
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_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_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_UNKNOWN (44) | Unknown error or unknown system state. |
See Code disclaimer information for information pertaining to code examples.
The following example will list all EIM identifiers.
#include <eim.h> #include <stddef.h> #include <stdio.h> #include <stdlib.h> void printListResults(EimList * list); void printSubListData(char * fieldName, void * entry, int offset); 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; /* 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; /* Get all identifiers */ if (0 != (rc = eimListIdentifiers(handle, NULL, 1000, list, err))) { printf("List identifiers error = %d", rc); return -1; } /* Print the results */ printListResults(list); return 0; } void printListResults(EimList * list) { int i; EimIdentifier * 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 = (EimIdentifier *)((char *)list + list->firstEntry); for (i = 0; i < list->entriesReturned; i++) { printf("\n"); printf("===============\n"); printf("Entry %d.\n", i); /* Print out results */ printListData("Unique name", entry, offsetof(EimIdentifier, uniquename)); printListData("description", entry, offsetof(EimIdentifier, description)); printListData("entryUUID", entry, offsetof(EimIdentifier, entryUUID)); printSubListData("Names", entry, offsetof(EimIdentifier, names)); printSubListData("Additional Info", entry, offsetof(EimIdentifier, additionalInfo)); /* advance to next entry */ entry = (EimIdentifier *)((char *)entry + entry->nextEntry); } printf("\n"); } void printSubListData(char * fieldName, void * entry, int offset) { int i; EimSubList * subList; EimAddlInfo * subentry; /* Address the EimSubList object */ subList = (EimSubList *)((char *)entry + offset); if (subList->listNum > 0) { subentry = (EimAddlInfo *)((char *)entry + subList->disp); for (i = 0; i < subList->listNum; i++) { /* Print out results */ printListData(fieldName, subentry, offsetof(EimAddlInfo, addlInfo)); /* advance to next entry */ subentry = (EimAddlInfo *)((char *)subentry + subentry->nextEntry); } } } 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"); }
Top | Security APIs | APIs by category |