diff options
author | byrnHDF <byrnHDF@users.noreply.github.com> | 2023-11-16 13:49:28 (GMT) |
---|---|---|
committer | byrnHDF <byrnHDF@users.noreply.github.com> | 2023-11-16 13:49:28 (GMT) |
commit | 4f20d880c97be1249f8d89ced95f72836dbf3ee0 (patch) | |
tree | 30d8dcb282134b7126b092796f2be00d2d97bd3c /develop/struct_h5_f_d__ros3__fapl__t.html | |
parent | 4e7e457497c948b41c8b0065225875bf10cdf9d4 (diff) | |
download | hdf5-4f20d880c97be1249f8d89ced95f72836dbf3ee0.zip hdf5-4f20d880c97be1249f8d89ced95f72836dbf3ee0.tar.gz hdf5-4f20d880c97be1249f8d89ced95f72836dbf3ee0.tar.bz2 |
deploy: ef39882fa1e13740d2530c7a0637bd1f1a822b68
Diffstat (limited to 'develop/struct_h5_f_d__ros3__fapl__t.html')
-rw-r--r-- | develop/struct_h5_f_d__ros3__fapl__t.html | 218 |
1 files changed, 218 insertions, 0 deletions
diff --git a/develop/struct_h5_f_d__ros3__fapl__t.html b/develop/struct_h5_f_d__ros3__fapl__t.html new file mode 100644 index 0000000..c0e4743 --- /dev/null +++ b/develop/struct_h5_f_d__ros3__fapl__t.html @@ -0,0 +1,218 @@ +<!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.9.1"/> +<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> +<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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ + $(document).ready(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.ef39882</span> + </div> + <div id="projectbrief">API Reference</div> + </td> + <td> <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.svg" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="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.9.1 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(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"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</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 name="pub-attribs"></a> +Data Fields</h2></td></tr> +<tr class="memitem:a67fae7dd1de9edce3656ed214d20377f"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_f_d__ros3__fapl__t.html#a67fae7dd1de9edce3656ed214d20377f">version</a></td></tr> +<tr class="separator:a67fae7dd1de9edce3656ed214d20377f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem: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="struct_h5_f_d__ros3__fapl__t.html#ad254e1d0a91664a1114b0e83d703b294">authenticate</a></td></tr> +<tr class="separator:ad254e1d0a91664a1114b0e83d703b294"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0dbb76503aa108cb1245ccf5672ec5d0"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_f_d__ros3__fapl__t.html#a0dbb76503aa108cb1245ccf5672ec5d0">aws_region</a> [32+1]</td></tr> +<tr class="separator:a0dbb76503aa108cb1245ccf5672ec5d0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7392390a71a76ec13126d1bf7e17c53c"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_f_d__ros3__fapl__t.html#a7392390a71a76ec13126d1bf7e17c53c">secret_id</a> [128+1]</td></tr> +<tr class="separator:a7392390a71a76ec13126d1bf7e17c53c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8c4159cfc52c33923e5031dcdc3cacbb"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_f_d__ros3__fapl__t.html#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"></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"></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"></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"></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"></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.9.1 </li> + </ul> +</div> +</body> +</html> |