H5VL_REGISTER_CONNECTOR_BY_NAME
Registers a new VOL connector by name
Procedure:
H5VL_REGISTER_CONNECTOR_BY_NAME (name, vipl_id)
Signature:
hid_t H5VLregister_connector_by_name(const char *name, hid_t vipl_id)
SUBROUTINE H5VLregister_connector_by_name_f(name, vol_id, hdferr, vipl_id)
IMPLICIT NONE
CHARACTER(LEN=*), INTENT(IN) :: name
INTEGER(HID_T), INTENT(OUT) :: vol_id
INTEGER, INTENT(OUT) :: hdferr
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: vipl_id
END SUBROUTINE H5VLregister_connector_by_name_f
Parameters:
const char * name | IN: Connector name |
hid_t vipl_id | IN: Property list identifier |
Description
H5VL_REGISTER_CONNECTOR_BY_NAME registers a new VOL connector with the name name
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 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: August 19, 2019 | 11:58 AM