Zen API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Friends Macros Modules Pages

kStatus kMap_Remove | ( | kMap | map,
|  | const void * | key,
|  | void * | oldKey,
|  | void * | oldValue
| ) |  |

Removes a key-value pair from the map, optionally returning the old key and/or value.

For object-based keys or values, the old objects are not automatically disposed. In this case, use the oldKey and/or oldValue parameters to receive the previous object(s) and then dispose them.

Parameters

  map | Map object.
  key | Pointer to key.
  oldKey | Optionally receives key (can be kNULL).
  oldValue | Optionally receives value (can be kNULL).

Returns
  kOK if removed; kERROR_NOT_FOUND if key not found.