Zen API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Friends Macros Modules Pages

#define kMap_DiscardT | ( |  | kMap_map,
|  |  | KPtr_key
| ) |  |

Removes a key-value pair from the map.

For object-based keys or values, the old objects are not automatically disposed. In this case, use kMap_Remove instead to access the old keys/values.

A debug assertion will be raised if the size of the specified key type is not equal to the size of the collection key type.

kMap

Parameters

  kMap_map | Map object.
  KPtr_key | Strongly-typed pointer to key.

Returns
  kOK if removed; kERROR_NOT_FOUND if key not found.