source/include/H5FDstdio.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 C stdio virtual file driver (VFD)
0015  */
0016 #ifndef H5FDstdio_H
0017 #define H5FDstdio_H
0018
0019 #include "H5Ipublic.h"
0020
0021 /** Initializer for the stdio VFD */
0022 #define H5FD_STDIO (H5FDperform_init(H5FD_stdio_init))
0023
0024 #ifdef __cplusplus
0025 extern "C" {
0026 #endif
0027
0028 /** @private
0029  *
0030  * \brief Private initializer for the stdio VFD
0031  */
0032 H5_DLL hid_t H5FD_stdio_init(void);
0033
0034 /**
0035  * \ingroup FAPL
0036  *
0037  * \brief Sets the standard I/O driver
0038  *
0039  * \fapl_id
0040  * \returns \herr_t
0041  *
0042  * \details H5Pset_fapl_stdio() modifies the file access property list to use
0043  *          the stdio VFD, which uses I/O calls from stdio.h.
0044  *
0045  * \note This VFD was designed to be a "demo" VFD that shows how to write
0046  * your own VFD. Most applications should not use this VFD and should instead
0047  * use the POSIX I/O VFD (sec2).
0048  *
0049  * \since 1.4.0
0050  *
0051  */
0052 H5_DLL herr_t H5Pset_fapl_stdio(hid_t fapl_id);
0053
0054 #ifdef __cplusplus
0055 }
0056 #endif
0057
0058 #endif