Sets a file driver

Procedure:

H5P_SET_DRIVER ( plist_id, new_driver_id, new_driver_info )

Signature:

<pre><code class="language-c">herr_t H5Pset_driver(
                     hid_t plist_id,
                     hid_t new_driver_id,
                     const void *new_driver_info
    )
  </code></pre>

Parameters:
hid_t plist_idIN: File access or data transfer property list identifier
hid_t new_driver_idIN: Driver identifier
const void * new_driver_infoIN: Optional struct containing driver properties

Description:

H5P_SET_DRIVER sets the file driver, new_driver_id, for a file access or data transfer property list, plist_id, and supplies an optional struct containing the driver-specific properties, new_driver_info.

The driver properties will be copied into the property list and the reference count on the driver will be incremented, allowing the caller to close the driver identifier but still use the property list.

H5P_SET_DRIVER and H5P_GET_DRIVER are used only when creating a virtual file driver (VFD) in the virtual file layer (VFL). For further information, see Virtual File Layer and List of VFL Functions in the HDF5 Technical Notes.

 

Returns:

Returns a non-negative value if successful. Otherwise returns a negative value.

Example:

Coming Soon!

History:
Release    Change
1.8.2Function publicized in this release; previous releases described this function only in the virtual file driver documentation.