prg_mapping_iterator_key_get()
Abstract
Returns the key of the current value referenced by the iterator.
Syntax
prg_mapping_iterator_key_get (mapping_handle)
| Argument | Type | Description |
|---|---|---|
mapping_handle |
PrgT_Mapping_Handle |
mapping data structure returned by a prg_mapping_create() call |
Return Type
void *
Key of the value currently referenced by the iterator (if prg_mapping_iterator_at_end() returns 0) or PRGC_NIL otherwise.
Header
prg_mapping.h
Details
Iterators iterate through all the values in increasing key order. This returns the key of the current element (or PRGC_NIL if pass all elements)