Last modified: 2016

Name: H5Pset_file_space_strategy

Signature:
herr_t H5Pset_file_space_strategy( hid_t fcpl, H5F_fspace_strategy_t strategy, hbool_t persist, hsize_t threshold);

Purpose:
Sets the file space handling strategy and persisting free-space values for a file creation property list.

Description:
H5Pset_file_space_strategy sets the file space handling strategy, specifies persisting free-space or not (persist), and sets the free-space section size threshold in the file creation property list fcpl.

This setting cannot be changed for the life of the file.

As the H5F_FSPACE_STRATEGY_AGGR and H5F_FSPACE_STRATEGY_NONE strategies do not use the free-space managers, the persist and threshold settings will be ignored for those strategies.

Limitations:
The H5F_FSPACE_STRATEGY_PAGE (Page Buffering) strategy is turned off in parallel. You will receive an error if attempting to enable it in a parallel build.
The H5F_FSPACE_STRATEGY_AGGR (Paged Aggregation) strategy is not available with either the split or multi-file drivers.

Parameters:

hid_t fcpl   IN: The file creation property list identifier used to create a new file
H5F_fspace_strategy_t strategy   IN: The file space handling strategy to be used. H5F_fspace_strategy_t is defined as:
        typedef enum H5F_fspace_strategy_t {
              H5F_FSPACE_STRATEGY_FSM_AGGR = 0, /* FSM, Aggregators, VFD */ 
              H5F_FSPACE_STRATEGY_PAGE = 1	   /* Paged FSM, VFD */
              H5F_FSPACE_STRATEGY_AGGR = 2	   /* Aggregators, VFD */
              H5F_FSPACE_STRATEGY_NONE = 3,     /* VFD */
              H5F_FSPACE_STRATEGY_NTYPES     
        } H5F_fspace_strategy_t;
    
hbool_t persist   IN: A boolean value to indicate whether free space should be persistent or not.
hsize_t threshold   IN: The smallest free-space section size that the free space manager will track.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.

Fortran Interface:
None

See Also:

History:
Release     Change
1.10.1 C function introduced with this release.