Fortran VOL (H5VL) Interface

Detailed Description

See also

VOL connector (H5VL), C-API

The HDF5 Virtual Object Layer (VOL), User Guide

Functions/Subroutines
subroutine	h5vlregister_connector_by_name_f (name, vol_id, hdferr, vipl_id)
	Registers a new VOL connector as a member of the virtual object layer class by name. More...
subroutine	h5vlregister_connector_by_value_f (connector_value, vol_id, hdferr, vipl_id)
	Registers a new VOL connector by value. More...
subroutine	h5vlis_connector_registered_by_name_f (name, registered, hdferr)
	Determines whether a VOL class has been registered or not ccording to a specified connector name. More...
subroutine	h5vlis_connector_registered_by_value_f (value, registered, hdferr)
	Determines whether a VOL class has been registered or not according to a specified connector value (ID). More...
subroutine	h5vlget_connector_id_f (obj_id, vol_id, hdferr)
	Retrieves the ID for a registered VOL connector. More...
subroutine	h5vlget_connector_id_by_name_f (name, vol_id, hdferr)
	Retrieves the ID for a registered VOL connector. More...
subroutine	h5vlget_connector_id_by_value_f (value, vol_id, hdferr)
	Retrieves the ID for a registered VOL connector. More...
subroutine	h5vlget_connector_name_f (obj_id, name, hdferr, name_len)
	Retrieves a connector name for a VOL. More...
subroutine	h5vlclose_f (vol_id, hdferr)
	Closes a VOL connector ID. More...
subroutine	h5vlunregister_connector_f (plugin_id, hdferr)
	Removes a VOL connector ID from the library. More...

Function/Subroutine Documentation

h5vlclose_f()

subroutine h5vl::h5vlclose_f	(	integer(hid_t), intent(in)	vol_id,
		integer, intent(out)	hdferr
	)

Closes a VOL connector ID.

Parameters

vol_id	A valid identifier of the connectory to unregister
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5VLclose()

h5vlget_connector_id_by_name_f()

subroutine h5vl::h5vlget_connector_id_by_name_f	(	character(len=*), intent(in)	name,
		integer(hid_t), intent(out)	vol_id,
		integer, intent(out)	hdferr
	)

Retrieves the ID for a registered VOL connector.

Parameters

name	Connector name
vol_id	Connector id.
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5VLget_connector_id_by_name()

h5vlget_connector_id_by_value_f()

subroutine h5vl::h5vlget_connector_id_by_value_f	(	integer, intent(in)	value,
		integer(hid_t), intent(out)	vol_id,
		integer, intent(out)	hdferr
	)

Retrieves the ID for a registered VOL connector.

Parameters

value	Connector value
vol_id	Connector id
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5VLget_connector_id_by_value()

h5vlget_connector_id_f()

subroutine h5vl::h5vlget_connector_id_f	(	integer(hid_t), intent(in)	obj_id,
		integer(hid_t), intent(out)	vol_id,
		integer, intent(out)	hdferr
	)

Retrieves the ID for a registered VOL connector.

Parameters

obj_id	Object id
vol_id	Connector id.
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5VLget_connector_id()

h5vlget_connector_name_f()

subroutine h5vl::h5vlget_connector_name_f	(	integer(hid_t), intent(in)	obj_id,
		character(len=*), intent(out)	name,
		integer, intent(out)	hdferr,
		integer(size_t), optional	name_len
	)

Retrieves a connector name for a VOL.

Parameters

obj_id	Object identifier or file identifier
name	Connector name
hdferr	Returns 0 if successful and -1 if it fails.
name_len	Maximum length of the name to retrieve

See C API: H5VLget_connector_name()

h5vlis_connector_registered_by_name_f()

subroutine h5vl::h5vlis_connector_registered_by_name_f	(	character(len=*), intent(in)	name,
		logical, intent(out)	registered,
		integer, intent(out)	hdferr
	)

Determines whether a VOL class has been registered or not ccording to a specified connector name.

Parameters

name	Connector name
registered	State of VOL class registration
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5VLis_connector_registered_by_name()

h5vlis_connector_registered_by_value_f()

subroutine h5vl::h5vlis_connector_registered_by_value_f	(	integer, intent(in)	value,
		logical, intent(out)	registered,
		integer, intent(out)	hdferr
	)

Determines whether a VOL class has been registered or not according to a specified connector value (ID).

Parameters

value	Connector value
registered	State of VOL class registration
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5VLis_connector_registered_by_value()

h5vlregister_connector_by_name_f()

subroutine h5vl::h5vlregister_connector_by_name_f	(	character(len=*), intent(in)	name,
		integer(hid_t), intent(out)	vol_id,
		integer, intent(out)	hdferr,
		integer(hid_t), intent(in), optional	vipl_id
	)

Registers a new VOL connector as a member of the virtual object layer class by name.

Parameters

name	Connector name
vol_id	VOL connector identifier if successful; otherwise returns H5I_INVALID_HID_F
hdferr	Returns 0 if successful and -1 if it fails.
vipl_id	VOL initialization property list identifier

See C API: H5VLregister_connector_by_name()

h5vlregister_connector_by_value_f()

subroutine h5vl::h5vlregister_connector_by_value_f	(	integer, intent(in)	connector_value,
		integer(hid_t), intent(out)	vol_id,
		integer, intent(out)	hdferr,
		integer(hid_t), intent(in), optional	vipl_id
	)

Registers a new VOL connector by value.

Parameters

connector_value	Connector value
vol_id	VOL connector identifier if successful; otherwise returns H5I_INVALID_HID_F
hdferr	Returns 0 if successful and -1 if it fails.
vipl_id	VOL initialization property list identifier

See C API: H5VLregister_connector_by_value()

h5vlunregister_connector_f()

subroutine h5vl::h5vlunregister_connector_f	(	integer(hid_t), intent(in)	plugin_id,
		integer, intent(out)	hdferr
	)

Removes a VOL connector ID from the library.

Parameters

plugin_id	A valid identifier of the connector to unregister
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5VLunregister_connector()