Please, help us to better serve our user community by answering the following short survey: https://www.hdfgroup.org/website-survey/
HDF5 1.14.5
API Reference
Loading...
Searching...
No Matches
Java VOL Connector (H5VL) Interface

Detailed Description

See also
VOL connector (H5VL), C-API
HDF5 Virtual Object Layer (VOL), User Guide

Functions

static synchronized native long H5VLregister_connector_by_name (String connector_name, long vipl_id) throws HDF5LibraryException
 
static synchronized native long H5VLregister_connector_by_value (int connector_value, long vipl_id) throws HDF5LibraryException
 
static synchronized native boolean H5VLis_connector_registered_by_name (String name) throws HDF5LibraryException
 
static synchronized native boolean H5VLis_connector_registered_by_value (int connector_value) throws HDF5LibraryException
 
static synchronized native long H5VLget_connector_id (long object_id) throws HDF5LibraryException
 
static synchronized native long H5VLget_connector_id_by_name (String name) throws HDF5LibraryException
 
static synchronized native long H5VLget_connector_id_by_value (int connector_value) throws HDF5LibraryException
 
static synchronized native String H5VLget_connector_name (long object_id) throws HDF5LibraryException
 
static synchronized native void H5VLclose (long connector_id) throws HDF5LibraryException
 
static synchronized native void H5VLunregister_connector (long connector_id) throws HDF5LibraryException
 

Function Documentation

◆ H5VLclose()

static synchronized native void H5VLclose ( long  connector_id) throws HDF5LibraryException
static

H5VLclose closes a VOL connector ID.

Parameters
connector_idIN: Identifier of the connector.
Exceptions
HDF5LibraryExceptionError from the HDF5 Library.

◆ H5VLget_connector_id()

static synchronized native long H5VLget_connector_id ( long  object_id) throws HDF5LibraryException
static

H5VLget_connector_id retrieves the ID for a registered VOL connector for a given object.

Parameters
object_idIN: Identifier of the object.
Returns
a VOL connector ID
Exceptions
HDF5LibraryExceptionError from the HDF5 Library.

◆ H5VLget_connector_id_by_name()

static synchronized native long H5VLget_connector_id_by_name ( String  name) throws HDF5LibraryException
static

H5VLget_connector_id_by_name retrieves the ID for a registered VOL connector.

Parameters
nameIN: name of the connector.
Returns
a VOL connector ID
Exceptions
HDF5LibraryExceptionError from the HDF5 Library.

◆ H5VLget_connector_id_by_value()

static synchronized native long H5VLget_connector_id_by_value ( int  connector_value) throws HDF5LibraryException
static

H5VLget_connector_id_by_value retrieves the ID for a registered VOL connector.

Parameters
connector_valueIN: value of the connector.
Returns
a VOL connector ID
Exceptions
HDF5LibraryExceptionError from the HDF5 Library.

◆ H5VLget_connector_name()

static synchronized native String H5VLget_connector_name ( long  object_id) throws HDF5LibraryException
static

H5VLget_connector_name returns the connector name for the VOL associated with the object or file ID.

Parameters
object_idIN: Identifier of the object.
Returns
the connector name
Exceptions
HDF5LibraryExceptionError from the HDF5 Library.

◆ H5VLis_connector_registered_by_name()

static synchronized native boolean H5VLis_connector_registered_by_name ( String  name) throws HDF5LibraryException
static

H5VLis_connector_registered_by_name tests whether a VOL class has been registered.

Parameters
nameIN: name of the connector.
Returns
true if a VOL connector with that name has been registered
Exceptions
HDF5LibraryExceptionError from the HDF5 Library.

◆ H5VLis_connector_registered_by_value()

static synchronized native boolean H5VLis_connector_registered_by_value ( int  connector_value) throws HDF5LibraryException
static

H5VLis_connector_registered_by_value tests whether a VOL class has been registered.

Parameters
connector_valueIN: value of the connector.
Returns
true if a VOL connector with that value has been registered
Exceptions
HDF5LibraryExceptionError from the HDF5 Library.

◆ H5VLregister_connector_by_name()

static synchronized native long H5VLregister_connector_by_name ( String  connector_name,
long  vipl_id 
) throws HDF5LibraryException
static

H5VLregister_connector_by_name registers a new VOL connector as a member of the virtual object layer class.

Parameters
connector_nameIN: name of the connector.
vipl_idIN: VOL initialization property list which must be created with H5Pcreate(H5P_VOL_INITIALIZE) (or H5P_DEFAULT).
Returns
a VOL connector ID
Exceptions
HDF5LibraryExceptionError from the HDF5 Library.

◆ H5VLregister_connector_by_value()

static synchronized native long H5VLregister_connector_by_value ( int  connector_value,
long  vipl_id 
) throws HDF5LibraryException
static

H5VLregister_connector_by_value registers a new VOL connector as a member of the virtual object layer class.

Parameters
connector_valueIN: value of the connector.
vipl_idIN: VOL initialization property list which must be created with H5Pcreate(H5P_VOL_INITIALIZE) (or H5P_DEFAULT).
Returns
a VOL connector ID
Exceptions
HDF5LibraryExceptionError from the HDF5 Library.

◆ H5VLunregister_connector()

static synchronized native void H5VLunregister_connector ( long  connector_id) throws HDF5LibraryException
static

H5VLunregister_connector removes a VOL connector ID from the library.

Parameters
connector_idIN: Identifier of the connector.
Exceptions
HDF5LibraryExceptionError from the HDF5 Library.