source/include/H5FDwindows.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 Windows virtual file driver (VFD)
0015  *
0016  *          This VFD uses no Win32 API calls directly (though it may be
0017  *          rewritten to do so in the future). It is currently defined to
0018  *          be the sec2 VFD.
0019  */
0020 #ifndef H5FDwindows_H
0021 #define H5FDwindows_H
0022
0023 /** Initializer for the Windows VFD */
0024 #define H5FD_WINDOWS (H5FD_sec2_init())
0025
0026 #ifdef __cplusplus
0027 extern "C" {
0028 #endif /* __cplusplus */
0029
0030 /**
0031  * \ingroup FAPL
0032  *
0033  * \brief Sets the Windows I/O driver
0034  *
0035  * \fapl_id
0036  * \returns \herr_t
0037  *
0038  * \details H5Pset_fapl_windows() sets the default HDF5 Windows I/O driver on
0039  *          Windows systems.
0040  *
0041  *          Since the HDF5 library uses this driver, #H5FD_WINDOWS, by default
0042  *          on Windows systems, it is not normally necessary for a user
0043  *          application to call H5Pset_fapl_windows(). While it is not
0044  *          recommended, there may be times when a user chooses to set a
0045  *          different HDF5 driver, such as the standard I/O driver (#H5FD_STDIO)
0046  *          or the sec2 driver (#H5FD_SEC2), in a Windows
0047  *          application. H5Pset_fapl_windows() is provided so that the
0048  *          application can return to the Windows I/O driver when the time
0049  *          comes.
0050  *
0051  *          Only the Windows driver is tested on Windows systems; other drivers
0052  *          are used at the application's and the user's risk.
0053  *
0054  *          Furthermore, the Windows driver is tested and available only on
0055  *          Windows systems; it is not available on non-Windows systems.
0056  *
0057  * \since 1.8.0
0058  *
0059  */
0060 H5_DLL herr_t H5Pset_fapl_windows(hid_t fapl_id);
0061
0062 #ifdef __cplusplus
0063 }
0064 #endif /* __cplusplus */
0065
0066 #endif /* H5FDwindows_H */