summaryrefslogtreecommitdiffstats
path: root/_l_b_props_list.html
diff options
context:
space:
mode:
authorbyrnHDF <byrnHDF@users.noreply.github.com>2023-06-26 19:22:17 (GMT)
committerbyrnHDF <byrnHDF@users.noreply.github.com>2023-06-26 19:22:17 (GMT)
commitd12e43bc201e15edffcdf94fe820aeae6ab44882 (patch)
tree90aa12006b20849b65b7bc8e3d4fe60a488f7247 /_l_b_props_list.html
parent4d49d1ee001bd4dff6b01e1830902bee22a19f3e (diff)
downloadhdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.zip
hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.tar.gz
hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.tar.bz2
deploy: ab4d2aec9779b7a37747c95bd7b514417b299f73
Diffstat (limited to '_l_b_props_list.html')
-rw-r--r--_l_b_props_list.html147
1 files changed, 147 insertions, 0 deletions
diff --git a/_l_b_props_list.html b/_l_b_props_list.html
new file mode 100644
index 0000000..02a9eb3
--- /dev/null
+++ b/_l_b_props_list.html
@@ -0,0 +1,147 @@
+<!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: Property Lists Basics</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&amp;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>
+ &#160;<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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
+$(document).ready(function(){initNavTree('_l_b_props_list.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="PageDoc"><div class="header">
+ <div class="headertitle">
+<div class="title">Property Lists Basics </div> </div>
+</div><!--header-->
+<div class="contents">
+<div class="textblock"><p>Navigate back: <a class="el" href="index.html">Main</a> / <a class="el" href="_getting_started.html">Getting Started with HDF5</a> / <a class="el" href="_learn_basics.html">Learning the Basics</a> </p><hr />
+<h1><a class="anchor" id="secLBPList"></a>
+What is a Property (or Property List)?</h1>
+<p>In HDF5, a property or property list is a characteristic or feature associated with an HDF5 object. There are default properties which handle the most common needs. These default properties are specified by passing in <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a> for the Property List parameter of a function. Default properties can be modified by use of the <a class="el" href="group___h5_p.html">Property Lists (H5P)</a> interface and function parameters.</p>
+<p>The <a class="el" href="group___h5_p.html">Property Lists (H5P)</a> API allows a user to take advantage of the more powerful features in HDF5. It typically supports unusual cases when creating or accessing HDF5 objects. There is a programming model for working with Property Lists in HDF5 (see below).</p>
+<p>For examples of modifying a property list, see these tutorial topics: </p><ul>
+<li><dl class="section see"><dt>See also</dt><dd><a class="el" href="_l_b_dset_layout.html">Dataset Storage Layout</a> </dd></dl>
+</li>
+<li><dl class="section see"><dt>See also</dt><dd><a class="el" href="_l_b_ext_dset.html">Extendible Datasets</a> </dd></dl>
+</li>
+<li><dl class="section see"><dt>See also</dt><dd><a class="el" href="_l_b_com_dset.html">Compressed Datasets</a></dd></dl>
+There are many Property Lists associated with creating and accessing objects in HDF5. See the <a class="el" href="group___h5_p.html">Property Lists (H5P)</a> Interface documentation in the HDF5 <a class="el" href="_r_m.html">HDF5 Reference Manual</a> for a list of the different properties associated with HDF5 interfaces.</li>
+</ul>
+<p>In summary: </p><ul>
+<li>Properties are features of HDF5 objects, that can be changed by use of the Property List API and function parameters. </li>
+<li>Property lists provide a mechanism for adding functionality to HDF5 calls without increasing the number of arguments used for a given call. </li>
+<li>The Property List API supports unusual cases when creating and accessing HDF5 objects.</li>
+</ul>
+<h1><a class="anchor" id="secLBPListProg"></a>
+Programming Model</h1>
+<p>Default properties are specified by simply passing in <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a> (C) / H5P_DEFAULT_F (F90) for the property list parameter in those functions for which properties can be changed.</p>
+<p>The programming model for changing a property list is as follows: </p><ul>
+<li>Create a copy or "instance" of the desired pre-defined property type, using the <a class="el" href="group___p_l_c_r.html#gaf1b11da01d4d45d788c45f8bc5f0cbfa" title="Creates a new property list as an instance of a property list class.">H5Pcreate</a> call. This will return a property list identifier. Please see the <a class="el" href="_r_m.html">HDF5 Reference Manual</a> entry for <a class="el" href="group___p_l_c_r.html#gaf1b11da01d4d45d788c45f8bc5f0cbfa" title="Creates a new property list as an instance of a property list class.">H5Pcreate</a>, for a comprehensive list of the property types. </li>
+<li>With the property list identifier, modify the property, using the <a class="el" href="group___h5_p.html">Property Lists (H5P)</a> APIs. </li>
+<li>Modify the object feature, by passing the property list identifier into the corresponding HDF5 object function. </li>
+<li>Close the property list when done, using <a class="el" href="group___p_l_c_r.html#ga5dce61149211d3ef319452aa598887fb" title="Terminates access to a property list.">H5Pclose</a>.</li>
+</ul>
+<hr />
+<p> Navigate back: <a class="el" href="index.html">Main</a> / <a class="el" href="_getting_started.html">Getting Started with HDF5</a> / <a class="el" href="_learn_basics.html">Learning the Basics</a> </p>
+</div></div><!-- contents -->
+</div><!-- PageDoc -->
+</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:33 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>
generated by cgit v0.12 at 2024-08-22 09:13:45 (GMT)