prg_list_cell_from_index_get()
Abstract
Gets a reference to the list cell at the specified index.
Syntax
prg_list_cell_from_index_get (list_ptr, index)
| Argument | Type | Description |
|---|---|---|
list_ptr |
PrgT_List * |
List of interest. |
index |
int |
Index of the desired cell. Indices start at 0 at the head of the list and increment by one until the tail is reached. Instead of a numeric index, an abstract list position index can be specified; the acceptable values are PRGC_LISTPOS_HEAD and PRGC_LISTPOS_TAIL. |
Return Type
PrgT_List_Cell *
The requested cell, or PRGC_NIL if the index is invalid.
Header
prg_list_funcs.h
Details
None.
WARNING: This function is MT unsafe, as described in “Multi-Threading Safety“ on page 11. Access to shared lists must be externally serialized.
Purpose:
This function provides a way to obtain a reference to a list cell based on its position in the list.
Errors:
- Program Abort: Segmentation violation. (due to an illegal list pointer or malformed list)
Reference:
- use
prg_list_head_cell_get()to obtain a reference to the head cell of a list - use
prg_list_cell_next_get()to obtain a reference to the next cell of a list - use
prg_list_cell_from_data_get()to obtain a reference to a cell based on the data it contains - use
prg_list_access()to obtain a reference to the data element associated with a specified index