user_free_master

[cf]user_free_master

int user_free_master(void **user)

Description:

The user frees all the data structures within *user, and also free *user itself. This can be done using the built-in macro FREE that checks the existence of a pointer before freeing it.

Arguments:

void **user

INOUT

Pointer to the user-defined data structure (should be NULL on return).

Return values:

USER_ERROR	Ignored. This is probably not a fatal error.
USER_SUCCESS	Everything was freed successfully.
USER_DEFAULT	There is no user memory to free.