20.1.27 ead_get_node_first_key() (acquires the first key with EADS server specification)

(1) Description

This function acquires the first key in ascending order based on its ASCII code value from among all the keys that are stored on a specified EADS server.

To Page Top

(2) Format

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

To Page Top

(3) Arguments

cp

Specifies the handle (pointer) to the cache in which the key is to be acquired.

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

target_node

Specifies the pointer to the EADS server (ead_node structure) from which the first key is to be acquired.

You can only specify the pointer of the ead_node structure obtained by using the EADS client library. If you specify any other pointer, correct operation is not guaranteed.

For the format and details of the ead_node structure, see 20.1.50 ead_node structure (object used in a user function with an EADS server specified).

An error results if the address information (IP address and port number) managed by the specified ead_node structure does not match the address information of any EADS servers maintained by the EADS client.

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 first key in ascending order based on its ASCII code value from among all the keys that are stored on the specified EADS server.

The function returns NULL in the following cases:

• The specified EADS server does not contain the source key for copy processing.

• Acquisition of the key failed due to an error.

To Page Top

(5) Notes

If acquisition of the key is successful (the return value is not NULL), the memory area 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