source/include/H5FDsec2.h

0001 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
0002  * Copyright by The HDF Group.                                               *
0003  * All rights reserved.                                                      *
0004  *                                                                           *
0005  * This file is part of HDF5.  The full HDF5 copyright notice, including     *
0006  * terms governing use, modification, and redistribution, is contained in    *
0007  * the COPYING file, which can be found at the root of the source code       *
0008  * distribution tree, or in https://www.hdfgroup.org/licenses.               *
0009  * If you do not have access to either file, you may request a copy from     *
0010  * help@hdfgroup.org.                                                        *
0011  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
0012
0013 /*
0014  * Purpose: The public header file for the POSOX I/O (sec2 - "POSIX section 2")
0015  *          virtual file driver (VFD)
0016  */
0017 #ifndef H5FDsec2_H
0018 #define H5FDsec2_H
0019
0020 /** Initializer for the sec2 VFD */
0021 #define H5FD_SEC2 (H5FDperform_init(H5FD_sec2_init))
0022
0023 /** Identifier for the sec2 VFD */
0024 #define H5FD_SEC2_VALUE H5_VFD_SEC2
0025
0026 #ifdef __cplusplus
0027 extern "C" {
0028 #endif
0029
0030 /** @private
0031  *
0032  * \brief Private initializer for the sec2 VFD
0033  */
0034 H5_DLL hid_t H5FD_sec2_init(void);
0035
0036 /**
0037  * \ingroup FAPL
0038  *
0039  * \brief Modifies the file access property list to use the #H5FD_SEC2 driver
0040  *
0041  * \fapl_id
0042  *
0043  * \returns \herr_t
0044  *
0045  * \details H5Pset_fapl_sec2() modifies the file access property list to use the
0046  *          #H5FD_SEC2 driver.
0047  *
0048  * \since 1.4.0
0049  */
0050 H5_DLL herr_t H5Pset_fapl_sec2(hid_t fapl_id);
0051
0052 #ifdef __cplusplus
0053 }
0054 #endif
0055
0056 #endif