r6:Function:stack clear

From liblfds.org
Jump to: navigation, search

Source Files

/src/stack/stack_delete.c
/inc/liblfds.h

Prototype

void stack_clear( struct stack_state *ss,
                  void (*user_data_clear_function)(void *user_data, void *user_state),
                  void *user_state );

Parameters

struct stack_state *ss

A stack state as allocated by stack_new.

void (*user_data_init_function)(void *user_data, void *user_state)

A callback function, which can be NULL. This function is called with the user data void pointer from each element before that element is popped, giving the user an opportunity to delete any allocated state.

void *user_state

This pointer is passed into the user_data_init_function as its second argument, enabling the caller to pass state into the callback function.

Return Value

No return value.

Notes

This function empties the stack, popping every element. Each element, after being popped, is passed to user_data_clear_function.

See Also