20.1.34 ead_get_nodelist() (acquires information about the connection-target EADS servers)

(1) Description

This function acquires information about the connection-target EADS servers maintained by the EADS client.

To Page Top

(2) Format

#include <eads.h>
ead_nodelist ead_get_nodelist
(
  const EAD_CACHE_MANAGER *cmp,               /* In */
  int                     *error_code         /* Out */
);

To Page Top

(3) Arguments

cmp

Specifies the handle (pointer) to the cache manager that is managing the cache.

Specify a handle obtained from ead_init_client() or ead_init_client_n().

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 information about the connection-target EADS servers (ead_nodelist structure) maintained by the EADS client.

For the format and details of the ead_nodelist structure, see 20.1.49 ead_nodelist structure (EADS server information).

If the function terminates abnormally, NULL is returned in the nodes member of the ead_nodelist structure.

To Page Top

(5) Notes

• If the nodes member of the ead_nodelist structure returned as the return value is not NULL, the memory area is not freed automatically. Instead, you must free it in the application program. For details, see 19.1.1(10) Freeing a memory area returned as a return value.

• Execution of the application program does not establish communication with the EADS servers. Therefore, the returned information about the connection-target EADS servers might not be the most recent information.

• Whether the EADS servers are connected is not checked when this function executes. For this reason, the acquired information might contain EADS servers that cannot be connected, for example, because the EADS servers are isolated. If you plan to use an acquired EADS server as a connection target, use the is_enable member of the ead_node structure to check whether a connection can be established with that EADS server.

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

To Page Top