1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by The HDF Group. *
* All rights reserved. *
* *
* This file is part of HDF5. The full HDF5 copyright notice, including *
* terms governing use, modification, and redistribution, is contained in *
* the COPYING file, which can be found at the root of the source code *
* distribution tree, or in https://www.hdfgroup.org/licenses. *
* If you do not have access to either file, you may request a copy from *
* help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*
* Programmer: Robb Matzke
* Monday, August 4, 1999
*
* Purpose: The public header file for the family driver.
*/
#ifndef H5FDfamily_H
#define H5FDfamily_H
#define H5FD_FAMILY (H5FDperform_init(H5FD_family_init))
#define H5FD_FAMILY_VALUE H5_VFD_FAMILY
#ifdef __cplusplus
extern "C" {
#endif
H5_DLL hid_t H5FD_family_init(void);
/**
* \ingroup FAPL
*
* \brief Sets the file access property list to use the family driver
*
* \fapl_id
* \param[in] memb_size Size in bytes of each file member
* \param[in] memb_fapl_id Identifier of file access property list for
* each family member
* \returns \herr_t
*
* \details H5Pset_fapl_family() sets the file access property list identifier,
* \p fapl_id, to use the family driver.
*
* \p memb_size is the size in bytes of each file member. This size
* will be saved in file when the property list \p fapl_id is used to
* create a new file. If \p fapl_id is used to open an existing file,
* \p memb_size has to be equal to the original size saved in file. A
* failure with an error message indicating the correct member size
* will be returned if \p memb_size does not match the size saved. If
* any user does not know the original size, #H5F_FAMILY_DEFAULT can be
* passed in. The library will retrieve the saved size.
*
* \p memb_fapl_id is the identifier of the file access property list
* to be used for each family member.
*
* \version 1.8.0 Behavior of the \p memb_size parameter was changed.
* \since 1.4.0
*
*/
H5_DLL herr_t H5Pset_fapl_family(hid_t fapl_id, hsize_t memb_size, hid_t memb_fapl_id);
/**
* \ingroup FAPL
*
* \brief Returns file access property list information
*
* \fapl_id
* \param[out] memb_size Size in bytes of each file member
* \param[out] memb_fapl_id Identifier of file access property list for
* each family member
* \returns \herr_t
*
* \details H5Pget_fapl_family() returns file access property list for use with
* the family driver. This information is returned through the output
* parameters.
*
* \since 1.4.0
*
*/
H5_DLL herr_t H5Pget_fapl_family(hid_t fapl_id, hsize_t *memb_size /*out*/, hid_t *memb_fapl_id /*out*/);
#ifdef __cplusplus
}
#endif
#endif
|
