eimRemoveRegistry()--Remove a Registry from the EIM Domain

 #include <eim.h>

 int eimRemoveRegistry(EimHandle      * eim,
                       char           * registryName,
           EimRC          * eimrc)
 

The eimRemoveRegistry() function removes a currently participating registry from the EIM domain. It is recommended that all associations be removed for this registry before it is removed or it may result in orphaned associations. This includes admin, source, target, and policy associations. A system registry cannot be removed if there are any application registries that are a subset of this system registry.

When a registry is removed, an attempt is made to remove all associations for the registry. For policy associations, this would include any policy associations where this registry is the source registry or the target registry. If there are any policy filters defined for the registry, the policy filters will be removed along with any policy associations to the policy filters.

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.

registryName  (Input)

The name of the registry to remove.

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

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.

ENOTSAFE

Cannot delete a system registry when an application registry has this system registry defined.

EIMERR_REG_NOTEMPTY (40)

Cannot delete a registry when an application registry has this system registry defined.

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

• eimAddSystemRegistry() --Add a System Registry to the EIM Domain
  
  
• eimAddApplicationRegistry() --Add an Application Registry to the EIM Domain
  
  
• eimAddGroupRegistry() --Add a Group Registry to the EIM Domain
  
  
• eimChangeRegistry() --Change EIM Registry
  
  
• eimListRegistries() --List EIM Registries
  
  

Example

The following example removes an EIM registry.

Note: By using the code examples, you agree to the terms of the Code license and disclaimer information.

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

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

    /* 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;
    
    /* Remove the registry                      */
    if (0 != (rc = eimRemoveRegistry(handle,
                                     "MyRegistry",
                                     err)))
        printf("Remove registry error = %d", rc);

    return 0;
}

[ Back to top | Security APIs | APIs by category ]