blob: 65b6dffc1224c66e47839063b3f2176dc489d8d1 (
plain)
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>HDF5: H5FD_onion_fapl_info_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="hdf5doxy.css" rel="stylesheet" type="text/css">
<!-- <link href="hdf5doxy.css" rel="stylesheet" type="text/css"/>
-->
<script type="text/javascript" src="hdf5_navtree_hacks.js"></script>
</head>
<body>
<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Please, help us to better serve our user community by answering the following short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="https://www.hdfgroup.org">HDF5</a>
 <span id="projectnumber">1.15.0.68e8c0e</span>
</div>
<div id="projectbrief">API Reference</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function(){initNavTree('struct_h5_f_d__onion__fapl__info__t.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle"><div class="title">H5FD_onion_fapl_info_t Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include <src/H5FDonion.h></code></p>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Stores fapl information for creating onion VFD files. </p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:ab22abc2906422da61885ac6c8e6a1a59" id="r_ab22abc2906422da61885ac6c8e6a1a59"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab22abc2906422da61885ac6c8e6a1a59">version</a></td></tr>
<tr class="separator:ab22abc2906422da61885ac6c8e6a1a59"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6c910e4bf330a40b7ccd18af4b548f66" id="r_a6c910e4bf330a40b7ccd18af4b548f66"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6c910e4bf330a40b7ccd18af4b548f66">backing_fapl_id</a></td></tr>
<tr class="separator:a6c910e4bf330a40b7ccd18af4b548f66"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9dd3e47e968a8f6beb5d88c6d1b7ebe9" id="r_a9dd3e47e968a8f6beb5d88c6d1b7ebe9"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9dd3e47e968a8f6beb5d88c6d1b7ebe9">page_size</a></td></tr>
<tr class="separator:a9dd3e47e968a8f6beb5d88c6d1b7ebe9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a731ce24bd0a21911af9c49398980ba07" id="r_a731ce24bd0a21911af9c49398980ba07"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_f_donion_8h.html#abbf57ea23523a7fceff6f1212bd68a6f">H5FD_onion_target_file_constant_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a731ce24bd0a21911af9c49398980ba07">store_target</a></td></tr>
<tr class="separator:a731ce24bd0a21911af9c49398980ba07"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a71d7e6f4be381f6746d947c73ec4abd2" id="r_a71d7e6f4be381f6746d947c73ec4abd2"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#a71d7e6f4be381f6746d947c73ec4abd2">revision_num</a></td></tr>
<tr class="separator:a71d7e6f4be381f6746d947c73ec4abd2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a96025539df791d4ac3e79fc618be2121" id="r_a96025539df791d4ac3e79fc618be2121"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#a96025539df791d4ac3e79fc618be2121">force_write_open</a></td></tr>
<tr class="separator:a96025539df791d4ac3e79fc618be2121"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2c1423b2f9d50a462269f1314f64d88c" id="r_a2c1423b2f9d50a462269f1314f64d88c"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2c1423b2f9d50a462269f1314f64d88c">creation_flags</a></td></tr>
<tr class="separator:a2c1423b2f9d50a462269f1314f64d88c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab302133cac1883ca6e8b4240e0a49889" id="r_ab302133cac1883ca6e8b4240e0a49889"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab302133cac1883ca6e8b4240e0a49889">comment</a> [255+1]</td></tr>
<tr class="separator:ab302133cac1883ca6e8b4240e0a49889"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a id="a6c910e4bf330a40b7ccd18af4b548f66" name="a6c910e4bf330a40b7ccd18af4b548f66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c910e4bf330a40b7ccd18af4b548f66">◆ </a></span>backing_fapl_id</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> backing_fapl_id</td>
</tr>
</table>
</div><div class="memdoc">
<p>Backing or 'child' FAPL ID to handle I/O with the underlying backing store. It must use the same backing driver as the original file. </p>
</div>
</div>
<a id="ab302133cac1883ca6e8b4240e0a49889" name="ab302133cac1883ca6e8b4240e0a49889"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab302133cac1883ca6e8b4240e0a49889">◆ </a></span>comment</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char comment[255+ 1]</td>
</tr>
</table>
</div><div class="memdoc">
<p>User-supplied NULL-terminated comment for a revision to be written. Cannot be longer than H5FD_ONION_FAPL_COMMENT_MAX_LEN. Ignored if part of a FAPL used to open in read mode. </p>
</div>
</div>
<a id="a2c1423b2f9d50a462269f1314f64d88c" name="a2c1423b2f9d50a462269f1314f64d88c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c1423b2f9d50a462269f1314f64d88c">◆ </a></span>creation_flags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t creation_flags</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flag used only when instantiating an onion file. If the relevant bit is set to a nonzero value, its feature will be enabled. </p>
</div>
</div>
<a id="a96025539df791d4ac3e79fc618be2121" name="a96025539df791d4ac3e79fc618be2121"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a96025539df791d4ac3e79fc618be2121">◆ </a></span>force_write_open</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t force_write_open</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flag to ignore the write-lock flag in the onion data and attempt to open the file write-only anyway. This may be relevant if, for example, the library crashed while the file was open in write mode and the write-lock flag was not cleared. Must equal H5FD_ONION_FAPL_FLAG_FORCE_OPEN to enable. </p>
</div>
</div>
<a id="a9dd3e47e968a8f6beb5d88c6d1b7ebe9" name="a9dd3e47e968a8f6beb5d88c6d1b7ebe9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9dd3e47e968a8f6beb5d88c6d1b7ebe9">◆ </a></span>page_size</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t page_size</td>
</tr>
</table>
</div><div class="memdoc">
<p>page_size: Size of the amended data pages. If opening an existing file, must equal the existing page size or zero. If creating a new file or an initial revision of an existing file, must be a power of 2. </p>
</div>
</div>
<a id="a71d7e6f4be381f6746d947c73ec4abd2" name="a71d7e6f4be381f6746d947c73ec4abd2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71d7e6f4be381f6746d947c73ec4abd2">◆ </a></span>revision_num</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t revision_num</td>
</tr>
</table>
</div><div class="memdoc">
<p>Which revision to open. Valid values are 0 (the original file) or the revision number of an existing revision. H5FD_ONION_FAPL_INFO_REVISION_ID_LATEST refers to the most recently-created revision in the history. </p>
</div>
</div>
<a id="a731ce24bd0a21911af9c49398980ba07" name="a731ce24bd0a21911af9c49398980ba07"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a731ce24bd0a21911af9c49398980ba07">◆ </a></span>store_target</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_f_donion_8h.html#abbf57ea23523a7fceff6f1212bd68a6f">H5FD_onion_target_file_constant_t</a> store_target</td>
</tr>
</table>
</div><div class="memdoc">
<p>Identifies where the history data is stored. </p>
</div>
</div>
<a id="ab22abc2906422da61885ac6c8e6a1a59" name="ab22abc2906422da61885ac6c8e6a1a59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab22abc2906422da61885ac6c8e6a1a59">◆ </a></span>version</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t version</td>
</tr>
</table>
</div><div class="memdoc">
<p>Future-proofing identifier. Informs struct membership. Must equal H5FD_ONION_FAPL_VERSION_CURR to be considered valid. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/<a class="el" href="_h5_f_donion_8h.html">H5FDonion.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="struct_h5_f_d__onion__fapl__info__t.html">H5FD_onion_fapl_info_t</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.10.0 </li>
</ul>
</div>
</body>
</html>
|
