![]() |
HDF5 1.14.6
API Reference
|
Modules | |
module | h5vl |
This module contains Fortran interfaces for H5VL (VOL) functions. | |
Functions/Subroutines | |
subroutine | h5vlregister_connector_by_name_f (name, vol_id, hdferr, vipl_id) |
Registers a new VOL connector as a member of the virtual object layer class by name. | |
subroutine | h5vlregister_connector_by_value_f (connector_value, vol_id, hdferr, vipl_id) |
Registers a new VOL connector by value. | |
subroutine | h5vlis_connector_registered_by_name_f (name, registered, hdferr) |
Determines whether a VOL class has been registered or not ccording to a specified connector name. | |
subroutine | h5vlis_connector_registered_by_value_f (value, registered, hdferr) |
Determines whether a VOL class has been registered or not according to a specified connector value (ID). | |
subroutine | h5vlget_connector_id_f (obj_id, vol_id, hdferr) |
Retrieves the ID for a registered VOL connector. | |
subroutine | h5vlget_connector_id_by_name_f (name, vol_id, hdferr) |
Retrieves the ID for a registered VOL connector. | |
subroutine | h5vlget_connector_id_by_value_f (value, vol_id, hdferr) |
Retrieves the ID for a registered VOL connector. | |
subroutine | h5vlget_connector_name_f (obj_id, name, hdferr, name_len) |
Retrieves a connector name for a VOL. | |
subroutine | h5vlclose_f (vol_id, hdferr) |
Closes a VOL connector ID. | |
subroutine | h5vlunregister_connector_f (plugin_id, hdferr) |
Removes a VOL connector ID from the library. | |
subroutine | h5vlnative_addr_to_token_f (loc_id, addr, token, hdferr) |
Retrieves the token representation from an address for a location identifier. | |
subroutine | h5vlnative_token_to_addr_f (loc_id, token, addr, hdferr) |
Retrieves the object address from a token representation for a location identifier. | |
Closes a VOL connector ID.
vol_id | A valid identifier of the connectory to unregister |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5VLclose()
subroutine h5vlget_connector_id_by_name_f | ( | character(len=*), intent(in) | name, |
integer(hid_t), intent(out) | vol_id, | ||
integer, intent(out) | hdferr | ||
) |
Retrieves the ID for a registered VOL connector.
name | Connector name |
vol_id | Connector id. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5VLget_connector_id_by_name()
subroutine h5vlget_connector_id_by_value_f | ( | integer, intent(in) | value, |
integer(hid_t), intent(out) | vol_id, | ||
integer, intent(out) | hdferr | ||
) |
Retrieves the ID for a registered VOL connector.
value | Connector value |
vol_id | Connector id |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5VLget_connector_id_by_value()
subroutine h5vlget_connector_id_f | ( | integer(hid_t), intent(in) | obj_id, |
integer(hid_t), intent(out) | vol_id, | ||
integer, intent(out) | hdferr | ||
) |
Retrieves the ID for a registered VOL connector.
obj_id | Object id |
vol_id | Connector id. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5VLget_connector_id()
subroutine h5vlget_connector_name_f | ( | integer(hid_t), intent(in) | obj_id, |
character(len=*), intent(out) | name, | ||
integer, intent(out) | hdferr, | ||
integer(size_t), optional | name_len | ||
) |
Retrieves a connector name for a VOL.
obj_id | Object identifier or file identifier |
name | Connector name |
hdferr | Returns 0 if successful and -1 if it fails. |
name_len | Maximum length of the name to retrieve |
See C API: H5VLget_connector_name()
subroutine h5vlis_connector_registered_by_name_f | ( | character(len=*), intent(in) | name, |
logical, intent(out) | registered, | ||
integer, intent(out) | hdferr | ||
) |
Determines whether a VOL class has been registered or not ccording to a specified connector name.
name | Connector name |
registered | State of VOL class registration |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5VLis_connector_registered_by_name()
subroutine h5vlis_connector_registered_by_value_f | ( | integer, intent(in) | value, |
logical, intent(out) | registered, | ||
integer, intent(out) | hdferr | ||
) |
Determines whether a VOL class has been registered or not according to a specified connector value (ID).
value | Connector value |
registered | State of VOL class registration |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5VLis_connector_registered_by_value()
subroutine h5vlnative_addr_to_token_f | ( | integer(hid_t), intent(in) | loc_id, |
integer(haddr_t), intent(in) | addr, | ||
type(h5o_token_t_f), intent(out) | token, | ||
integer, intent(out) | hdferr | ||
) |
Retrieves the token representation from an address for a location identifier.
loc_id | Specifies a location identifier |
addr | Address for object in the file |
token | Token representing the object in the file |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5VLnative_addr_to_token()
subroutine h5vlnative_token_to_addr_f | ( | integer(hid_t), intent(in) | loc_id, |
type(h5o_token_t_f), intent(in) | token, | ||
integer(haddr_t), intent(out) | addr, | ||
integer, intent(out) | hdferr | ||
) |
Retrieves the object address from a token representation for a location identifier.
loc_id | Specifies a location identifier |
token | Token representing the object in the file |
addr | Address for object in the file |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5VLnative_token_to_addr()
subroutine h5vlregister_connector_by_name_f | ( | character(len=*), intent(in) | name, |
integer(hid_t), intent(out) | vol_id, | ||
integer, intent(out) | hdferr, | ||
integer(hid_t), intent(in), optional | vipl_id | ||
) |
Registers a new VOL connector as a member of the virtual object layer class by name.
name | Connector name |
vol_id | VOL connector identifier if successful; otherwise returns H5I_INVALID_HID_F |
hdferr | Returns 0 if successful and -1 if it fails. |
vipl_id | VOL initialization property list identifier |
See C API: H5VLregister_connector_by_name()
subroutine h5vlregister_connector_by_value_f | ( | integer, intent(in) | connector_value, |
integer(hid_t), intent(out) | vol_id, | ||
integer, intent(out) | hdferr, | ||
integer(hid_t), intent(in), optional | vipl_id | ||
) |
Registers a new VOL connector by value.
connector_value | Connector value |
vol_id | VOL connector identifier if successful; otherwise returns H5I_INVALID_HID_F |
hdferr | Returns 0 if successful and -1 if it fails. |
vipl_id | VOL initialization property list identifier |
See C API: H5VLregister_connector_by_value()
subroutine h5vlunregister_connector_f | ( | integer(hid_t), intent(in) | plugin_id, |
integer, intent(out) | hdferr | ||
) |
Removes a VOL connector ID from the library.
plugin_id | A valid identifier of the connector to unregister |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5VLunregister_connector()
integer h5_vol_invalid_f |
H5_VOL_INVALID.
integer h5_vol_native_f |
H5_VOL_NATIVE.
integer h5vl_version_f |
H5VL_VERSION.