Difference between pages "r6:Function:slist new" and "r6:Function:slist new head"
(Difference between pages)
Jump to navigation
Jump to search
m (1 revision imported) |
m (1 revision imported) |
||
Line 4: | Line 4: | ||
==Prototype== | ==Prototype== | ||
struct slist_element *slist_new_head( struct slist_state *ss, void *user_data ); | |||
==Parameters== | ==Parameters== | ||
''struct slist_state | ''struct slist_state *ss'' | ||
: | : An slist state as allocated by ''[[r6:Function:slist_new|slist_new]]''. | ||
'' | ''void *user_data'' | ||
: A | : A void pointer of user data which will be placed into the list in the new head element. | ||
==Return Value== | ==Return Value== | ||
Returns | Returns a pointer to the new slist element. If element creation failed, which can only happen because of memory allocation failure, the return value is NULL. | ||
==Notes== | ==Notes== | ||
This function | This function creates a new slist element holding ''user_data'' and links it into the slist as the head element. | ||
==See Also== | ==See Also== | ||
* [[r6:API:SList|SList]] | * [[r6:API:SList|SList]] | ||
* [[r6:Function: | * [[r6:Function:slist_new_next|slist_new_next]] |
Latest revision as of 14:07, 4 January 2015
Source Files
/src/slist/slist_new.c /inc/liblfds.h
Prototype
struct slist_element *slist_new_head( struct slist_state *ss, void *user_data );
Parameters
struct slist_state *ss
- An slist state as allocated by slist_new.
void *user_data
- A void pointer of user data which will be placed into the list in the new head element.
Return Value
Returns a pointer to the new slist element. If element creation failed, which can only happen because of memory allocation failure, the return value is NULL.
Notes
This function creates a new slist element holding user_data and links it into the slist as the head element.