eimChangeRegistry()--Change EIM Registry


  Syntax 
 #include <eim.h>

 int eimChangeRegistry(EimHandle            * eim,
                       char                 * registryName,
                       enum EimRegistryAttr   attrName,
                       char                 * attrValue,
                       enum EimChangeType     changeType,
                       EimRC                * eimrc)
  Service Program Name: QSYS/QSYEIM  

  Default Public Authority: *USE

  Threadsafe: Yes

The eimChangeRegistry() function changes the attribute of a registry participating in 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
  • EIM Registries Administrator
  • EIM authority to an individual registry

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

attrName  (Input)
The attribute to be updated. This paramter is passed by value. Valid values are:


attrValue  (Input)
The new value for the attribute.

If the attribute being changed is EIM_REGISTRY_MAPPING_LOOKUP or EIM_REGISTRY_POLICY_ASSOCIATIONS, this value must be NULL.

changeType  (Input)
The type of change to make. This could be add, remove, change, enable, or disable. This parameter is passed by value.   attrName parameter indicates which type is allowed for each attribute.

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.


EBADDATA
eimrc is not valid.

EBADNAME
Registry not found or insufficient access to EIM data.


EBUSY
Unable to allocate internal system object.


ECONVERT
Data conversion error.


EINVAL
Input parameter was not valid.


ENOMEM
Unable to allocate required space.


ENOTCONN
LDAP connection has not been made.


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


EUNKNOWN
Unexpected exception.


Related Information


Example

The following example changes the description for the registry and enables the use of policy associations for the 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;

    /* Change the description for this registry */
    if (0 != (rc = eimChangeRegistry(handle,
                                     "MyAppRegistry",
                                     EIM_REGISTRY_DESCRIPTION,
                                     "New description",
                                     EIM_CHG,
                                     err)))
        printf("Change registry error = %d", rc);

    /* Enable the use of default registry policies. */
    if (0 != (rc = eimChangeRegistry(handle,
                                     "MyAppRegistry",
                                     EIM_REGISTRY_POLICY_ASSOCIATIONS,
                                     NULL,
                                     EIM_ENABLE,
                                     err)))
        printf("Change registry error = %d", rc);

    return 0;
}

API introduced: V5R2

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