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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
|
<!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: src/H5FDonion.h File 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.fe5d0d5</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('_h5_f_donion_8h.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="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">H5FDonion.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_f_d__onion__fapl__info__t.html">H5FD_onion_fapl_info_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a1d6673897b4ebd1bad9846b5695ba346" id="r_a1d6673897b4ebd1bad9846b5695ba346"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1d6673897b4ebd1bad9846b5695ba346">H5FD_ONION</a>   (<a class="el" href="_h5_f_ddevelop_8h.html#a4df4d59c642c469f7a2c8934bfc84d60">H5FDperform_init</a>(H5FD_onion_init))</td></tr>
<tr class="separator:a1d6673897b4ebd1bad9846b5695ba346"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a45dad20deb25126398919c7d6e16ce9e" id="r_a45dad20deb25126398919c7d6e16ce9e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a45dad20deb25126398919c7d6e16ce9e">H5FD_ONION_VALUE</a>   <a class="el" href="_h5_f_dpublic_8h.html#ad0fbc20e7979087c577f8e50a4ebe121">H5_VFD_ONION</a></td></tr>
<tr class="separator:a45dad20deb25126398919c7d6e16ce9e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4562e4fe67ed2c5448e4145c44734420" id="r_a4562e4fe67ed2c5448e4145c44734420"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4562e4fe67ed2c5448e4145c44734420">H5FD_ONION_FAPL_INFO_VERSION_CURR</a>   1</td></tr>
<tr class="separator:a4562e4fe67ed2c5448e4145c44734420"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3d376561fd9da23647f9731f749fd68f" id="r_a3d376561fd9da23647f9731f749fd68f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3d376561fd9da23647f9731f749fd68f">H5FD_ONION_FAPL_INFO_CREATE_FLAG_ENABLE_PAGE_ALIGNMENT</a>    (0x0001u)</td></tr>
<tr class="separator:a3d376561fd9da23647f9731f749fd68f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a79df74491cceb74d43ca9e10d0be25ce" id="r_a79df74491cceb74d43ca9e10d0be25ce"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a79df74491cceb74d43ca9e10d0be25ce">H5FD_ONION_FAPL_INFO_COMMENT_MAX_LEN</a>   255</td></tr>
<tr class="separator:a79df74491cceb74d43ca9e10d0be25ce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3e252443bb7c90b2d05c0bb5f97891f0" id="r_a3e252443bb7c90b2d05c0bb5f97891f0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3e252443bb7c90b2d05c0bb5f97891f0">H5FD_ONION_FAPL_INFO_REVISION_ID_LATEST</a>   UINT64_MAX</td></tr>
<tr class="separator:a3e252443bb7c90b2d05c0bb5f97891f0"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:abbf57ea23523a7fceff6f1212bd68a6f" id="r_abbf57ea23523a7fceff6f1212bd68a6f"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="#abbf57ea23523a7fceff6f1212bd68a6f">H5FD_onion_target_file_constant_t</a> { <a class="el" href="#abbf57ea23523a7fceff6f1212bd68a6fa680be8b6ba69ed683e247e0bd5e2ed4a">H5FD_ONION_STORE_TARGET_ONION</a>
}</td></tr>
<tr class="separator:abbf57ea23523a7fceff6f1212bd68a6f"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga89b9f918d53dee5e6c80060667b8d32f" id="r_ga89b9f918d53dee5e6c80060667b8d32f"><td class="memItemLeft" align="right" valign="top">H5_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_a_p_l.html#ga89b9f918d53dee5e6c80060667b8d32f">H5Pget_fapl_onion</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fapl_id, <a class="el" href="struct_h5_f_d__onion__fapl__info__t.html">H5FD_onion_fapl_info_t</a> *fa_out)</td></tr>
<tr class="memdesc:ga89b9f918d53dee5e6c80060667b8d32f"><td class="mdescLeft"> </td><td class="mdescRight">get the onion info from the file access property list <br /></td></tr>
<tr class="separator:ga89b9f918d53dee5e6c80060667b8d32f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4d053c7682e54287e550113972b7dda6" id="r_ga4d053c7682e54287e550113972b7dda6"><td class="memItemLeft" align="right" valign="top">H5_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_a_p_l.html#ga4d053c7682e54287e550113972b7dda6">H5Pset_fapl_onion</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fapl_id, const <a class="el" href="struct_h5_f_d__onion__fapl__info__t.html">H5FD_onion_fapl_info_t</a> *fa)</td></tr>
<tr class="memdesc:ga4d053c7682e54287e550113972b7dda6"><td class="mdescLeft"> </td><td class="mdescRight">set the onion info for the file access property list <br /></td></tr>
<tr class="separator:ga4d053c7682e54287e550113972b7dda6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a132aba14546c0da4cc2e467ba4219715" id="r_a132aba14546c0da4cc2e467ba4219715"><td class="memItemLeft" align="right" valign="top">H5_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a132aba14546c0da4cc2e467ba4219715">H5FDonion_get_revision_count</a> (const char *filename, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fapl_id, uint64_t *revision_count)</td></tr>
<tr class="memdesc:a132aba14546c0da4cc2e467ba4219715"><td class="mdescLeft"> </td><td class="mdescRight">get the number of revisions <br /></td></tr>
<tr class="separator:a132aba14546c0da4cc2e467ba4219715"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a1d6673897b4ebd1bad9846b5695ba346" name="a1d6673897b4ebd1bad9846b5695ba346"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d6673897b4ebd1bad9846b5695ba346">◆ </a></span>H5FD_ONION</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5FD_ONION   (<a class="el" href="_h5_f_ddevelop_8h.html#a4df4d59c642c469f7a2c8934bfc84d60">H5FDperform_init</a>(H5FD_onion_init))</td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializer for the onion VFD </p>
</div>
</div>
<a id="a79df74491cceb74d43ca9e10d0be25ce" name="a79df74491cceb74d43ca9e10d0be25ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79df74491cceb74d43ca9e10d0be25ce">◆ </a></span>H5FD_ONION_FAPL_INFO_COMMENT_MAX_LEN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5FD_ONION_FAPL_INFO_COMMENT_MAX_LEN   255</td>
</tr>
</table>
</div><div class="memdoc">
<p>Max length of a comment. The buffer is defined to be this size + 1 to handle the NUL. </p>
</div>
</div>
<a id="a3d376561fd9da23647f9731f749fd68f" name="a3d376561fd9da23647f9731f749fd68f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d376561fd9da23647f9731f749fd68f">◆ </a></span>H5FD_ONION_FAPL_INFO_CREATE_FLAG_ENABLE_PAGE_ALIGNMENT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5FD_ONION_FAPL_INFO_CREATE_FLAG_ENABLE_PAGE_ALIGNMENT    (0x0001u)</td>
</tr>
</table>
</div><div class="memdoc">
<p>\ Onion history metadata will align to page_size. \ Partial pages of unused space will occur in the file, \ but may improve read performance from the backing store \ on some systems. \ If disabled (0), padding will not be inserted to align \ to page boundaries. \ </p>
</div>
</div>
<a id="a3e252443bb7c90b2d05c0bb5f97891f0" name="a3e252443bb7c90b2d05c0bb5f97891f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e252443bb7c90b2d05c0bb5f97891f0">◆ </a></span>H5FD_ONION_FAPL_INFO_REVISION_ID_LATEST</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5FD_ONION_FAPL_INFO_REVISION_ID_LATEST   UINT64_MAX</td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicates that you want the latest revision. </p>
</div>
</div>
<a id="a4562e4fe67ed2c5448e4145c44734420" name="a4562e4fe67ed2c5448e4145c44734420"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4562e4fe67ed2c5448e4145c44734420">◆ </a></span>H5FD_ONION_FAPL_INFO_VERSION_CURR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5FD_ONION_FAPL_INFO_VERSION_CURR   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Current version of the onion VFD fapl info struct </p>
</div>
</div>
<a id="a45dad20deb25126398919c7d6e16ce9e" name="a45dad20deb25126398919c7d6e16ce9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45dad20deb25126398919c7d6e16ce9e">◆ </a></span>H5FD_ONION_VALUE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5FD_ONION_VALUE   <a class="el" href="_h5_f_dpublic_8h.html#ad0fbc20e7979087c577f8e50a4ebe121">H5_VFD_ONION</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Identifier for the onion VFD </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="abbf57ea23523a7fceff6f1212bd68a6f" name="abbf57ea23523a7fceff6f1212bd68a6f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abbf57ea23523a7fceff6f1212bd68a6f">◆ </a></span>H5FD_onion_target_file_constant_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="#abbf57ea23523a7fceff6f1212bd68a6f">H5FD_onion_target_file_constant_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicates how the new onion data will be stored. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="abbf57ea23523a7fceff6f1212bd68a6fa680be8b6ba69ed683e247e0bd5e2ed4a" name="abbf57ea23523a7fceff6f1212bd68a6fa680be8b6ba69ed683e247e0bd5e2ed4a"></a>H5FD_ONION_STORE_TARGET_ONION </td><td class="fielddoc"><p>Onion history is stored in a single, separate "onion
file". Shares filename and path as <a class="el" href="namespacehdf5.html">hdf5</a> file (if any), with only a different filename extension. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a132aba14546c0da4cc2e467ba4219715" name="a132aba14546c0da4cc2e467ba4219715"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a132aba14546c0da4cc2e467ba4219715">◆ </a></span>H5FDonion_get_revision_count()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5FDonion_get_revision_count </td>
<td>(</td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>filename</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>fapl_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t *</td> <td class="paramname"><span class="paramname"><em>revision_count</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>get the number of revisions </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">filename</td><td>The name of the onion file </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">fapl_id</td><td>The ID of the file access property list </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">revision_count</td><td>The number of revisions</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#a132aba14546c0da4cc2e467ba4219715" title="get the number of revisions">H5FDonion_get_revision_count()</a> returns the number of revisions for an onion file. It takes the file name and file access property list that is set for the onion VFD driver.</p>
<dl class="section since"><dt>Since</dt><dd>1.14.0 </dd></dl>
</div>
</div>
</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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="_h5_f_donion_8h.html">H5FDonion.h</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>
|
