Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5M_CREATE

Creates a map object

Procedure:

H5M_CREATE(loc_id, name, key_type_id, val_type_id, lcpl_id, mcpl_id, mapl_id)

Signature:

hid_t H5Mcreate( hid_t loc_id, const char *name, hid_t key_type_id, hid_t val_type_id, hid_t lcpl_id, hid_t mcpl_id, hid_t mapl_id )

 

Parameters:
hid_t loc_idIN: Location identifier; may be a file, group, dataset, named datatype, or attribute
const char *name    IN: Map object name
hid_t key_type_idIN: Datatype identifier for the keys in the file
hid_t val_type_idIN: Datatype identifier for the key values in the file
hid_t lcpl_idIN: Link creation property list
hid_t mcpl_idIN: Map object creation property list
hid_t mapl_idIN: Map object access property list

 

 

Description:

H5M_CREATE creates a new map object for storing key-value pairs. The in-file datatype for keys is defined by key_type_id and the in-file datatype for values is defined by val_type_id.  loc_id specifies the location to create the the map object and name specifies the name of the link to the map object relative to loc_id.

Returns:

Returns a map object identifier if successful; otherwise returns a negative value. 

Example:
History:
ReleaseChange
1.13.0C function introduced in this release.

--- Last Modified: December 20, 2020 | 11:38 PM