20.1.5 ead_get_cache_name() (acquires cache names)

(1) Description

This function acquires the cache name associated with the handle to a specified cache.

It can also acquire the cache name of a cache to which access was terminated by ead_stop_cache().

To Page Top

(2) Format

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

To Page Top

(3) Arguments

cp

Specifies the handle (pointer) to the cache whose cache name is to be acquired.

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

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 acquires the cache name associated with the handle to a specified cache.

If a problem occurs when the cache name is acquired, NULL is returned.

To Page Top

(5) Notes

The memory area for storing the cache name that is returned as the return value is not freed automatically. You must free it in the application program. For details, see 19.1.1(10) Freeing a memory area returned as a return value.

To Page Top