Please, help us to better serve our user community by answering the following short survey: https://www.hdfgroup.org/website-survey/
HDF5 2.0.0.2ad0391
API Reference
Loading...
Searching...
No Matches
VOL Data Mapping Properties

Detailed Description

Empty property class.

Functions

herr_t H5Pset_map_iterate_hints (hid_t mapl_id, size_t key_prefetch_size, size_t key_alloc_size)
 Set map iteration hints.
 
herr_t H5Pget_map_iterate_hints (hid_t mapl_id, size_t *key_prefetch_size, size_t *key_alloc_size)
 Set map iteration hints.
 

Function Documentation

◆ H5Pget_map_iterate_hints()

herr_t H5Pget_map_iterate_hints ( hid_t  mapl_id,
size_t *  key_prefetch_size,
size_t *  key_alloc_size 
)

Set map iteration hints.

Parameters
[in]mapl_idMap access property list identifier
[out]key_prefetch_sizePointer to number of keys to prefetch at a time during iteration
[out]key_alloc_sizePointer to the initial size of the buffer allocated to hold prefetched keys
Returns
Returns a non-negative value if successful; otherwise, returns a negative value.

H5Pget_map_iterate() returns the map iterate hints, key_prefetch_size and key_alloc_size, as set by H5Pset_map_iterate_hints().

Since
1.12.0

◆ H5Pset_map_iterate_hints()

herr_t H5Pset_map_iterate_hints ( hid_t  mapl_id,
size_t  key_prefetch_size,
size_t  key_alloc_size 
)

Set map iteration hints.

Parameters
[in]mapl_idMap access property list identifier
[in]key_prefetch_sizeNumber of keys to prefetch at a time during iteration
[in]key_alloc_sizeThe initial size of the buffer allocated to hold prefetched keys
Returns
Returns a non-negative value if successful; otherwise, returns a negative value.

H5Pset_map_iterate_hints() adjusts the behavior of H5Miterate() when prefetching keys for iteration. The key_prefetch_size parameter specifies the number of keys to prefetch at a time during iteration. The key_alloc_size parameter specifies the initial size of the buffer allocated to hold these prefetched keys. If this buffer is too small it will be reallocated to a larger size, though this may result in an additional I/O.

Since
1.12.0