blob: 9c8ad17da6ed96f4dc671b9c32de75d61324043b (
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
|
<!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_ros3_fapl_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.2908dd1</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__ros3__fapl__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_ros3_fapl_t Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include <src/H5FDros3.h></code></p>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Configuration structure for <a class="el" href="group___f_a_p_l.html#gaad28d8c24f236590193215c5ae7a8f18" title="Modifies the specified File Access Property List to use the H5FD_ROS3 driver.">H5Pset_fapl_ros3()</a> / <a class="el" href="group___f_a_p_l.html#ga13e273711e160cbd58e60c701b4f50e6" title="Queries a File Access Property List for H5FD_ROS3 file driver properties.">H5Pget_fapl_ros3()</a>. </p>
<p>H5FD_ros_fapl_t is a public structure that is used to pass configuration data to the <a class="el" href="_h5_f_dros3_8h.html#ace004a4771dcfd40a4c0adecc1974570">H5FD_ROS3</a> driver via a File Access Property List. A pointer to an instance of this structure is a parameter to <a class="el" href="group___f_a_p_l.html#gaad28d8c24f236590193215c5ae7a8f18" title="Modifies the specified File Access Property List to use the H5FD_ROS3 driver.">H5Pset_fapl_ros3()</a> and <a class="el" href="group___f_a_p_l.html#ga13e273711e160cbd58e60c701b4f50e6" title="Queries a File Access Property List for H5FD_ROS3 file driver properties.">H5Pget_fapl_ros3()</a>. </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:a67fae7dd1de9edce3656ed214d20377f" id="r_a67fae7dd1de9edce3656ed214d20377f"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#a67fae7dd1de9edce3656ed214d20377f">version</a></td></tr>
<tr class="separator:a67fae7dd1de9edce3656ed214d20377f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad254e1d0a91664a1114b0e83d703b294" id="r_ad254e1d0a91664a1114b0e83d703b294"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad254e1d0a91664a1114b0e83d703b294">authenticate</a></td></tr>
<tr class="separator:ad254e1d0a91664a1114b0e83d703b294"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0dbb76503aa108cb1245ccf5672ec5d0" id="r_a0dbb76503aa108cb1245ccf5672ec5d0"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0dbb76503aa108cb1245ccf5672ec5d0">aws_region</a> [32+1]</td></tr>
<tr class="separator:a0dbb76503aa108cb1245ccf5672ec5d0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7392390a71a76ec13126d1bf7e17c53c" id="r_a7392390a71a76ec13126d1bf7e17c53c"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7392390a71a76ec13126d1bf7e17c53c">secret_id</a> [128+1]</td></tr>
<tr class="separator:a7392390a71a76ec13126d1bf7e17c53c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8c4159cfc52c33923e5031dcdc3cacbb" id="r_a8c4159cfc52c33923e5031dcdc3cacbb"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8c4159cfc52c33923e5031dcdc3cacbb">secret_key</a> [128+1]</td></tr>
<tr class="separator:a8c4159cfc52c33923e5031dcdc3cacbb"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a id="ad254e1d0a91664a1114b0e83d703b294" name="ad254e1d0a91664a1114b0e83d703b294"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad254e1d0a91664a1114b0e83d703b294">◆ </a></span>authenticate</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> authenticate</td>
</tr>
</table>
</div><div class="memdoc">
<p>A Boolean which specifies if security credentials should be used for accessing a S3 bucket. </p>
</div>
</div>
<a id="a0dbb76503aa108cb1245ccf5672ec5d0" name="a0dbb76503aa108cb1245ccf5672ec5d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0dbb76503aa108cb1245ccf5672ec5d0">◆ </a></span>aws_region</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char aws_region[<a class="el" href="_h5_f_dros3_8h.html#aeaebf5218d3c900eb9a8d981f18a5bd6">H5FD_ROS3_MAX_REGION_LEN</a>+1]</td>
</tr>
</table>
</div><div class="memdoc">
<p>A string which specifies the AWS region of the S3 bucket. </p>
</div>
</div>
<a id="a7392390a71a76ec13126d1bf7e17c53c" name="a7392390a71a76ec13126d1bf7e17c53c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7392390a71a76ec13126d1bf7e17c53c">◆ </a></span>secret_id</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char secret_id[<a class="el" href="_h5_f_dros3_8h.html#a0dfcbaac69a09596185e619bc9f1c460">H5FD_ROS3_MAX_SECRET_ID_LEN</a>+1]</td>
</tr>
</table>
</div><div class="memdoc">
<p>A string which specifies the security ID. </p>
</div>
</div>
<a id="a8c4159cfc52c33923e5031dcdc3cacbb" name="a8c4159cfc52c33923e5031dcdc3cacbb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c4159cfc52c33923e5031dcdc3cacbb">◆ </a></span>secret_key</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char secret_key[<a class="el" href="_h5_f_dros3_8h.html#a6492f232f64a036290090e7cdf2f9161">H5FD_ROS3_MAX_SECRET_KEY_LEN</a>+1]</td>
</tr>
</table>
</div><div class="memdoc">
<p>A string which specifies the security key. </p>
</div>
</div>
<a id="a67fae7dd1de9edce3656ed214d20377f" name="a67fae7dd1de9edce3656ed214d20377f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67fae7dd1de9edce3656ed214d20377f">◆ </a></span>version</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t version</td>
</tr>
</table>
</div><div class="memdoc">
<p>Version number of the <a class="el" href="struct_h5_f_d__ros3__fapl__t.html" title="Configuration structure for H5Pset_fapl_ros3() / H5Pget_fapl_ros3().">H5FD_ros3_fapl_t</a> structure. Any instance passed to <a class="el" href="group___f_a_p_l.html#gaad28d8c24f236590193215c5ae7a8f18" title="Modifies the specified File Access Property List to use the H5FD_ROS3 driver.">H5Pset_fapl_ros3()</a> / <a class="el" href="group___f_a_p_l.html#ga13e273711e160cbd58e60c701b4f50e6" title="Queries a File Access Property List for H5FD_ROS3 file driver properties.">H5Pget_fapl_ros3()</a> must have a recognized version number or an error will be raised. Currently, this field should be set to <a class="el" href="_h5_f_dros3_8h.html#a0370e0bade82fd8ff6ac012644599fe2">H5FD_CURR_ROS3_FAPL_T_VERSION</a>. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/<a class="el" href="_h5_f_dros3_8h.html">H5FDros3.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__ros3__fapl__t.html">H5FD_ros3_fapl_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>
|
