nodeupdown_get_up_nodes_string man page

nodeupdown_get_up_nodes_string, nodeupdown_get_down_nodes_string, — get up or down nodes

Synopsis

#include <nodeupdown.h>

int nodeupdown_get_up_nodes_string(nodeupdown_t handle, char *buf, int buflen);

int nodeupdown_get_down_nodes_string(nodeupdown_t handle, char *buf, int buflen);

Description

nodeupdown_get_up_nodes_string() retrieves a ranged string of nodes that are up and places it in the buffer pointed to by buf. buflen should indicate the length of the buffer. nodeupdown_get_down_nodes_string() is identical to nodeupdown_get_up_nodes_string(), except that it retrieves a ranged string of down nodes.

Return Values

On success, 0 is returned.  On error, -1 is returned, and an error code is returned in handle.  The error code can be retrieved via nodeupdown_errnum(3) , and a description of the error code can be retrieved via nodeupdown_strerror(3). Error codes are defined in nodeupdown.h.

Errors

NODEUPDOWN_ERR_NULLHANDLE

The handle parameter is NULL.  The nodeupdown handle must be created with nodeupdown_handle_create(3).

NODEUPDOWN_ERR_NOTLOADED

nodeupdown_load_data(3) has not been called and no data has been retrieved.

NODEUPDOWN_ERR_PARAMETERS

An incorrect parameter has been passed in.  

NODEUPDOWN_ERR_OVERFLOW

The buffer pointed to by buf is not large enough to store the ranged string of nodes.

NODEUPDOWN_ERR_OUTMEM

malloc(3) has failed internally.

NODEUPDOWN_ERR_CLUSTERLIST_MODULE

Internal error with the clusterlist module

NODEUPDOWN_ERR_HOSTLIST

Hostlist API has failed internally.

NODEUPDOWN_ERR_MAGIC

handle has an incorrect magic number.  handle does not point to a nodeupdown handle or handle has been destroyed by nodeupdown_handle_destroy(3).

Files

/usr/include/nodeupdown.h

See Also

libnodeupdown(3), nodeupdown_handle_create(3), nodeupdown_load_data(3), nodeupdown_get_up_nodes_list (3), nodeupdown_get_down_nodes_list (3), nodeupdown_errnum(3), nodeupdown_strerror(3)

Referenced By

libnodeupdown(3), nodeupdown_get_up_nodes_list(3).

nodeupdown_get_down_nodes_string(3) is an alias of nodeupdown_get_up_nodes_string(3).

August 2003 LLNL LIBNODEUPDOWN