HDFql Reference Manual v2.6.0

6.7.34SHOW LIBRARY BOUNDS

Syntax

SHOW [USE FILE] LIBRARY BOUNDS [FROM | TO] [BY NAME]

[post_processing_option]

[output_redirecting_option]

Description

Show (i.e. get) the library bound values for creating or opening HDF5 files. If the keyword USE FILE is not specified, the library bound values refer to the default values for creating or opening (subsequent) files. Otherwise, if the keyword USE FILE is specified, the library bound values of the file currently in use are returned. If neither the keyword FROM nor TO is specified, all library bound values (i.e. from and to) are returned. To return a specific library bound value, the keyword FROM or TO must be specified.

Parameter(s)

post_processing_option – optional option that transforms the result set according to the programmer’s needs, such as ordering or truncating (please refer to the section PROCESSING for additional information).

output_redirecting_option – optional option that specifies the cursor in use, an HDF5 object (i.e. dataset or attribute), a (text, binary, or Excel) file, or memory (i.e. user-defined variable) to write the result set into (please refer to the subsection INTO for additional information). If not specified, the cursor in use is populated with the result set instead (please refer to the chapter CURSOR for additional information).

Return

If the keyword BY NAME is not specified, it returns the library bound values for creating or opening HDF5 files as an HDFQL_INT, which can be HDFQL_VERSION_EARLIEST, HDFQL_VERSION_LATEST, HDFQL_VERSION_18, and/or HDFQL_VERSION_110 depending on whether the library bound values are earliest, latest, version 1.8, and/or version 1.10, respectively. Otherwise, if the keyword BY NAME is specified, it returns the library bound values for creating or opening files as an HDFQL_VARCHAR, which can be “VERSION_EARLIEST”, “VERSION_LATEST”, “VERSION_18”, and/or “VERSION_110”.

Example(s)

# show (i.e. get) library bound values from (i.e. lower bound) and to (i.e. upper bound) (should return 1 (i.e. HDFQL_VERSION_EARLIEST) and 2 (i.e. HDFQL_VERSION_LATEST) – i.e. default values defined by the HDF5 library)
SHOW LIBRARY BOUNDS 

# show (i.e. get) library bound value from (i.e. lower bound) (should return 1 (i.e. HDFQL_VERSION_EARLIEST))
SHOW LIBRARY BOUNDS FROM

# show (i.e. get) library bound value to (i.e. upper bound) (should return 2 (i.e. HDFQL_VERSION_LATEST))
SHOW LIBRARY BOUNDS TO

# set library bound from (i.e. lower bound) to 2 (i.e. HDFQL_VERSION_LATEST) (the library bound to (i.e. upper bound) remains intact) for subsequent usage (i.e. creating or opening HDF5 files)
SET LIBRARY BOUNDS FROM LATEST

# show (i.e. get) library bound values from (i.e. lower bound) and to (i.e. upper bound) (should return 2 (i.e. HDFQL_VERSION_LATEST) and 2 (i.e. HDFQL_VERSION_LATEST))
SHOW LIBRARY BOUNDS 

# set both library bounds from (i.e. lower bound) and to (i.e. upper bound) to default values for subsequent usage (i.e. creating or opening HDF5 files)
SET LIBRARY BOUNDS FROM DEFAULT TO DEFAULT 

# show (i.e. get) library bound values from (i.e. lower bound) and to (i.e. upper bound) (should return 1 (i.e. HDFQL_VERSION_EARLIEST) and 2 (i.e. HDFQL_VERSION_LATEST) – i.e. default values defined by the HDF5 library)
SHOW LIBRARY BOUNDS
# use (i.e. open) an HDF5 file named "my_file0.h5" with library bounds from (i.e. lower bound) and to (i.e. upper bound) set to the earliest and latest versions, respectively
USE FILE my_file0.h5

# show (i.e. get) library bound value from (i.e. lower bound) (should return 1 (i.e. HDFQL_VERSION_EARLIEST))
SHOW USE FILE LIBRARY BOUNDS FROM

# show (i.e. get) library bound value to (i.e. upper bound) (should return 2 (i.e. HDFQL_VERSION_LATEST))
SHOW USE FILE LIBRARY BOUNDS TO

# set library bound from (i.e. lower bound) to 2 (i.e. HDFQL_VERSION_LATEST) (the library bound to (i.e. upper bound) remains intact) for subsequent usage (i.e. creating or opening HDF5 files)
SET LIBRARY BOUNDS FROM LATEST

# use (i.e. open) an HDF5 file named "my_file1.h5" with both library bounds from (i.e. lower bound) and to (i.e. upper bound) set to the latest version
USE FILE my_file1.h5

# show (i.e. get) library bound values from (i.e. lower bound) and to (i.e. upper bound) of the file currently in use (should return 2 (i.e. HDFQL_VERSION_LATEST) and 2 (i.e. HDFQL_VERSION_LATEST))
SHOW USE FILE LIBRARY BOUNDS 

# use (i.e. open) an HDF5 file named "my_file2.h5" with library bounds from (i.e. lower bound) and to (i.e. upper bound) set to the earliest and latest versions, respectively (i.e. default values defined by the HDF5 library)
USE FILE my_file2.h5 LIBRARY BOUNDS FROM DEFAULT 

# show (i.e. get) library bound values from (i.e. lower bound) and to (i.e. upper bound) of the file currently in use (should return 1 (i.e. HDFQL_VERSION_EARLIEST) and 2 (i.e. HDFQL_VERSION_LATEST))
SHOW USE FILE LIBRARY BOUNDS