Controls the loading of dynamic plugin types
Procedure:
H5PL_SET_LOADING_STATE (plugin_control_mask)
Signature:
herr_t H5PLset_loading_state( unsigned int plugin_control_mask )
Parameters:
unsigned int plugin_control_mask | IN: The list of dynamic plugin types to enable or disable. A plugin bit set to 0 (zero) prevents use of that dynamic plugin. A plugin bit set to 1 (one) enables use of that dynamic plugin.Setting plugin_control_mask to a negative value enables all dynamic plugins. Setting plugin_control_mask to 0 (zero) disables all dynamic plugins. |
Description:
H5PL_SET_LOADING_STATE uses one argument to enable or disable individual plugins.
The plugin_control_mask
parameter is an encoded integer in which each bit controls a specific plugin or class of plugins. Bit positions allocated to date are listed in the “Plugin Type/Bit Position” table below.
A plugin bit set to 0
(zero) prevents the use of the dynamic plugin corresponding to that bit position. A plugin bit set to 1
(one) allows the use of that dynamic plugin.
All dynamic plugins can be enabled by setting plugin_control_mask
to a negative value. A value of 0
(zero) will disable all dynamic plugins.
H5PL_SET_LOADING_STATE inspects the HDF5_PLUGIN_PRELOAD environment variable every time it is called. If the environment variable is set to the special ::
string, all dynamic plugins will be disabled.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Example:
History:
Release | Change |
---|
1.8.15 | Function introduced in this release. |
--- Last Modified: May 03, 2019 | 01:18 PM