Help us improve by taking our short survey: https://www.hdfgroup.org/website-survey/

| HDF5 Last Updated on 2026-03-23 The HDF5 Field Guide

Loading...
Searching...
No Matches
H5PLpublic.h File Reference
`#include "H5public.h"`

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

## 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 }

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

## Macro Definition Documentation

## ◆ H5PL_ALL_PLUGIN

#define H5PL_ALL_PLUGIN 0xFFFF

Flag for all plugin types

Since
  1.8.15

## ◆ H5PL_FILTER_PLUGIN

#define H5PL_FILTER_PLUGIN 0x0001

Flag for filter plugin

Since
  1.8.15

## ◆ H5PL_NO_PLUGIN

#define H5PL_NO_PLUGIN "::"

Special string to indicate no plugin loading

Since
  1.10.2

## ◆ H5PL_VFD_PLUGIN

#define H5PL_VFD_PLUGIN 0x0004

Flag for VFD plugin

Since
  1.14.0

## ◆ H5PL_VOL_PLUGIN

#define H5PL_VOL_PLUGIN 0x0002

Flag for VOL plugin

Since
  1.12.0

## Enumeration Type Documentation

## ◆ H5PL_type_t

enum 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!