diff options
| author | byrnHDF <byrnHDF@users.noreply.github.com> | 2023-06-26 19:22:17 (GMT) |
|---|---|---|
| committer | byrnHDF <byrnHDF@users.noreply.github.com> | 2023-06-26 19:22:17 (GMT) |
| commit | d12e43bc201e15edffcdf94fe820aeae6ab44882 (patch) | |
| tree | 90aa12006b20849b65b7bc8e3d4fe60a488f7247 /group___f_h5_e_s.html | |
| parent | 4d49d1ee001bd4dff6b01e1830902bee22a19f3e (diff) | |
| download | hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.zip hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.tar.gz hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.tar.bz2 | |
deploy: ab4d2aec9779b7a37747c95bd7b514417b299f73
Diffstat (limited to 'group___f_h5_e_s.html')
| -rw-r--r-- | group___f_h5_e_s.html | 657 |
1 files changed, 657 insertions, 0 deletions
diff --git a/group___f_h5_e_s.html b/group___f_h5_e_s.html new file mode 100644 index 0000000..9f6145a --- /dev/null +++ b/group___f_h5_e_s.html @@ -0,0 +1,657 @@ +<!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: Fortran Event Set (H5ES) Interface</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.ab4d2ae</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('group___f_h5_e_s.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="#func-members">Functions/Subroutines</a> | +<a href="#var-members">Variables</a> </div> + <div class="headertitle"> +<div class="title">Fortran Event Set (H5ES) Interface</div> </div> +</div><!--header--> +<div class="contents"> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_e_s.html" title="Event Set Interface.">Event Set Interface (H5ES)</a>, C-API</dd> +<dd> +<a class="el" href="_h5_e_s__u_g.html">The HDF5 Event Set</a>, User Guide </dd></dl> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions/Subroutines</h2></td></tr> +<tr class="memitem:ga6cf087a5ac8fae598400a370fe65722c"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_e_s.html#ga6cf087a5ac8fae598400a370fe65722c">h5escreate_f</a> (es_id, hdferr)</td></tr> +<tr class="memdesc:ga6cf087a5ac8fae598400a370fe65722c"><td class="mdescLeft"> </td><td class="mdescRight">Creates an event set. <a href="group___f_h5_e_s.html#ga6cf087a5ac8fae598400a370fe65722c">More...</a><br /></td></tr> +<tr class="separator:ga6cf087a5ac8fae598400a370fe65722c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf74dcbde57f25bfaa316239b89e196cc"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_e_s.html#gaf74dcbde57f25bfaa316239b89e196cc">h5esget_count_f</a> (es_id, count, hdferr)</td></tr> +<tr class="memdesc:gaf74dcbde57f25bfaa316239b89e196cc"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves number of events in an event set. <a href="group___f_h5_e_s.html#gaf74dcbde57f25bfaa316239b89e196cc">More...</a><br /></td></tr> +<tr class="separator:gaf74dcbde57f25bfaa316239b89e196cc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gabf27e4552fb7fbc574560a31fdde21b4"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_e_s.html#gabf27e4552fb7fbc574560a31fdde21b4">h5esget_op_counter_f</a> (es_id, counter, hdferr)</td></tr> +<tr class="memdesc:gabf27e4552fb7fbc574560a31fdde21b4"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the next operation counter to be assigned in an event set. <a href="group___f_h5_e_s.html#gabf27e4552fb7fbc574560a31fdde21b4">More...</a><br /></td></tr> +<tr class="separator:gabf27e4552fb7fbc574560a31fdde21b4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga4adf3ddb46d6aa43a0148a1c57def9a2"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_e_s.html#ga4adf3ddb46d6aa43a0148a1c57def9a2">h5eswait_f</a> (es_id, timeout, num_in_progress, err_occurred, hdferr)</td></tr> +<tr class="memdesc:ga4adf3ddb46d6aa43a0148a1c57def9a2"><td class="mdescLeft"> </td><td class="mdescRight">Waits for operations in event set to complete. <a href="group___f_h5_e_s.html#ga4adf3ddb46d6aa43a0148a1c57def9a2">More...</a><br /></td></tr> +<tr class="separator:ga4adf3ddb46d6aa43a0148a1c57def9a2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga13faca584fab2ea4e7f9180af56f6fd3"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_e_s.html#ga13faca584fab2ea4e7f9180af56f6fd3">h5escancel_f</a> (es_id, num_not_canceled, err_occurred, hdferr)</td></tr> +<tr class="memdesc:ga13faca584fab2ea4e7f9180af56f6fd3"><td class="mdescLeft"> </td><td class="mdescRight">Attempt to cancel operations in an event set. <a href="group___f_h5_e_s.html#ga13faca584fab2ea4e7f9180af56f6fd3">More...</a><br /></td></tr> +<tr class="separator:ga13faca584fab2ea4e7f9180af56f6fd3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad334ec8033d8dc9b57bc675d6b638686"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_e_s.html#gad334ec8033d8dc9b57bc675d6b638686">h5esget_err_status_f</a> (es_id, err_occurred, hdferr)</td></tr> +<tr class="memdesc:gad334ec8033d8dc9b57bc675d6b638686"><td class="mdescLeft"> </td><td class="mdescRight">Checks for failed operations. <a href="group___f_h5_e_s.html#gad334ec8033d8dc9b57bc675d6b638686">More...</a><br /></td></tr> +<tr class="separator:gad334ec8033d8dc9b57bc675d6b638686"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga8c8f8434524cbc3299213c3ae4468d43"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_e_s.html#ga8c8f8434524cbc3299213c3ae4468d43">h5esget_err_count_f</a> (es_id, num_errs, hdferr)</td></tr> +<tr class="memdesc:ga8c8f8434524cbc3299213c3ae4468d43"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the number of failed operations. <a href="group___f_h5_e_s.html#ga8c8f8434524cbc3299213c3ae4468d43">More...</a><br /></td></tr> +<tr class="separator:ga8c8f8434524cbc3299213c3ae4468d43"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga43d220592f6f8717c0dd83f16f1ce882"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_e_s.html#ga43d220592f6f8717c0dd83f16f1ce882">h5esclose_f</a> (es_id, hdferr)</td></tr> +<tr class="memdesc:ga43d220592f6f8717c0dd83f16f1ce882"><td class="mdescLeft"> </td><td class="mdescRight">Terminates access to an event set. <a href="group___f_h5_e_s.html#ga43d220592f6f8717c0dd83f16f1ce882">More...</a><br /></td></tr> +<tr class="separator:ga43d220592f6f8717c0dd83f16f1ce882"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a> +Variables</h2></td></tr> +<tr class="memitem:gad2d91c49747e1e49d87b931db19da7be"><td class="memItemLeft" align="right" valign="top">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>) </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_e_s.html#gad2d91c49747e1e49d87b931db19da7be">h5es_none_f</a></td></tr> +<tr class="memdesc:gad2d91c49747e1e49d87b931db19da7be"><td class="mdescLeft"> </td><td class="mdescRight">H5ES_NONE. <a href="group___f_h5_e_s.html#gad2d91c49747e1e49d87b931db19da7be">More...</a><br /></td></tr> +<tr class="separator:gad2d91c49747e1e49d87b931db19da7be"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga9e1525d9a6649719d46b9ff938aa8750"><td class="memItemLeft" align="right" valign="top">integer </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_e_s.html#ga9e1525d9a6649719d46b9ff938aa8750">h5es_status_in_progress_f</a></td></tr> +<tr class="memdesc:ga9e1525d9a6649719d46b9ff938aa8750"><td class="mdescLeft"> </td><td class="mdescRight">H5ES_STATUS_IN_PROGRESS. <a href="group___f_h5_e_s.html#ga9e1525d9a6649719d46b9ff938aa8750">More...</a><br /></td></tr> +<tr class="separator:ga9e1525d9a6649719d46b9ff938aa8750"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf7d7e05deb0b01d80166da1fe1998b14"><td class="memItemLeft" align="right" valign="top">integer </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_e_s.html#gaf7d7e05deb0b01d80166da1fe1998b14">h5es_status_succeed_f</a></td></tr> +<tr class="memdesc:gaf7d7e05deb0b01d80166da1fe1998b14"><td class="mdescLeft"> </td><td class="mdescRight">H5ES_STATUS_SUCCEED. <a href="group___f_h5_e_s.html#gaf7d7e05deb0b01d80166da1fe1998b14">More...</a><br /></td></tr> +<tr class="separator:gaf7d7e05deb0b01d80166da1fe1998b14"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac4e50e7771ec52e16e042eaf92a3e446"><td class="memItemLeft" align="right" valign="top">integer </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_e_s.html#gac4e50e7771ec52e16e042eaf92a3e446">h5es_status_canceled_f</a></td></tr> +<tr class="memdesc:gac4e50e7771ec52e16e042eaf92a3e446"><td class="mdescLeft"> </td><td class="mdescRight">H5ES_STATUS_CANCELED. <a href="group___f_h5_e_s.html#gac4e50e7771ec52e16e042eaf92a3e446">More...</a><br /></td></tr> +<tr class="separator:gac4e50e7771ec52e16e042eaf92a3e446"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga55c8630628cf58ef10c718583200170a"><td class="memItemLeft" align="right" valign="top">integer </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_e_s.html#ga55c8630628cf58ef10c718583200170a">h5es_status_fail_f</a></td></tr> +<tr class="memdesc:ga55c8630628cf58ef10c718583200170a"><td class="mdescLeft"> </td><td class="mdescRight">H5ES_STATUS_FAIL. <a href="group___f_h5_e_s.html#ga55c8630628cf58ef10c718583200170a">More...</a><br /></td></tr> +<tr class="separator:ga55c8630628cf58ef10c718583200170a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab5c96ecc63ca17f47eaaca615c68f16f"><td class="memItemLeft" align="right" valign="top">integer(c_int64_t) </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_e_s.html#gab5c96ecc63ca17f47eaaca615c68f16f">h5es_wait_forever_f</a></td></tr> +<tr class="memdesc:gab5c96ecc63ca17f47eaaca615c68f16f"><td class="mdescLeft"> </td><td class="mdescRight">H5ES_WAIT_FOREVER. <a href="group___f_h5_e_s.html#gab5c96ecc63ca17f47eaaca615c68f16f">More...</a><br /></td></tr> +<tr class="separator:gab5c96ecc63ca17f47eaaca615c68f16f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0846c695aadb2ee930e0b2170bd58b62"><td class="memItemLeft" align="right" valign="top">integer(c_int64_t) </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_e_s.html#ga0846c695aadb2ee930e0b2170bd58b62">h5es_wait_none_f</a></td></tr> +<tr class="memdesc:ga0846c695aadb2ee930e0b2170bd58b62"><td class="mdescLeft"> </td><td class="mdescRight">H5ES_WAIT_NONE. <a href="group___f_h5_e_s.html#ga0846c695aadb2ee930e0b2170bd58b62">More...</a><br /></td></tr> +<tr class="separator:ga0846c695aadb2ee930e0b2170bd58b62"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Function/Subroutine Documentation</h2> +<a id="ga13faca584fab2ea4e7f9180af56f6fd3"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga13faca584fab2ea4e7f9180af56f6fd3">◆ </a></span>h5escancel_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5es::h5escancel_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>es_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(size_t), intent(out) </td> + <td class="paramname"><em>num_not_canceled</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">logical, intent(out) </td> + <td class="paramname"><em>err_occurred</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Attempt to cancel operations in an event set. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">es_id</td><td>Event set identifier </td></tr> + <tr><td class="paramname">num_not_canceled</td><td>The number of events not canceled </td></tr> + <tr><td class="paramname">err_occurred</td><td>Status indicating if error is present in the event set </td></tr> + <tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_e_s.html#ga45ec0f886c4914f9503ab42e811a496a">H5EScancel()</a> </p> + +</div> +</div> +<a id="ga43d220592f6f8717c0dd83f16f1ce882"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga43d220592f6f8717c0dd83f16f1ce882">◆ </a></span>h5esclose_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5es::h5esclose_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>es_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Terminates access to an event set. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">es_id</td><td>Event set identifier </td></tr> + <tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_e_s.html#ga1159e2c6748f200857dffa55011ae060">H5ESclose()</a> </p> + +</div> +</div> +<a id="ga6cf087a5ac8fae598400a370fe65722c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga6cf087a5ac8fae598400a370fe65722c">◆ </a></span>h5escreate_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5es::h5escreate_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(out) </td> + <td class="paramname"><em>es_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Creates an event set. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">es_id</td><td>Event set identifier </td></tr> + <tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_e_s.html#gae3cd0a94586acf2d824033ef59fd3ccc">H5EScreate()</a> </p> + +</div> +</div> +<a id="gaf74dcbde57f25bfaa316239b89e196cc"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaf74dcbde57f25bfaa316239b89e196cc">◆ </a></span>h5esget_count_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5es::h5esget_count_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>es_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(size_t), intent(out) </td> + <td class="paramname"><em>count</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Retrieves number of events in an event set. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">es_id</td><td>Event set identifier </td></tr> + <tr><td class="paramname">count</td><td>The number of events in the event set </td></tr> + <tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_e_s.html#ga1a5a9212958bf7054a56107587d480d2">H5ESget_count()</a> </p> + +</div> +</div> +<a id="ga8c8f8434524cbc3299213c3ae4468d43"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga8c8f8434524cbc3299213c3ae4468d43">◆ </a></span>h5esget_err_count_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5es::h5esget_err_count_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>es_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(size_t), intent(out) </td> + <td class="paramname"><em>num_errs</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Retrieves the number of failed operations. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">es_id</td><td>Event set identifier </td></tr> + <tr><td class="paramname">num_errs</td><td>Number of errors </td></tr> + <tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_e_s.html#ga42b502d05e0dff40ec550c85bb54ca1c">H5ESget_err_count()</a> </p> + +</div> +</div> +<a id="gad334ec8033d8dc9b57bc675d6b638686"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gad334ec8033d8dc9b57bc675d6b638686">◆ </a></span>h5esget_err_status_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5es::h5esget_err_status_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>es_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">logical, intent(out) </td> + <td class="paramname"><em>err_occurred</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Checks for failed operations. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">es_id</td><td>Event set identifier </td></tr> + <tr><td class="paramname">err_occurred</td><td>Status indicating if error is present in the event set </td></tr> + <tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_e_s.html#gad419f0af15bbddc13d79662bc6b31d7c">H5ESget_err_status()</a> </p> + +</div> +</div> +<a id="gabf27e4552fb7fbc574560a31fdde21b4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gabf27e4552fb7fbc574560a31fdde21b4">◆ </a></span>h5esget_op_counter_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5es::h5esget_op_counter_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>es_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(c_int64_t), intent(out) </td> + <td class="paramname"><em>counter</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Retrieves the next operation counter to be assigned in an event set. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">es_id</td><td>Event set identifier </td></tr> + <tr><td class="paramname">counter</td><td>The number of events in the event set </td></tr> + <tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_e_s.html#ga1880fb2353f677ef56a6204706cec4d0">H5ESget_op_counter()</a> </p> + +</div> +</div> +<a id="ga4adf3ddb46d6aa43a0148a1c57def9a2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga4adf3ddb46d6aa43a0148a1c57def9a2">◆ </a></span>h5eswait_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5es::h5eswait_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>es_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(c_int64_t), intent(in) </td> + <td class="paramname"><em>timeout</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(size_t), intent(out) </td> + <td class="paramname"><em>num_in_progress</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">logical, intent(out) </td> + <td class="paramname"><em>err_occurred</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>hdferr</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Waits for operations in event set to complete. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">es_id</td><td>Event set identifier </td></tr> + <tr><td class="paramname">timeout</td><td>The number of events in the event set </td></tr> + <tr><td class="paramname">num_in_progress</td><td>The number of operations still in progress </td></tr> + <tr><td class="paramname">err_occurred</td><td>Flag if an operation in the event set failed </td></tr> + <tr><td class="paramname">hdferr</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_e_s.html#gab118d8202a0edf6241812420b870a64e">H5ESwait()</a> </p> + +</div> +</div> +<h2 class="groupheader">Variable Documentation</h2> +<a id="gad2d91c49747e1e49d87b931db19da7be"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gad2d91c49747e1e49d87b931db19da7be">◆ </a></span>h5es_none_f</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>) h5es_none_f</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>H5ES_NONE. </p> + +</div> +</div> +<a id="gac4e50e7771ec52e16e042eaf92a3e446"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gac4e50e7771ec52e16e042eaf92a3e446">◆ </a></span>h5es_status_canceled_f</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">integer h5es_status_canceled_f</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>H5ES_STATUS_CANCELED. </p> + +</div> +</div> +<a id="ga55c8630628cf58ef10c718583200170a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga55c8630628cf58ef10c718583200170a">◆ </a></span>h5es_status_fail_f</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">integer h5es_status_fail_f</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>H5ES_STATUS_FAIL. </p> + +</div> +</div> +<a id="ga9e1525d9a6649719d46b9ff938aa8750"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga9e1525d9a6649719d46b9ff938aa8750">◆ </a></span>h5es_status_in_progress_f</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">integer h5es_status_in_progress_f</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>H5ES_STATUS_IN_PROGRESS. </p> + +</div> +</div> +<a id="gaf7d7e05deb0b01d80166da1fe1998b14"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaf7d7e05deb0b01d80166da1fe1998b14">◆ </a></span>h5es_status_succeed_f</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">integer h5es_status_succeed_f</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>H5ES_STATUS_SUCCEED. </p> + +</div> +</div> +<a id="gab5c96ecc63ca17f47eaaca615c68f16f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gab5c96ecc63ca17f47eaaca615c68f16f">◆ </a></span>h5es_wait_forever_f</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">integer(c_int64_t) h5es_wait_forever_f</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>H5ES_WAIT_FOREVER. </p> + +</div> +</div> +<a id="ga0846c695aadb2ee930e0b2170bd58b62"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga0846c695aadb2ee930e0b2170bd58b62">◆ </a></span>h5es_wait_none_f</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">integer(c_int64_t) h5es_wait_none_f</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>H5ES_WAIT_NONE. </p> + +</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="footer">Generated on Mon Jun 26 2023 19:01:36 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> +</div> +</body> +</html> |