Please, help us to better serve our user community by answering the following short survey: https://www.hdfgroup.org/website-survey/
HDF5  1.15.0
API Reference
H5Mpublic.h File Reference
#include "H5public.h"
#include "H5Ipublic.h"
#include "H5VLconnector.h"
+ Include dependency graph for H5Mpublic.h:

Data Structures

union  H5VL_map_args_t
 

Macros

#define H5VL_MAP_CREATE   1
 
#define H5VL_MAP_OPEN   2
 
#define H5VL_MAP_GET_VAL   3
 
#define H5VL_MAP_EXISTS   4
 
#define H5VL_MAP_PUT   5
 
#define H5VL_MAP_GET   6
 
#define H5VL_MAP_SPECIFIC   7
 
#define H5VL_MAP_OPTIONAL   8
 
#define H5VL_MAP_CLOSE   9
 

Typedefs

typedef herr_t(* H5M_iterate_t) (hid_t map_id, const void *key, void *op_data)
 

Enumerations

enum  H5VL_map_get_t {
  H5VL_MAP_GET_MAPL , H5VL_MAP_GET_MCPL , H5VL_MAP_GET_KEY_TYPE , H5VL_MAP_GET_VAL_TYPE ,
  H5VL_MAP_GET_COUNT , H5VL_MAP_GET_MAPL , H5VL_MAP_GET_MCPL , H5VL_MAP_GET_KEY_TYPE ,
  H5VL_MAP_GET_VAL_TYPE , H5VL_MAP_GET_COUNT
}
 
enum  H5VL_map_specific_t { H5VL_MAP_ITER , H5VL_MAP_DELETE , H5VL_MAP_ITER , H5VL_MAP_DELETE }
 

Functions

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)
 Creates a map object. More...
 
hid_t H5Mcreate_async (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, hid_t es_id)
 
hid_t H5Mcreate_anon (hid_t loc_id, hid_t key_type_id, hid_t val_type_id, hid_t mcpl_id, hid_t mapl_id)
 
hid_t H5Mopen (hid_t loc_id, const char *name, hid_t mapl_id)
 Opens a map object. More...
 
hid_t H5Mopen_async (hid_t loc_id, const char *name, hid_t mapl_id, hid_t es_id)
 
herr_t H5Mclose (hid_t map_id)
 Terminates access to a map object. More...
 
herr_t H5Mclose_async (hid_t map_id, hid_t es_id)
 
hid_t H5Mget_key_type (hid_t map_id)
 Gets key datatype for a map object. More...
 
hid_t H5Mget_val_type (hid_t map_id)
 Gets value datatype for a map object. More...
 
hid_t H5Mget_create_plist (hid_t map_id)
 Gets creation property list for a map object. More...
 
hid_t H5Mget_access_plist (hid_t map_id)
 Gets access property list for a map object. More...
 
herr_t H5Mget_count (hid_t map_id, hsize_t *count, hid_t dxpl_id)
 Retrieves the number of key-value pairs in a map object. More...
 
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)
 Adds a key-value pair to a map object. More...
 
herr_t H5Mput_async (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, hid_t es_id)
 
herr_t H5Mget (hid_t map_id, hid_t key_mem_type_id, const void *key, hid_t val_mem_type_id, void *value, hid_t dxpl_id)
 Retrieves a key-value pair from a map object. More...
 
herr_t H5Mget_async (hid_t map_id, hid_t key_mem_type_id, const void *key, hid_t val_mem_type_id, void *value, hid_t dxpl_id, hid_t es_id)
 
herr_t H5Mexists (hid_t map_id, hid_t key_mem_type_id, const void *key, hbool_t *exists, hid_t dxpl_id)
 Checks if provided key exists in a map object. More...
 
herr_t H5Miterate (hid_t map_id, hsize_t *idx, hid_t key_mem_type_id, H5M_iterate_t op, void *op_data, hid_t dxpl_id)
 Iterates over all key-value pairs in a map object. More...
 
herr_t H5Miterate_by_name (hid_t loc_id, const char *map_name, hsize_t *idx, hid_t key_mem_type_id, H5M_iterate_t op, void *op_data, hid_t dxpl_id, hid_t lapl_id)
 Iterates over all key-value pairs in a map object. More...
 
herr_t H5Mdelete (hid_t map_id, hid_t key_mem_type_id, const void *key, hid_t dxpl_id)
 Deletes a key-value pair from a map object. More...
 

Macro Definition Documentation

◆ H5VL_MAP_CLOSE

#define H5VL_MAP_CLOSE   9

◆ H5VL_MAP_CREATE

#define H5VL_MAP_CREATE   1

◆ H5VL_MAP_EXISTS

#define H5VL_MAP_EXISTS   4

◆ H5VL_MAP_GET

#define H5VL_MAP_GET   6

◆ H5VL_MAP_GET_VAL

#define H5VL_MAP_GET_VAL   3

◆ H5VL_MAP_OPEN

#define H5VL_MAP_OPEN   2

◆ H5VL_MAP_OPTIONAL

#define H5VL_MAP_OPTIONAL   8

◆ H5VL_MAP_PUT

#define H5VL_MAP_PUT   5

◆ H5VL_MAP_SPECIFIC

#define H5VL_MAP_SPECIFIC   7

Typedef Documentation

◆ H5M_iterate_t

typedef herr_t(* H5M_iterate_t) (hid_t map_id, const void *key, void *op_data)

Callback for H5Miterate()

Enumeration Type Documentation

◆ H5VL_map_get_t

Enumerator
H5VL_MAP_GET_MAPL 
H5VL_MAP_GET_MCPL 
H5VL_MAP_GET_KEY_TYPE 
H5VL_MAP_GET_VAL_TYPE 
H5VL_MAP_GET_COUNT 
H5VL_MAP_GET_MAPL 
H5VL_MAP_GET_MCPL 
H5VL_MAP_GET_KEY_TYPE 
H5VL_MAP_GET_VAL_TYPE 
H5VL_MAP_GET_COUNT 

◆ H5VL_map_specific_t

Enumerator
H5VL_MAP_ITER 
H5VL_MAP_DELETE 
H5VL_MAP_ITER 
H5VL_MAP_DELETE