Deletes a key-value pair from a map object
Procedure:
H5M_DELETE(map_id, key_mem_type_id, const void *key, dxpl_id)
Signature:
hid_t H5Mdelete( hid_t map_id, hid_t key_mem_type_id, const void *key, hid_t dxpl_id )
Parameters:
hid_t map_id | IN: Map object identifier |
hid_t key_mem_type_id | IN: Datatype identifier for a key in memory buffer |
const void *key | IN: Pointer to key buffer |
hid_t dxpl_id | IN: Property list |
Description:
H5M_DELETE deletes a key-value pair from the map object specified by map_id. key_mem_type_id specifies the datatype for the provided key buffer key, and if different from that used to create the map object, the key will be internally converted to the datatype for the map object.
Any further options can be specified through the property list dxpl_id.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Example:
History:
| Release | Change |
|---|
| 1.13.0 | C function introduced in this release. |
--- Last Modified: December 20, 2020 | 11:39 PM
