prg_mapping_iterator_init()
Abstract
Resets the internal iterator to reference the first element of the mapping.
Syntax
prg_mapping_iterator_init (mapping_handle)
| Argument | Type | Description |
|---|---|---|
mapping_handle |
PrgT_Mapping_Handle |
mapping data structure returned by a prg_mapping_create() call |
Return Type
void
No return value.
Header
prg_mapping.h
Details
A PrgT_Mapping data structure contains a built-in iterator that can be used to iterate through all the values in increasing key order. This function is used to reset the iterator so it re-references the value with the lowest key.