nodeupdown_handle_destroy

Langue: en

Version: August 2003 (fedora - 05/07/09)

Section: 3 (Bibliothèques de fonctions)

NAME

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)