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