prg_mapping_iterator_value_remove()
Abstract
Removes from the mapping the value currently referenced by the iterator.
Syntax
prg_mapping_iterator_value_remove (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
Remove from the mapping the value currently referenced by the iterator. If a destroy_proc was specified in the prg_mapping_create() call, the function is invoked with the removed value to destroy it.
After the value has been destroyed, the iterator references the next value in the mapping.