genders_handle_destroy man page

genders_handle_destroy — destroys a genders handle

Synopsis

#include <genders.h>

int genders_handle_destroy(genders_t handle);

Description

genders_handle_destroy() destroys the genders 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 genders_errnum(3) , and a description of the error code can be retrieved via genders_strerror(3). Error codes are defined in genders.h.

Errors

GENDERS_ERR_NULLHANDLE
The handle parameter is NULL. The genders handle must be created with genders_handle_create(3).
GENDERS_ERR_MAGIC
handle has an incorrect magic number. handle does not point to a genders handle or handle has already been destroyed.

Files

/usr/include/genders.h

See Also

libgenders(3), genders_handle_create(3), genders_load_data(3), genders_errnum(3), genders_strerror(3)

Referenced By

genders_getattr(3), genders_getattr_all(3), genders_getnodename(3), genders_getnodes(3), genders_getnumnodes(3), genders_handle_create(3), genders_index_attrvals(3), genders_isnode(3), genders_load_data(3), genders_nodelist_create(3), genders_parse(3), genders_query(3), genders_testattr(3), genders_testquery(3), libgenders(3).

August 2003 LLNL LIBGENDERS