man rlist_free (Fonctions bibliothèques) - free a dynamicly allocated rlist

NAME

rlist_free - free a dynamicly allocated rlist

SYNOPSIS

#include <roy.h>

void rlist_free (RList * list);

DESCRIPTION

Free the dynamic rlist list that was allocated using rlist_new(3). This will NOT free the items of the list. You should use RLIST_FOREACH to visit each entry, rlist_remove(3) to unlink each entry, and a call to your entry destructor to free the item's memory before calling rlist_free(3).

If list wasn't dynamicly allocated using rlist_new(3) then it should be destroyed using the RLIST_DESTRUCT macro, see rlist(3).

EXAMPLE
This is the proper way to destory the full rlist. 

        RLIST_FOREACH (list, entry) {
                rlist_remove (entry);
                rmem_free (entry);      /* Opposite of rmem_new(3). */
        } RFOREACH_CLOSE;


        rlist_free (list);              /* Do this last. */

RETURN VALUE

This call doesn't return any value.

ERRORS

A call to rlist_free(3) will never fail.

MACRO

The rlist_free(3) api is implemented using a macro.

SEE ALSO

rlist(3), rlist_append(3), rlist_compare(3), rlist_first(3), rlist_last(3), rlist_new(3), rlist_next(3), rlist_nth(3), rlist_prepend(3), rlist_prev(3), rlist_remove(3), roy(3)