diff options
author | lrknox <lrknox@users.noreply.github.com> | 2023-07-15 00:52:37 (GMT) |
---|---|---|
committer | lrknox <lrknox@users.noreply.github.com> | 2023-07-15 00:52:37 (GMT) |
commit | dbbdf602ceab06d34d31ef80472f390ff9c4fc89 (patch) | |
tree | f19dabb9e2577d0352b26ba556b780afef882ad6 /struct_h5_f_d__ros3__fapl__t.html | |
parent | 6f92b92ae2b55f1b741597a7459418d9fd723df4 (diff) | |
download | hdf5-dbbdf602ceab06d34d31ef80472f390ff9c4fc89.zip hdf5-dbbdf602ceab06d34d31ef80472f390ff9c4fc89.tar.gz hdf5-dbbdf602ceab06d34d31ef80472f390ff9c4fc89.tar.bz2 |
deploy: 305ac8886566968ae58ba771e0ae2ba6434ac9f0
Diffstat (limited to 'struct_h5_f_d__ros3__fapl__t.html')
-rw-r--r-- | struct_h5_f_d__ros3__fapl__t.html | 44 |
1 files changed, 26 insertions, 18 deletions
diff --git a/struct_h5_f_d__ros3__fapl__t.html b/struct_h5_f_d__ros3__fapl__t.html index 37a2e7d..7ab733b 100644 --- a/struct_h5_f_d__ros3__fapl__t.html +++ b/struct_h5_f_d__ros3__fapl__t.html @@ -37,7 +37,7 @@ <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.26059fc</span> +  <span id="projectnumber">1.15.0.305ac88</span> </div> <div id="projectbrief">API Reference</div> </td> @@ -107,19 +107,22 @@ $(document).ready(function(){initNavTree('struct_h5_f_d__ros3__fapl__t.html','') <div class="contents"> <p><code>#include <src/H5FDros3.h></code></p> -<table class="memberdecls"> +<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:a7378f9932dad7faf06da15d5d47a664e"><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#a7378f9932dad7faf06da15d5d47a664e">aws_region</a> [32+1]</td></tr> -<tr class="separator:a7378f9932dad7faf06da15d5d47a664e"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a30a5353319d0a23ebc0b347aff48544a"><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#a30a5353319d0a23ebc0b347aff48544a">secret_id</a> [128+1]</td></tr> -<tr class="separator:a30a5353319d0a23ebc0b347aff48544a"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ab622227877522d00a1284b9e5465d02c"><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#ab622227877522d00a1284b9e5465d02c">secret_key</a> [128+1]</td></tr> -<tr class="separator:ab622227877522d00a1284b9e5465d02c"><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> @@ -133,48 +136,52 @@ Data Fields</h2></td></tr> </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="a7378f9932dad7faf06da15d5d47a664e"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a7378f9932dad7faf06da15d5d47a664e">◆ </a></span>aws_region</h2> +<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[32+1]</td> + <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="a30a5353319d0a23ebc0b347aff48544a"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a30a5353319d0a23ebc0b347aff48544a">◆ </a></span>secret_id</h2> +<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[128+1]</td> + <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="ab622227877522d00a1284b9e5465d02c"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ab622227877522d00a1284b9e5465d02c">◆ </a></span>secret_key</h2> +<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[128+1]</td> + <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> @@ -189,6 +196,7 @@ Data Fields</h2></td></tr> </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> @@ -201,7 +209,7 @@ Data Fields</h2></td></tr> <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 on Fri Jul 14 2023 00:36:53 for HDF5 by + <li class="footer">Generated on Sat Jul 15 2023 00:37:59 for HDF5 by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.1 </li> </ul> |