Difference between pages "r6:Function:stack clear" and "r6:Function:stack delete"
(Difference between pages)
Jump to navigation
Jump to search
m (1 revision imported) |
m (1 revision imported) |
||
| Line 4: | Line 4: | ||
==Prototype== | ==Prototype== | ||
void | void stack_delete( struct stack_state *ss, | ||
void (*user_data_delete_function)(void *user_data, void *user_state), | |||
void *user_state ); | |||
==Parameters== | ==Parameters== | ||
| Line 12: | Line 12: | ||
: A stack state as allocated by ''[[r6:Function:stack_new|stack_new]]''. | : A stack state as allocated by ''[[r6:Function:stack_new|stack_new]]''. | ||
''void (* | ''void (*user_data_delete_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 | : A callback function, which can be NULL. This function is called with the user data void pointer from each element before that element is deleted, giving the user an opportunity to delete any allocated state. | ||
''void *user_state'' | ''void *user_state'' | ||
: This pointer is passed into the '' | : This pointer is passed into the ''user_data_delete_function'' as its second argument, enabling the caller to pass state into the callback function. | ||
==Return Value== | ==Return Value== | ||
| Line 22: | Line 22: | ||
==Notes== | ==Notes== | ||
This function | This function deletes the stack. If there are any elements present in the stack at the time of deletion, the function loops, popping an element and passing its user data void pointer to user_data_delete_function, until the stack is empty. | ||
==See Also== | ==See Also== | ||
* [[r6:API:Stack|Stack]] | * [[r6:API:Stack|Stack]] | ||
* [[r6:Function:stack_new|stack_new]] | |||
Latest revision as of 14:07, 4 January 2015
Source Files
/src/stack/stack_delete.c /inc/liblfds.h
Prototype
void stack_delete( struct stack_state *ss,
void (*user_data_delete_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_delete_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 deleted, giving the user an opportunity to delete any allocated state.
void *user_state
- This pointer is passed into the user_data_delete_function as its second argument, enabling the caller to pass state into the callback function.
Return Value
No return value.
Notes
This function deletes the stack. If there are any elements present in the stack at the time of deletion, the function loops, popping an element and passing its user data void pointer to user_data_delete_function, until the stack is empty.