genders_handle_destroy3
Destroys a genders handle
Usage
#include <genders.h>
int genders_handle_destroy(genders_t handle);
Overview
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
Releases
10 releases since Debian 4.0 (Etch); the text changed 5 times.