eimRemoveIdentifier()-- Remove EIM Identifier

 #include <eim.h>

 int eimRemoveIdentifier(EimHandle         * eim,
                         EimIdentifierInfo * idName,
       EimRC             * eimrc)

 

The eimRemoveIdentifier() function removes an EIM identifier and all of its associated mappings from the EIM domain.

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

Parameters

eim  (Input)

The EIM handle returned by a previous call to eimCreateHandle(). A valid connection is required for this function.

idName  (Input)

A structure that contains the name for this identifier. The layout of the EimIdentifierInfo structure follows:

   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. Use of the uniqueName will provide the best performance. There is no guarantee that name will find a unique identifier. Therefore, use of name may result in an error.

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

Identifier not found or 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.

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_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.

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.

EROFS

LDAP connection is for read only. Need to connect to master.

EIMERR_READ_ONLY (36)

LDAP connection is for read only. Use eimConnectToMaster() to get a write connection.

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

• eimAddIdentifier()--Add EIM Identifier
  
  
• eimChangeIdentifier()--Change EIM Identifier
  
  
• eimListIdentifiers()--List EIM Identifiers
  
  
• eimGetAssociatedIdentifiers() --Get Associated EIM Identifiers
  
  

Example

See Code disclaimer information for information pertaining to code examples.

The following example will remove an EIM identifier.

#include <eim.h>
#include <stdio.h>

int main(int argc, char *argv[])
{
    int           rc;
    char          eimerr[100];
    EimRC       * err;
    EimHandle   * handle;

    EimIdentifierInfo idInfo;

    /* 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 identifier information.              */
    idInfo.idtype = EIM_UNIQUE_NAME;
    idInfo.id.uniqueName = "Mary Smith";
    
    /* Remove this identifier.                  */
    if (0 != (rc = eimRemoveIdentifier(handle,
                                        &idInfo,
                                        err)))
        printf("Remove identifier error = %d", rc);

    return 0;
}