Retrieves a key-value pair from a map object
Procedure:
H5M_GET(map_id, name, key_mem_type_id, key, val_mem_type_id, value, dxpl_id)
Signature:
herr_t H5Mget( 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 | OUT: Pointer to value buffer |
hid_t dxpl_id | IN: Property list |
Description:
H5M_GET retrieves from a map object specified by map_id, the value associated with the provided key key. key_mem_type_id and val_mem_type_id specify the datatypes for the provided key and value buffers. If if the datatype specified by key_mem_type_id is different from that used to create the map object the key will be internally converted to the datatype for the map object for the query, and if the datatype specified by val_mem_type_id is different from that used to create the map object the returned value will be converted to have a datatype as specified by val_mem_type_id before the function returns.
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:58 PM
