Adds a key-value pair to a map object
Procedure:
H5M_PUT(map_id, name, key_mem_type_id, key, val_mem_type_id, value, dxpl_id)
Signature:
herr_t H5Mput( hid_t map_id, hid_t key_mem_type_id, const void *key, hid_t val_mem_type_id, const void *value, 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 val_mem_type_id | IN: Datatype identifier for the a value in memory buffer |
const void *value | IN: Pointer to value buffer |
hid_t dxpl_id | IN: Property list |
Description:
H5M_PUT adds a key-value pair to a map object specified by map_id, or updates the value for the specified key if one was set previously.
key_mem_type_id and val_mem_type_id specify the datatypes for the provided key and value buffers, and if different from those used to create the map object, the key and value will be internally converted to the datatypes 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 21, 2020 | 12:01 AM
