20.1.24 ead_get_group_key_count() (acquires the number of keys with group specification)

(1) Description

This function acquires the number of keys that belong to a specified group. The number of keys acquired includes the keys that belong to groups under the specified group's hierarchy.

To Page Top

(2) Format

#include <eads.h>
size_t ead_get_group_key_count
(
  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 in which the number of keys is to be acquired.

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

group_name

Specifies a group name.

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) Return value

This function returns the number of keys that belong to the specified group.

If acquisition of the number of keys fails due to an error, the function returns 0.

To Page Top