Registers a new VOL connector

Procedure:

H5VL_REGISTER_CONNECTOR (cls, vipl_id)

Signature:

<pre><code class="language-c">hid_t H5VLregister_connector(const H5VL_class_t *cls, hid_t vipl_id)</code></pre>

<pre><code class="language-fortran">Replace this text with the Fortran function signature</code></pre>

Parameters:

const H5VL_class_t   *cls

IN: A pointer to the plugin structure to register
hid_t    vipl_idIN: Property list identifier

Description

H5VL_REGISTER_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 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.

H5VL_class_t is defined in H5VLconnector.h in the source code. It contains class information for each VOL connector:

Returns:

Returns a VOL connector identifier on success and H5I_INVALID_HID on failure.

Example:

None

History:
ReleaseChange
1.12.0Function introduced