20.1.18 ead_remove_group() (deletes values by using a batch operation with group specification)

(1) Description

Using a batch operation, this function deletes the keys and values belonging to a specified group, including the keys and values that belong to the specified group's lower hierarchy groups.

If the deletion processing fails for some reason during batch deletion of keys and values, the function returns an error code that indicates the cause of the failure.

To Page Top

(2) Format

#include <eads.h>
void ead_remove_group
(
  const EAD_CACHE     *cp,            /* In */
  const char          *group_name,    /* In */
  int                 *error_code     /* Out */
);

To Page Top

(3) Arguments

cp

Specifies the handle (pointer) to the cache where the values to be deleted are stored.

Specify the handle (pointer) obtained from ead_start_cache() when access to the cache was started.

group_name

Specifies the group name of the group to which the keys and values that are to be deleted belong.

For details about the data that can be specified, see 15.2.2(2) Data that can be specified as group names.

error_code

Specifies the pointer from which to retrieve the error code.

For details about error codes, see 20.2 Error codes in the client library (C).

To Page Top

(4) Notes

• If the deletion processing fails, data to be deleted might still remain. Therefore, check the execution results and take appropriate action. If necessary, re-execute ead_remove_group() (deletes values by using a batch operation with group specification).

• If the cache operation fails partially, identify which operations failed from the return value, and then re-execute this function, if necessary.

• Because caches are not locked while operations are ongoing, a target value might be changed by another cache operation during batch operation.

• When batch operations are performed on a large amount of data, a large amount of memory might be required by EADS clients and EADS servers.

• When batch operations are performed on a large amount of data, it might take a long time to complete the processing. To ensure proper operation, make sure that you design a timeout value that is appropriate for the processing time.

To Page Top