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
H5PLpublic.h File Reference
#include "H5public.h"
+ Include dependency graph for H5PLpublic.h:

Macros

#define H5PL_NO_PLUGIN   "::"
 
#define H5PL_FILTER_PLUGIN   0x0001
 
#define H5PL_VOL_PLUGIN   0x0002
 
#define H5PL_VFD_PLUGIN   0x0004
 
#define H5PL_ALL_PLUGIN   0xFFFF
 

Enumerations

enum  H5PL_type_t {
  H5PL_TYPE_ERROR = -1 , H5PL_TYPE_FILTER = 0 , H5PL_TYPE_VOL = 1 , H5PL_TYPE_VFD = 2 ,
  H5PL_TYPE_NONE = 3 , H5PL_TYPE_ERROR = -1 , H5PL_TYPE_FILTER = 0 , H5PL_TYPE_VOL = 1 ,
  H5PL_TYPE_VFD = 2 , H5PL_TYPE_NONE = 3
}
 

Functions

herr_t H5PLset_loading_state (unsigned int plugin_control_mask)
 Controls the loadability of dynamic plugin types. More...
 
herr_t H5PLget_loading_state (unsigned int *plugin_control_mask)
 Queries the loadability of dynamic plugin types. More...
 
herr_t H5PLappend (const char *search_path)
 Inserts a plugin path at the end of the plugin search path list. More...
 
herr_t H5PLprepend (const char *search_path)
 Inserts a plugin path at the beginning of the plugin search path list. More...
 
herr_t H5PLreplace (const char *search_path, unsigned int index)
 Replaces the path at the specified index in the plugin search path list. More...
 
herr_t H5PLinsert (const char *search_path, unsigned int index)
 Inserts a path at the specified index in the plugin search path list. More...
 
herr_t H5PLremove (unsigned int index)
 Removes a plugin path at a specified index from the plugin search path list. More...
 
ssize_t H5PLget (unsigned int index, char *path_buf, size_t buf_size)
 Queries the plugin search path list at the specified index. More...
 
herr_t H5PLsize (unsigned int *num_paths)
 Retrieves the number of stored plugin paths. More...
 

Macro Definition Documentation

◆ H5PL_ALL_PLUGIN

#define H5PL_ALL_PLUGIN   0xFFFF

◆ H5PL_FILTER_PLUGIN

#define H5PL_FILTER_PLUGIN   0x0001

◆ H5PL_NO_PLUGIN

#define H5PL_NO_PLUGIN   "::"

◆ H5PL_VFD_PLUGIN

#define H5PL_VFD_PLUGIN   0x0004

◆ H5PL_VOL_PLUGIN

#define H5PL_VOL_PLUGIN   0x0002

Enumeration Type Documentation

◆ H5PL_type_t

Plugin type (bit-position) used by the plugin library

Enumerator
H5PL_TYPE_ERROR 

Error

H5PL_TYPE_FILTER 

Filter

H5PL_TYPE_VOL 

VOL connector

H5PL_TYPE_VFD 

VFD

H5PL_TYPE_NONE 

Sentinel: This must be last!

H5PL_TYPE_ERROR 

Error

H5PL_TYPE_FILTER 

Filter

H5PL_TYPE_VOL 

VOL connector

H5PL_TYPE_VFD 

VFD

H5PL_TYPE_NONE 

Sentinel: This must be last!