Difference between pages "r6:Function:slist query" and "r6:Function:slist set user data in element"
(Difference between pages)
Jump to navigation
Jump to search
m (1 revision imported) |
m (1 revision imported) |
||
Line 1: | Line 1: | ||
==Source Files== | ==Source Files== | ||
/src/slist/ | /src/slist/slist_get_and_set.c | ||
/inc/liblfds.h | /inc/liblfds.h | ||
==Prototype== | ==Prototype== | ||
int slist_set_user_data_in_element( struct slist_element *se, void *user_data ); | |||
==Parameters== | ==Parameters== | ||
''struct | ''struct slist_element *se'' | ||
: | : A pointer to an slist element as allocated by ''[[r6:Function:slist_new_head|slist_new_head]]'' or ''[[r6:Function:slist_new_next|slist_new_next]]''. | ||
'' | |||
: | |||
''void * | ''void *user_data'' | ||
: | : A void pointer of user data which will be placed into the slist element. | ||
==Return Value== | ==Return Value== | ||
Returns 1 on success, 0 on failure. The only cause of failure is if you try to set the user data in an element which has been logically deleted. | |||
==Notes== | ==Notes== | ||
This function sets the user data void pointer in the slist element. | |||
==See Also== | ==See Also== | ||
* [[r6:API:SList|SList]] | * [[r6:API:SList|SList]] | ||
* [[r6:Function:slist_get_user_data_from_element|slist_get_user_data_from_element]] |
Latest revision as of 14:07, 4 January 2015
Source Files
/src/slist/slist_get_and_set.c /inc/liblfds.h
Prototype
int slist_set_user_data_in_element( struct slist_element *se, void *user_data );
Parameters
struct slist_element *se
- A pointer to an slist element as allocated by slist_new_head or slist_new_next.
void *user_data
- A void pointer of user data which will be placed into the slist element.
Return Value
Returns 1 on success, 0 on failure. The only cause of failure is if you try to set the user data in an element which has been logically deleted.
Notes
This function sets the user data void pointer in the slist element.