Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5P_GET_DRIVER_INFO

Returns a pointer to file driver information

Procedure:

H5P_GET_DRIVER_INFO (  plist_id )

Signature:

const void *H5Pget_driver_info(
                     hid_t plist_id
    )
  

Parameters:

hid_t plist_id    IN: File access or data transfer property list identifier

Description:

H5P_GET_DRIVER_INFO returns a pointer to file driver-specific information for the low-level driver associated with the file access or data transfer property list plist_id.

The pointer returned by this function points to an “uncopied” struct. Driver-specific versions of that struct are defined for each low-level driver in the relevant source code file H5FD*.c. For example, the struct used for the MULTI driver is H5FD_multi_fapl_t defined in H5FDmulti.c.

If no driver-specific properties have been registered, H5P_GET_DRIVER_INFO returns NULL.

H5P_GET_DRIVER_INFO and H5P_SET_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 pointer to a struct containing low-level driver information. Otherwise returns NULL.

NULL is also returned if no driver-specific properties have been registered. No error is pushed on the stack in this case.

Example:

Coming Soon!

History:
Release    C
1.10.1Return value was changed from void * to const void *.
1.8.2Function publicized in this release; previous releases described this function only in the virtual file driver documentation.

--- Last Modified: December 04, 2017 | 08:16 AM