eimListRegistryUsers()-- List EIM Registry Users
Syntax
#include <eim.h> int eimListRegistryUsers(EimHandle * eim, char * registryName, char * registryUserName, unsigned int lengthOfListData, EimList * listData, EimRC * eimrc)Service Program Name: QSYS/QSYEIM
Default Public Authority: *USE
Threadsafe: Yes
The eimListRegistryUsers() function lists the users in a particular registry that have target associations defined.
Authorities and Locks
- EIM Data
- Access to EIM data is controlled by EIM access groups. LDAP administrators
also have access to EIM data. The access groups whose members have authority to
the EIM data for this API follow:
- EIM Administrator
- EIM Registries Administrator
- EIM Identifiers Administrator
- EIM Mapping Lookup
- EIM authority to an individual registry
The list returned contains only the information that the user has authority to access.
Parameters
- eim (Input)
- The EIM handle returned by a previous call to eimCreateHandle(). A valid
connection is required for this function.
- registryName (Input)
- The name of the registry that contains this user.
- registryUserName (Input)
- The name of the user in this registry to list. NULL will indicate all
users.
- lengthOfListData (Input)
- The number of bytes provided by the caller for the listData
parameter. The minimum size required is 20 bytes. This parameter is passed
by value.
- listData (Output)
- A pointer to the EimList structure.
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 EimRegistryUser structures. firstEntry is used to get to the first EimRegistryUser 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;
EimRegistryUser structure:
typedef struct EimRegistryUser { unsigned int nextEntry; /* Displacement to next entry. This byte offset is relative to the start of this structure. */ EimListData registryUserName; /* Name */ EimListData description; /* Description */ EimSubList additionalInfo; /* EimAddlInfo sublist */
EimSubList credentialInfo; /* EimCredentialInfo sublist */
} EimRegistryUser;
Registry users may have several additional attributes. In the EimRegistryUser structure, additionalInfo gives addressability to the first EimAddlInfo structure that contains a linked list of attributes.
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;
This API will always return 0 for the numbers of entries in the credentialInfo sublist. If you need access to the credential information, use the List EIM Registry Users Credentials (eimListRegistryUsersCreds) API.
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;
- eimrc (Input/Output)
- 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 EimRC--EIM
Return Code Parameter.
Return Value
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.
- 0
- Request was successful.
- EACCES
- Access denied. Not enough permissions to access data.
EIMERR_ACCESS (1) Insufficient access to EIM data.
- EBADDATA
- eimrc is not valid.
- EBADNAME
- Registry not found or insufficient access to EIM data.
EIMERR_NOREG (28) EIM Registry not found or insufficient access to EIM data.
- EBUSY
- Unable to allocate internal system object.
EIMERR_NOLOCK (26) Unable to allocate internal system object.
- ECONVERT
- Data conversion error.
EIMERR_DATA_CONVERSION (13) Error occurred when converting data between code pages.
- EINVAL
- Input parameter was 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_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.
- ENOMEM
- Unable to allocate required space.
EIMERR_NOMEM (27) No memory available. Unable to allocate required space.
- ENOTCONN
- LDAP connection has not been made.
EIMERR_NOT_CONN (31) Not connected to LDAP. Use eimConnect() API and try the request again.
- EUNKNOWN
- Unexpected exception.
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.
Related Information
- eimChangeRegistryUser()--Change EIM
Registry User
- eimListRegistryUsersCreds()--List EIM
Registry Users Credentials
Example
The following example lists all users in the specified registry.
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 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 registry user */ if (0 != (rc = eimListRegistryUsers(handle, "MyRegistry", NULL, 1000, list, err))) { printf("List registry users error = %d", rc); return -1; } /* Print the results */ printListResults(list); return 0; } void printListResults(EimList * list) { int i; EimRegistryUser * 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 = (EimRegistryUser *)((char *)list + list->firstEntry); for (i = 0; i < list->entriesReturned; i++) { printf("\n"); printf("===============\n"); printf("Entry %d.\n", i); /* Print out results */ printListData("Registry user name", entry, offsetof(EimRegistryUser, registryUserName)); printListData("description", entry, offsetof(EimRegistryUser, description)); printSubListData("Additional information", entry, offsetof(EimRegistryUser, additionalInfo)); /* advance to next entry */ entry = (EimRegistryUser *)((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"); }
API introduced: V5R2
[ Back to top | Security APIs | APIs by category ]