H5VL_REGISTER_CONNECTOR_BY_VALUE
Registers a new VOL connector by connector value
Procedure:
H5VL_REGISTER_CONNECTOR_BY_VALUE (connector_value, vipl_id)
Signature:
hid_t H5VLregister_connector_by_value (H5VL_class_value_t connector_value, hid_t vipl_id)
SUBROUTINE H5VLregister_connector_by_value_f(connector_value, vol_id, hdferr, vipl_id)
IMPLICIT NONE
INTEGER, INTENT(IN) :: connector_value
INTEGER(HID_T), INTENT(OUT) :: vol_id
INTEGER, INTENT(OUT) :: hdferr
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: vipl_id
END SUBROUTINE H5VLregister_connector_by_value_f
Parameters:
H5VL_class_value_t connector_value | IN: A connector value |
hid_t vipl_id | IN: Property list identifier |
Description
H5VL_REGISTER_CONNECTOR_BY_VALUE registers a new VOL connector with value connector_value 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.
connector_value has a type of H5VL_class_value_t, which is defined in H5VLpublic.h as: typedef int H5VL_class_value_t;
Valid VOL connector identifiers can have values from 0 through 255 for connectors defined by the HDF5 library. Values 256 through 511 are available for testing new connectors. Subsequent values should be obtained by contacting the The HDF Help Desk.
vipl_id is either H5P_DEFAULT or the identifier of a VOL initialization property list created with H5P_CREATE (H5Pcreate(H5P_VOL_INITIALIZE)). 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.
Returns:
Returns a VOL connector identifier on success and H5I_INVALID_HID on failure.
Example:
History:
| Release | Change |
|---|
| 1.12.0 | Function introduced |
--- Last Modified: January 31, 2020 | 02:40 PM
