nodeupdown_handle_destroy man page

nodeupdown_handle_destroy — destroys a nodeupdown handle

Synopsis

#include <nodeupdown.h>

int nodeupdown_handle_destroy(nodeupdown_t handle);

Description

nodeupdown_handle_destroy() destroys the nodeupdown handle pointed to by handle and frees all allocated memory associated with it.

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_MAGIC
handle has an incorrect magic number. handle does not point to a nodeupdown handle or handle has already been destroyed.

Files

/usr/include/nodeupdown.h

See Also

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

Referenced By

libnodeupdown(3), nodeupdown_get_up_nodes_list(3), nodeupdown_get_up_nodes_string(3), nodeupdown_handle_create(3), nodeupdown_is_node_up(3), nodeupdown_last_up_time(3), nodeupdown_load_data(3), nodeupdown_nodelist_create(3), nodeupdown_up_count(3).

August 2003 LLNL LIBNODEUPDOWN