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 /struct_h5_f_d__file__image__callbacks__t.html | |
parent | 4d49d1ee001bd4dff6b01e1830902bee22a19f3e (diff) | |
download | hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.zip hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.tar.gz hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.tar.bz2 |
deploy: ab4d2aec9779b7a37747c95bd7b514417b299f73
Diffstat (limited to 'struct_h5_f_d__file__image__callbacks__t.html')
-rw-r--r-- | struct_h5_f_d__file__image__callbacks__t.html | 294 |
1 files changed, 294 insertions, 0 deletions
diff --git a/struct_h5_f_d__file__image__callbacks__t.html b/struct_h5_f_d__file__image__callbacks__t.html new file mode 100644 index 0000000..a11a713 --- /dev/null +++ b/struct_h5_f_d__file__image__callbacks__t.html @@ -0,0 +1,294 @@ +<!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_file_image_callbacks_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.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('struct_h5_f_d__file__image__callbacks__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_file_image_callbacks_t Struct Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <src/H5FDpublic.h></code></p> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Define structure to hold file image callbacks </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:afb936c7647c5704f666d779bbb73b645"><td class="memItemLeft" align="right" valign="top">void *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_f_d__file__image__callbacks__t.html#afb936c7647c5704f666d779bbb73b645">image_malloc</a> )(size_t size, <a class="el" href="_h5_f_dpublic_8h.html#aa95ee1806ea4db9f035cd53844c008dd">H5FD_file_image_op_t</a> file_image_op, void *<a class="el" href="struct_h5_f_d__file__image__callbacks__t.html#a697ce711b67313990d351b5c95f87aed">udata</a>)</td></tr> +<tr class="separator:afb936c7647c5704f666d779bbb73b645"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa1a0f08fab985cca0f9b871933e97c97"><td class="memItemLeft" align="right" valign="top">void *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_f_d__file__image__callbacks__t.html#aa1a0f08fab985cca0f9b871933e97c97">image_memcpy</a> )(void *dest, const void *src, size_t size, <a class="el" href="_h5_f_dpublic_8h.html#aa95ee1806ea4db9f035cd53844c008dd">H5FD_file_image_op_t</a> file_image_op, void *<a class="el" href="struct_h5_f_d__file__image__callbacks__t.html#a697ce711b67313990d351b5c95f87aed">udata</a>)</td></tr> +<tr class="separator:aa1a0f08fab985cca0f9b871933e97c97"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a16858b8fdd29678868e3c9294f19d5aa"><td class="memItemLeft" align="right" valign="top">void *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_f_d__file__image__callbacks__t.html#a16858b8fdd29678868e3c9294f19d5aa">image_realloc</a> )(void *ptr, size_t size, <a class="el" href="_h5_f_dpublic_8h.html#aa95ee1806ea4db9f035cd53844c008dd">H5FD_file_image_op_t</a> file_image_op, void *<a class="el" href="struct_h5_f_d__file__image__callbacks__t.html#a697ce711b67313990d351b5c95f87aed">udata</a>)</td></tr> +<tr class="separator:a16858b8fdd29678868e3c9294f19d5aa"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7e81e4662ea07b93e9380f5f78fee890"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_f_d__file__image__callbacks__t.html#a7e81e4662ea07b93e9380f5f78fee890">image_free</a> )(void *ptr, <a class="el" href="_h5_f_dpublic_8h.html#aa95ee1806ea4db9f035cd53844c008dd">H5FD_file_image_op_t</a> file_image_op, void *<a class="el" href="struct_h5_f_d__file__image__callbacks__t.html#a697ce711b67313990d351b5c95f87aed">udata</a>)</td></tr> +<tr class="separator:a7e81e4662ea07b93e9380f5f78fee890"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3a2f50d45f9f5342a36d14c1ae7d55f0"><td class="memItemLeft" align="right" valign="top">void *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_f_d__file__image__callbacks__t.html#a3a2f50d45f9f5342a36d14c1ae7d55f0">udata_copy</a> )(void *<a class="el" href="struct_h5_f_d__file__image__callbacks__t.html#a697ce711b67313990d351b5c95f87aed">udata</a>)</td></tr> +<tr class="separator:a3a2f50d45f9f5342a36d14c1ae7d55f0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a72907de159ae0b35408bbfe75f7c3359"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_f_d__file__image__callbacks__t.html#a72907de159ae0b35408bbfe75f7c3359">udata_free</a> )(void *<a class="el" href="struct_h5_f_d__file__image__callbacks__t.html#a697ce711b67313990d351b5c95f87aed">udata</a>)</td></tr> +<tr class="separator:a72907de159ae0b35408bbfe75f7c3359"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a697ce711b67313990d351b5c95f87aed"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_f_d__file__image__callbacks__t.html#a697ce711b67313990d351b5c95f87aed">udata</a></td></tr> +<tr class="memdesc:a697ce711b67313990d351b5c95f87aed"><td class="mdescLeft"> </td><td class="mdescRight">The final field in the <a class="el" href="struct_h5_f_d__file__image__callbacks__t.html">H5FD_file_image_callbacks_t</a> struct, provides a pointer to user-defined data. This pointer will be passed to the image_malloc, image_memcpy, image_realloc, and image_free callbacks. Define udata as NULL if no user-defined data is provided. <a href="struct_h5_f_d__file__image__callbacks__t.html#a697ce711b67313990d351b5c95f87aed">More...</a><br /></td></tr> +<tr class="separator:a697ce711b67313990d351b5c95f87aed"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Field Documentation</h2> +<a id="a7e81e4662ea07b93e9380f5f78fee890"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7e81e4662ea07b93e9380f5f78fee890">◆ </a></span>image_free</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>(* image_free) (void *ptr, <a class="el" href="_h5_f_dpublic_8h.html#aa95ee1806ea4db9f035cd53844c008dd">H5FD_file_image_op_t</a> file_image_op, void *<a class="el" href="struct_h5_f_d__file__image__callbacks__t.html#a697ce711b67313990d351b5c95f87aed">udata</a>)</td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">ptr</td><td>Pointer to the buffer being reallocated </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">file_image_op</td><td>A value from <a class="el" href="_h5_f_dpublic_8h.html#aa95ee1806ea4db9f035cd53844c008dd">H5FD_file_image_op_t</a> indicating the operation being performed on the file image when this callback is invoked </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">udata</td><td>Value passed in in the H5Pset_file_image_callbacks parameter <code>udata</code> </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="afb936c7647c5704f666d779bbb73b645"></a> +<h2 class="memtitle"><span class="permalink"><a href="#afb936c7647c5704f666d779bbb73b645">◆ </a></span>image_malloc</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void*(* image_malloc) (size_t size, <a class="el" href="_h5_f_dpublic_8h.html#aa95ee1806ea4db9f035cd53844c008dd">H5FD_file_image_op_t</a> file_image_op, void *<a class="el" href="struct_h5_f_d__file__image__callbacks__t.html#a697ce711b67313990d351b5c95f87aed">udata</a>)</td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Size in bytes of the file image buffer to allocate </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">file_image_op</td><td>A value from H5FD_file_image_op_t indicating the operation being performed on the file image when this callback is invoked </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">udata</td><td>Value passed in in the H5Pset_file_image_callbacks parameter <code>udata</code> </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="aa1a0f08fab985cca0f9b871933e97c97"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa1a0f08fab985cca0f9b871933e97c97">◆ </a></span>image_memcpy</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void*(* image_memcpy) (void *dest, const void *src, size_t size, <a class="el" href="_h5_f_dpublic_8h.html#aa95ee1806ea4db9f035cd53844c008dd">H5FD_file_image_op_t</a> file_image_op, void *<a class="el" href="struct_h5_f_d__file__image__callbacks__t.html#a697ce711b67313990d351b5c95f87aed">udata</a>)</td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">dest</td><td>Address of the destination buffer </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>Address of the source buffer </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Size in bytes of the file image buffer to allocate </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">file_image_op</td><td>A value from <a class="el" href="_h5_f_dpublic_8h.html#aa95ee1806ea4db9f035cd53844c008dd">H5FD_file_image_op_t</a> indicating the operation being performed on the file image when this callback is invoked </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">udata</td><td>Value passed in in the H5Pset_file_image_callbacks parameter <code>udata</code> </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="a16858b8fdd29678868e3c9294f19d5aa"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a16858b8fdd29678868e3c9294f19d5aa">◆ </a></span>image_realloc</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void*(* image_realloc) (void *ptr, size_t size, <a class="el" href="_h5_f_dpublic_8h.html#aa95ee1806ea4db9f035cd53844c008dd">H5FD_file_image_op_t</a> file_image_op, void *<a class="el" href="struct_h5_f_d__file__image__callbacks__t.html#a697ce711b67313990d351b5c95f87aed">udata</a>)</td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">ptr</td><td>Pointer to the buffer being reallocated </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Size in bytes of the file image buffer to allocate </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">file_image_op</td><td>A value from <a class="el" href="_h5_f_dpublic_8h.html#aa95ee1806ea4db9f035cd53844c008dd">H5FD_file_image_op_t</a> indicating the operation being performed on the file image when this callback is invoked </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">udata</td><td>Value passed in in the H5Pset_file_image_callbacks parameter <code>udata</code> </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="a697ce711b67313990d351b5c95f87aed"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a697ce711b67313990d351b5c95f87aed">◆ </a></span>udata</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void* udata</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>The final field in the <a class="el" href="struct_h5_f_d__file__image__callbacks__t.html">H5FD_file_image_callbacks_t</a> struct, provides a pointer to user-defined data. This pointer will be passed to the image_malloc, image_memcpy, image_realloc, and image_free callbacks. Define udata as NULL if no user-defined data is provided. </p> + +</div> +</div> +<a id="a3a2f50d45f9f5342a36d14c1ae7d55f0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a3a2f50d45f9f5342a36d14c1ae7d55f0">◆ </a></span>udata_copy</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void*(* udata_copy) (void *<a class="el" href="struct_h5_f_d__file__image__callbacks__t.html#a697ce711b67313990d351b5c95f87aed">udata</a>)</td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">udata</td><td>Value passed in in the H5Pset_file_image_callbacks parameter <code>udata</code> </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="a72907de159ae0b35408bbfe75f7c3359"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a72907de159ae0b35408bbfe75f7c3359">◆ </a></span>udata_free</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>(* udata_free) (void *<a class="el" href="struct_h5_f_d__file__image__callbacks__t.html#a697ce711b67313990d351b5c95f87aed">udata</a>)</td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">udata</td><td>Value passed in in the H5Pset_file_image_callbacks parameter <code>udata</code> </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<hr/>The documentation for this struct was generated from the following file:<ul> +<li>src/<a class="el" href="_h5_f_dpublic_8h.html">H5FDpublic.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__file__image__callbacks__t.html">H5FD_file_image_callbacks_t</a></li> + <li class="footer">Generated on Mon Jun 26 2023 19:01:39 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> |