![]() |
HDF5
1.15.0.e736039
API Reference
|
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. More... | |
subroutine | h5vlregister_connector_by_value_f (connector_value, vol_id, hdferr, vipl_id) |
Registers a new VOL connector by value. More... | |
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. More... | |
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). More... | |
subroutine | h5vlget_connector_id_f (obj_id, vol_id, hdferr) |
Retrieves the ID for a registered VOL connector. More... | |
subroutine | h5vlget_connector_id_by_name_f (name, vol_id, hdferr) |
Retrieves the ID for a registered VOL connector. More... | |
subroutine | h5vlget_connector_id_by_value_f (value, vol_id, hdferr) |
Retrieves the ID for a registered VOL connector. More... | |
subroutine | h5vlget_connector_name_f (obj_id, name, hdferr, name_len) |
Retrieves a connector name for a VOL. More... | |
subroutine | h5vlclose_f (vol_id, hdferr) |
Closes a VOL connector ID. More... | |
subroutine | h5vlunregister_connector_f (plugin_id, hdferr) |
Removes a VOL connector ID from the library. More... | |
Variables | |
integer | h5vl_version_f |
H5VL_VERSION. More... | |
integer | h5_vol_invalid_f |
H5_VOL_INVALID. More... | |
integer | h5_vol_native_f |
H5_VOL_NATIVE. More... | |
integer(c_int64_t) | h5vl_cap_flag_none_f |
H5VL_CAP_FLAG_NONE. More... | |
integer(c_int64_t) | h5vl_cap_flag_threadsafe_f |
H5VL_CAP_FLAG_THREADSAFE. More... | |
integer(c_int64_t) | h5vl_cap_flag_async_f |
H5VL_CAP_FLAG_ASYNC. More... | |
integer(c_int64_t) | h5vl_cap_flag_native_files_f |
H5VL_CAP_FLAG_NATIVE_FILES. More... | |
integer(c_int64_t) | h5vl_cap_flag_attr_basic_f |
H5VL_CAP_FLAG_ATTR_BASIC. More... | |
integer(c_int64_t) | h5vl_cap_flag_attr_more_f |
H5VL_CAP_FLAG_ATTR_MORE. More... | |
integer(c_int64_t) | h5vl_cap_flag_dataset_basic_f |
H5VL_CAP_FLAG_DATASET_BASIC. More... | |
integer(c_int64_t) | h5vl_cap_flag_dataset_more_f |
H5VL_CAP_FLAG_DATASET_MORE. More... | |
integer(c_int64_t) | h5vl_cap_flag_file_basic_f |
H5VL_CAP_FLAG_FILE_BASIC. More... | |
integer(c_int64_t) | h5vl_cap_flag_file_more_f |
H5VL_CAP_FLAG_FILE_MORE. More... | |
integer(c_int64_t) | h5vl_cap_flag_group_basic_f |
H5VL_CAP_FLAG_GROUP_BASIC. More... | |
integer(c_int64_t) | h5vl_cap_flag_group_more_f |
H5VL_CAP_FLAG_GROUP_MORE. More... | |
integer(c_int64_t) | h5vl_cap_flag_link_basic_f |
H5VL_CAP_FLAG_LINK_BASIC. More... | |
integer(c_int64_t) | h5vl_cap_flag_link_more_f |
H5VL_CAP_FLAG_LINK_MORE. More... | |
integer(c_int64_t) | h5vl_cap_flag_map_basic_f |
H5VL_CAP_FLAG_MAP_BASIC. More... | |
integer(c_int64_t) | h5vl_cap_flag_map_more_f |
H5VL_CAP_FLAG_MAP_MORE. More... | |
integer(c_int64_t) | h5vl_cap_flag_object_basic_f |
H5VL_CAP_FLAG_OBJECT_BASIC. More... | |
integer(c_int64_t) | h5vl_cap_flag_object_more_f |
H5VL_CAP_FLAG_OBJECT_MORE. More... | |
integer(c_int64_t) | h5vl_cap_flag_ref_basic_f |
H5VL_CAP_FLAG_REF_BASIC. More... | |
integer(c_int64_t) | h5vl_cap_flag_ref_more_f |
H5VL_CAP_FLAG_REF_MORE. More... | |
integer(c_int64_t) | h5vl_cap_flag_obj_ref_f |
H5VL_CAP_FLAG_OBJ_REF. More... | |
integer(c_int64_t) | h5vl_cap_flag_reg_ref_f |
H5VL_CAP_FLAG_REG_REF. More... | |
integer(c_int64_t) | h5vl_cap_flag_attr_ref_f |
H5VL_CAP_FLAG_ATTR_REF. More... | |
integer(c_int64_t) | h5vl_cap_flag_stored_datatypes_f |
H5VL_CAP_FLAG_STORED_DATATYPES. More... | |
integer(c_int64_t) | h5vl_cap_flag_creation_order_f |
H5VL_CAP_FLAG_CREATION_ORDER. More... | |
integer(c_int64_t) | h5vl_cap_flag_iterate_f |
H5VL_CAP_FLAG_ITERATE. More... | |
integer(c_int64_t) | h5vl_cap_flag_storage_size_f |
H5VL_CAP_FLAG_STORAGE_SIZE. More... | |
integer(c_int64_t) | h5vl_cap_flag_by_idx_f |
H5VL_CAP_FLAG_BY_IDX. More... | |
integer(c_int64_t) | h5vl_cap_flag_get_plist_f |
H5VL_CAP_FLAG_GET_PLIST. More... | |
integer(c_int64_t) | h5vl_cap_flag_flush_refresh_f |
H5VL_CAP_FLAG_FLUSH_REFRESH. More... | |
integer(c_int64_t) | h5vl_cap_flag_external_links_f |
H5VL_CAP_FLAG_EXTERNAL_LINKS. More... | |
integer(c_int64_t) | h5vl_cap_flag_hard_links_f |
H5VL_CAP_FLAG_HARD_LINKS. More... | |
integer(c_int64_t) | h5vl_cap_flag_soft_links_f |
H5VL_CAP_FLAG_SOFT_LINKS. More... | |
integer(c_int64_t) | h5vl_cap_flag_ud_links_f |
H5VL_CAP_FLAG_UD_LINKS. More... | |
integer(c_int64_t) | h5vl_cap_flag_track_times_f |
H5VL_CAP_FLAG_TRACK_TIMES. More... | |
integer(c_int64_t) | h5vl_cap_flag_mount_f |
H5VL_CAP_FLAG_MOUNT. More... | |
integer(c_int64_t) | h5vl_cap_flag_filters_f |
H5VL_CAP_FLAG_FILTERS. More... | |
integer(c_int64_t) | h5vl_cap_flag_fill_values_f |
H5VL_CAP_FLAG_FILL_VALUES. More... | |
integer(c_int64_t) | h5vl_opt_query_supported_f |
H5VL_OPT_QUERY_SUPPORTED. More... | |
integer(c_int64_t) | h5vl_opt_query_read_data_f |
H5VL_OPT_QUERY_READ_DATA. More... | |
integer(c_int64_t) | h5vl_opt_query_write_data_f |
H5VL_OPT_QUERY_WRITE_DATA. More... | |
integer(c_int64_t) | h5vl_opt_query_query_metadata_f |
H5VL_OPT_QUERY_QUERY_METADATA. More... | |
integer(c_int64_t) | h5vl_opt_query_modify_metadata_f |
H5VL_OPT_QUERY_MODIFY_METADATA. More... | |
integer(c_int64_t) | h5vl_opt_query_collective_f |
H5VL_OPT_QUERY_COLLECTIVE. More... | |
integer(c_int64_t) | h5vl_opt_query_no_async_f |
H5VL_OPT_QUERY_NO_ASYNC. More... | |
integer(c_int64_t) | h5vl_opt_query_multi_obj_f |
H5VL_OPT_QUERY_MULTI_OBJ. More... | |
subroutine h5vl::h5vlclose_f | ( | integer(hid_t), intent(in) | vol_id, |
integer, intent(out) | hdferr | ||
) |
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 h5vl::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 h5vl::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 h5vl::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 h5vl::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 h5vl::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 h5vl::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 h5vl::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 h5vl::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 h5vl::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(c_int64_t) h5vl_cap_flag_async_f |
H5VL_CAP_FLAG_ASYNC.
integer(c_int64_t) h5vl_cap_flag_attr_basic_f |
H5VL_CAP_FLAG_ATTR_BASIC.
integer(c_int64_t) h5vl_cap_flag_attr_more_f |
H5VL_CAP_FLAG_ATTR_MORE.
integer(c_int64_t) h5vl_cap_flag_attr_ref_f |
H5VL_CAP_FLAG_ATTR_REF.
integer(c_int64_t) h5vl_cap_flag_by_idx_f |
H5VL_CAP_FLAG_BY_IDX.
integer(c_int64_t) h5vl_cap_flag_creation_order_f |
H5VL_CAP_FLAG_CREATION_ORDER.
integer(c_int64_t) h5vl_cap_flag_dataset_basic_f |
H5VL_CAP_FLAG_DATASET_BASIC.
integer(c_int64_t) h5vl_cap_flag_dataset_more_f |
H5VL_CAP_FLAG_DATASET_MORE.
integer(c_int64_t) h5vl_cap_flag_external_links_f |
H5VL_CAP_FLAG_EXTERNAL_LINKS.
integer(c_int64_t) h5vl_cap_flag_file_basic_f |
H5VL_CAP_FLAG_FILE_BASIC.
integer(c_int64_t) h5vl_cap_flag_file_more_f |
H5VL_CAP_FLAG_FILE_MORE.
integer(c_int64_t) h5vl_cap_flag_fill_values_f |
H5VL_CAP_FLAG_FILL_VALUES.
integer(c_int64_t) h5vl_cap_flag_filters_f |
H5VL_CAP_FLAG_FILTERS.
integer(c_int64_t) h5vl_cap_flag_flush_refresh_f |
H5VL_CAP_FLAG_FLUSH_REFRESH.
integer(c_int64_t) h5vl_cap_flag_get_plist_f |
H5VL_CAP_FLAG_GET_PLIST.
integer(c_int64_t) h5vl_cap_flag_group_basic_f |
H5VL_CAP_FLAG_GROUP_BASIC.
integer(c_int64_t) h5vl_cap_flag_group_more_f |
H5VL_CAP_FLAG_GROUP_MORE.
integer(c_int64_t) h5vl_cap_flag_hard_links_f |
H5VL_CAP_FLAG_HARD_LINKS.
integer(c_int64_t) h5vl_cap_flag_iterate_f |
H5VL_CAP_FLAG_ITERATE.
integer(c_int64_t) h5vl_cap_flag_link_basic_f |
H5VL_CAP_FLAG_LINK_BASIC.
integer(c_int64_t) h5vl_cap_flag_link_more_f |
H5VL_CAP_FLAG_LINK_MORE.
integer(c_int64_t) h5vl_cap_flag_map_basic_f |
H5VL_CAP_FLAG_MAP_BASIC.
integer(c_int64_t) h5vl_cap_flag_map_more_f |
H5VL_CAP_FLAG_MAP_MORE.
integer(c_int64_t) h5vl_cap_flag_mount_f |
H5VL_CAP_FLAG_MOUNT.
integer(c_int64_t) h5vl_cap_flag_native_files_f |
H5VL_CAP_FLAG_NATIVE_FILES.
integer(c_int64_t) h5vl_cap_flag_none_f |
H5VL_CAP_FLAG_NONE.
integer(c_int64_t) h5vl_cap_flag_obj_ref_f |
H5VL_CAP_FLAG_OBJ_REF.
integer(c_int64_t) h5vl_cap_flag_object_basic_f |
H5VL_CAP_FLAG_OBJECT_BASIC.
integer(c_int64_t) h5vl_cap_flag_object_more_f |
H5VL_CAP_FLAG_OBJECT_MORE.
integer(c_int64_t) h5vl_cap_flag_ref_basic_f |
H5VL_CAP_FLAG_REF_BASIC.
integer(c_int64_t) h5vl_cap_flag_ref_more_f |
H5VL_CAP_FLAG_REF_MORE.
integer(c_int64_t) h5vl_cap_flag_reg_ref_f |
H5VL_CAP_FLAG_REG_REF.
integer(c_int64_t) h5vl_cap_flag_soft_links_f |
H5VL_CAP_FLAG_SOFT_LINKS.
integer(c_int64_t) h5vl_cap_flag_storage_size_f |
H5VL_CAP_FLAG_STORAGE_SIZE.
integer(c_int64_t) h5vl_cap_flag_stored_datatypes_f |
H5VL_CAP_FLAG_STORED_DATATYPES.
integer(c_int64_t) h5vl_cap_flag_threadsafe_f |
H5VL_CAP_FLAG_THREADSAFE.
integer(c_int64_t) h5vl_cap_flag_track_times_f |
H5VL_CAP_FLAG_TRACK_TIMES.
integer(c_int64_t) h5vl_cap_flag_ud_links_f |
H5VL_CAP_FLAG_UD_LINKS.
integer(c_int64_t) h5vl_opt_query_collective_f |
H5VL_OPT_QUERY_COLLECTIVE.
integer(c_int64_t) h5vl_opt_query_modify_metadata_f |
H5VL_OPT_QUERY_MODIFY_METADATA.
integer(c_int64_t) h5vl_opt_query_multi_obj_f |
H5VL_OPT_QUERY_MULTI_OBJ.
integer(c_int64_t) h5vl_opt_query_no_async_f |
H5VL_OPT_QUERY_NO_ASYNC.
integer(c_int64_t) h5vl_opt_query_query_metadata_f |
H5VL_OPT_QUERY_QUERY_METADATA.
integer(c_int64_t) h5vl_opt_query_read_data_f |
H5VL_OPT_QUERY_READ_DATA.
integer(c_int64_t) h5vl_opt_query_supported_f |
H5VL_OPT_QUERY_SUPPORTED.
integer(c_int64_t) h5vl_opt_query_write_data_f |
H5VL_OPT_QUERY_WRITE_DATA.
integer h5vl_version_f |
H5VL_VERSION.