 |
APIReference
|
|
◆ H5VLget_file_type()
hid_t H5VLget_file_type |
( |
void * |
file_obj, |
|
|
hid_t |
connector_id, |
|
|
hid_t |
dtype_id |
|
) |
| |
◆ H5VLobject()
void* H5VLobject |
( |
hid_t |
obj_id | ) |
|
◆ H5VLpeek_connector_id_by_name()
hid_t H5VLpeek_connector_id_by_name |
( |
const char * |
name | ) |
|
◆ H5VLpeek_connector_id_by_value()
◆ H5VLregister_connector()
Registers a new VOL connector.
- Parameters
-
[in] | cls | A pointer to the plugin structure to register |
[in] | vipl_id | VOL initialization property list identifier |
- Returns
- Returns a VOL connector identifier if successful; otherwise returns H5I_INVALID_HID.
H5VLregister_connector() registers a new VOL connector as a member of the virtual object layer class. This VOL connector identifier is good until the library is closed or the connector is unregistered.
vipl_id
is either H5P_DEFAULT or the identifier of a VOL initialization property list of class H5P_VOL_INITIALIZE created with H5Pcreate(). When created, this property list contains no library properties. If a VOL connector author decides that initialization-specific data are needed, they can be added to the empty list and retrieved by the connector in the VOL connector's initialize callback. Use of the VOL initialization property list is uncommon, as most VOL-specific properties are added to the file access property list via the connector's API calls which set the VOL connector for the file open/create. For more information, see the VOL documentation.
H5VL_class_t is defined in H5VLconnector.h in the source code. It contains class information for each VOL connector:
- Since
- 1.12.0
int H5VL_class_value_t
VOL connector identifiers.
Definition: H5VLpublic.h:144
Definition: H5VLconnector.h:992
H5VL_attr_class_t attr_cls
Definition: H5VLconnector.h:1026
herr_t(* terminate)(void)
Definition: H5VLconnector.h:1019
Definition: H5VLconnector.h:1000
uint64_t cap_flags
Definition: H5VLconnector.h:1017
H5VL_request_class_t request_cls
Definition: H5VLconnector.h:1036
H5VL_datatype_class_t datatype_cls
Definition: H5VLconnector.h:1028
Definition: H5VLconnector.h:893
H5VL_token_class_t token_cls
Definition: H5VLconnector.h:1038
Definition: H5VLconnector.h:975
Definition: H5VLconnector.h:916
int64_t hid_t
Definition: H5Ipublic.h:60
Definition: H5VLconnector.h:877
Definition: H5VLconnector.h:928
Definition: H5VLconnector.h:849
H5VL_blob_class_t blob_cls
Definition: H5VLconnector.h:1037
H5VL_wrap_class_t wrap_cls
Definition: H5VLconnector.h:1023
Definition: H5VLconnector.h:905
Definition: H5VLconnector.h:837
H5VL_file_class_t file_cls
Definition: H5VLconnector.h:1029
H5VL_info_class_t info_cls
Definition: H5VLconnector.h:1022
unsigned version
Definition: H5VLconnector.h:1013
H5VL_object_class_t object_cls
Definition: H5VLconnector.h:1032
H5VL_introspect_class_t introspect_cls
Definition: H5VLconnector.h:1035
H5VL_link_class_t link_cls
Definition: H5VLconnector.h:1031
H5VL_dataset_class_t dataset_cls
Definition: H5VLconnector.h:1027
int herr_t
Definition: H5public.h:235
Definition: H5VLconnector.h:862
Definition: H5VLconnector.h:1011
H5VL_group_class_t group_cls
Definition: H5VLconnector.h:1030
Definition: H5VLconnector.h:982
unsigned conn_version
Definition: H5VLconnector.h:1016
herr_t(* initialize)(hid_t vipl_id)
Definition: H5VLconnector.h:1018
const char * name
Definition: H5VLconnector.h:1015
Definition: H5VLconnector.h:946
herr_t(* optional)(void *obj, H5VL_optional_args_t *args, hid_t dxpl_id, void **req)
Definition: H5VLconnector.h:1041
Definition: H5VLconnector.h:94
H5VL_class_value_t value
Definition: H5VLconnector.h:1014