View source for r6:Function:freelist pop

==Source Files==
 /src/freelist/freelist_pop_push.c
 /inc/liblfds.h

==Prototype==
 struct freelist_element *freelist_pop( struct freelist_state *fs, struct freelist_element **fe );

==Parameters==
''struct freelist_state *fs''
: A freelist state as allocated by ''[[r6:Function:freelist_new|freelist_new]]''.

''struct freelist_element **fe''
: A pointer to a freelist element pointer which will be set to point to a ''struct freelist'' popped from the freelist.  Set to NULL if the freelist is empty.

==Return Value==
Returns a pointer to the freelist element (e.g. the value ''*fe'' is set to).  If the freelist is empty, the return value is NULL and ''*freelist_element'' is set to NULL.  In this case, the user can call, the caller can call ''[[r6:Function:freelist_guaranteed_pop|freelist_guaranteed_pop]]'', which will allocate a new element, rather than popping from the freelist.  Remember however that the freelist can never shrink, so any such call will permanently increase the size of the freelist by one element.

==Notes==
Popping returns to the user a freelist element.  To obtain the user data void pointer from the element, use ''[[r6:Function:freelist_get_user_data_from_element|freelist_get_user_data_from_element]]''.

==See Also==
* [[r6:API:Freelist|Freelist]]
* [[r6:Function:freelist_push|freelist_push]]