prg_mapping_clear()
Abstract
Clears the contents of a mapping data structure.
Syntax
prg_mapping_clear (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
This function clears a mapping data structure created using prg_mapping_create(). Values stored in the mapping at the time of clearing are destroyed using the destroy_proc specified in the prg_mapping_create() function. If a value of PRGC_NIL was provided as the destroy_proc, the values are not destroyed.
After clearing, the data structure is returned to its initial state (as it was when first created).