mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2025-02-23 16:20:57 +08:00
Code Issues Packages Projects Releases Wiki Activity
7a4d4b9aa2
hdf5/doc/html/RM_H5P.html

2427 lines
98 KiB
HTML
Raw Normal View History

[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<html>
<head><title>
[svn-r985] Checking in changes from "HDF5 Release 1.0" CVS branch that have not yet been checked into "HDF5 Development" branch. General ======= Various "copy edit" types of repairs. Revisions to document cross-linking. Added structural links tying all docs together (banners at top and bottom of documents, similar to Reference Manual banners of the Beta release). Set background color to white in all documents. NCSAfooterlogo.gif hdf2.jpg New image files to make the documents more self-contained (i.e., to prevent loading images from NCSA and HDF home servers). index.html Redesigned to isolate links external to the installation in a single location. Intro to HDF5 ============= H5.intro.html Fixed banner linking Intro to other docs. Set all URLs to be relative within the distribution; nothing points back to the HDF server. Updates to "Limits of the Current Release" and "Changes in the Current Release." HDF5 User's Guide ================= Changed several User Guide section titles such that all sections that are primarily about a particular interface are now titled in the format "The xxxxx Interface (H5x)". H5.user.html Commented out links to developer docs since they are marked in MANIFEST as not being for distribution in the release. Removed 2nd and 3rd indices from page. Changed "freeform" lists of sections (TOCs) to aligned tables. Datatypes.html Removed the sentence "I'm deferring definition until later since they're probably not as important as the other data types." from Section 3.3, "Properties of Date and Time Atomic Types." Added info regarding 'char' versus 'string' datatypes. Added as Section 3.7, "Character and String Datatype Issues." References.html Commented out substantial material (at end of document) from References planning document that is not appropriate for the User Guide but that is worth keeping around. Groups.html Final edits from elimination of "current working group." HDF5 Reference Manual ===================== Removed "Draft" from the <title>__</title> lines. RM_H5Front.html Removed 2nd and 3rd indices from page. Changed "freeform" lists of sections (TOCs) to aligned tables. RM_H5F.html RM_H5P.html Add file mounting information.
1998-12-22 06:52:56 +08:00
HDF5/H5P API Specification
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</title></head>
[svn-r985] Checking in changes from "HDF5 Release 1.0" CVS branch that have not yet been checked into "HDF5 Development" branch. General ======= Various "copy edit" types of repairs. Revisions to document cross-linking. Added structural links tying all docs together (banners at top and bottom of documents, similar to Reference Manual banners of the Beta release). Set background color to white in all documents. NCSAfooterlogo.gif hdf2.jpg New image files to make the documents more self-contained (i.e., to prevent loading images from NCSA and HDF home servers). index.html Redesigned to isolate links external to the installation in a single location. Intro to HDF5 ============= H5.intro.html Fixed banner linking Intro to other docs. Set all URLs to be relative within the distribution; nothing points back to the HDF server. Updates to "Limits of the Current Release" and "Changes in the Current Release." HDF5 User's Guide ================= Changed several User Guide section titles such that all sections that are primarily about a particular interface are now titled in the format "The xxxxx Interface (H5x)". H5.user.html Commented out links to developer docs since they are marked in MANIFEST as not being for distribution in the release. Removed 2nd and 3rd indices from page. Changed "freeform" lists of sections (TOCs) to aligned tables. Datatypes.html Removed the sentence "I'm deferring definition until later since they're probably not as important as the other data types." from Section 3.3, "Properties of Date and Time Atomic Types." Added info regarding 'char' versus 'string' datatypes. Added as Section 3.7, "Character and String Datatype Issues." References.html Commented out substantial material (at end of document) from References planning document that is not appropriate for the User Guide but that is worth keeping around. Groups.html Final edits from elimination of "current working group." HDF5 Reference Manual ===================== Removed "Draft" from the <title>__</title> lines. RM_H5Front.html Removed 2nd and 3rd indices from page. Changed "freeform" lists of sections (TOCs) to aligned tables. RM_H5F.html RM_H5P.html Add file mounting information.
1998-12-22 06:52:56 +08:00
<body bgcolor="#FFFFFF">
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<hr>
<center>
[svn-r985] Checking in changes from "HDF5 Release 1.0" CVS branch that have not yet been checked into "HDF5 Development" branch. General ======= Various "copy edit" types of repairs. Revisions to document cross-linking. Added structural links tying all docs together (banners at top and bottom of documents, similar to Reference Manual banners of the Beta release). Set background color to white in all documents. NCSAfooterlogo.gif hdf2.jpg New image files to make the documents more self-contained (i.e., to prevent loading images from NCSA and HDF home servers). index.html Redesigned to isolate links external to the installation in a single location. Intro to HDF5 ============= H5.intro.html Fixed banner linking Intro to other docs. Set all URLs to be relative within the distribution; nothing points back to the HDF server. Updates to "Limits of the Current Release" and "Changes in the Current Release." HDF5 User's Guide ================= Changed several User Guide section titles such that all sections that are primarily about a particular interface are now titled in the format "The xxxxx Interface (H5x)". H5.user.html Commented out links to developer docs since they are marked in MANIFEST as not being for distribution in the release. Removed 2nd and 3rd indices from page. Changed "freeform" lists of sections (TOCs) to aligned tables. Datatypes.html Removed the sentence "I'm deferring definition until later since they're probably not as important as the other data types." from Section 3.3, "Properties of Date and Time Atomic Types." Added info regarding 'char' versus 'string' datatypes. Added as Section 3.7, "Character and String Datatype Issues." References.html Commented out substantial material (at end of document) from References planning document that is not appropriate for the User Guide but that is worth keeping around. Groups.html Final edits from elimination of "current working group." HDF5 Reference Manual ===================== Removed "Draft" from the <title>__</title> lines. RM_H5Front.html Removed 2nd and 3rd indices from page. Changed "freeform" lists of sections (TOCs) to aligned tables. RM_H5F.html RM_H5P.html Add file mounting information.
1998-12-22 06:52:56 +08:00
<table border=0 width=98%>
<tr><td valign=top align=left>
<a href="H5.intro.html">Introduction to HDF5</a>&nbsp;<br>
<a href="H5.user.html">HDF5 User Guide</a>&nbsp;<br>
<a href="index.html">Other HDF5 documents and links</a>&nbsp;<br>
<!--
<a href="Glossary.html">Glossary</a><br>
-->
</td>
<td valign=top align=right>
And in this document, the
<a href="RM_H5Front.html">HDF5 Reference Manual</a>&nbsp;&nbsp;
<br>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<a href="RM_H5.html">H5</a>&nbsp;&nbsp;
<a href="RM_H5A.html">H5A</a>&nbsp;&nbsp;
<a href="RM_H5D.html">H5D</a>&nbsp;&nbsp;
<a href="RM_H5E.html">H5E</a>&nbsp;&nbsp;
<a href="RM_H5F.html">H5F</a>&nbsp;&nbsp;
<a href="RM_H5G.html">H5G</a>&nbsp;&nbsp;
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<a href="RM_H5I.html">H5I</a>&nbsp;&nbsp;
[svn-r985] Checking in changes from "HDF5 Release 1.0" CVS branch that have not yet been checked into "HDF5 Development" branch. General ======= Various "copy edit" types of repairs. Revisions to document cross-linking. Added structural links tying all docs together (banners at top and bottom of documents, similar to Reference Manual banners of the Beta release). Set background color to white in all documents. NCSAfooterlogo.gif hdf2.jpg New image files to make the documents more self-contained (i.e., to prevent loading images from NCSA and HDF home servers). index.html Redesigned to isolate links external to the installation in a single location. Intro to HDF5 ============= H5.intro.html Fixed banner linking Intro to other docs. Set all URLs to be relative within the distribution; nothing points back to the HDF server. Updates to "Limits of the Current Release" and "Changes in the Current Release." HDF5 User's Guide ================= Changed several User Guide section titles such that all sections that are primarily about a particular interface are now titled in the format "The xxxxx Interface (H5x)". H5.user.html Commented out links to developer docs since they are marked in MANIFEST as not being for distribution in the release. Removed 2nd and 3rd indices from page. Changed "freeform" lists of sections (TOCs) to aligned tables. Datatypes.html Removed the sentence "I'm deferring definition until later since they're probably not as important as the other data types." from Section 3.3, "Properties of Date and Time Atomic Types." Added info regarding 'char' versus 'string' datatypes. Added as Section 3.7, "Character and String Datatype Issues." References.html Commented out substantial material (at end of document) from References planning document that is not appropriate for the User Guide but that is worth keeping around. Groups.html Final edits from elimination of "current working group." HDF5 Reference Manual ===================== Removed "Draft" from the <title>__</title> lines. RM_H5Front.html Removed 2nd and 3rd indices from page. Changed "freeform" lists of sections (TOCs) to aligned tables. RM_H5F.html RM_H5P.html Add file mounting information.
1998-12-22 06:52:56 +08:00
<br>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
H5P&nbsp;&nbsp;
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<a href="RM_H5R.html">H5R</a>&nbsp;&nbsp;
<a href="RM_H5RA.html">H5RA</a>&nbsp;&nbsp;
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<a href="RM_H5S.html">H5S</a>&nbsp;&nbsp;
<a href="RM_H5T.html">H5T</a>&nbsp;&nbsp;
<a href="RM_H5Z.html">H5Z</a>&nbsp;&nbsp;
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
<a href="Tools.html">Tools</a>&nbsp;&nbsp;
[svn-r985] Checking in changes from "HDF5 Release 1.0" CVS branch that have not yet been checked into "HDF5 Development" branch. General ======= Various "copy edit" types of repairs. Revisions to document cross-linking. Added structural links tying all docs together (banners at top and bottom of documents, similar to Reference Manual banners of the Beta release). Set background color to white in all documents. NCSAfooterlogo.gif hdf2.jpg New image files to make the documents more self-contained (i.e., to prevent loading images from NCSA and HDF home servers). index.html Redesigned to isolate links external to the installation in a single location. Intro to HDF5 ============= H5.intro.html Fixed banner linking Intro to other docs. Set all URLs to be relative within the distribution; nothing points back to the HDF server. Updates to "Limits of the Current Release" and "Changes in the Current Release." HDF5 User's Guide ================= Changed several User Guide section titles such that all sections that are primarily about a particular interface are now titled in the format "The xxxxx Interface (H5x)". H5.user.html Commented out links to developer docs since they are marked in MANIFEST as not being for distribution in the release. Removed 2nd and 3rd indices from page. Changed "freeform" lists of sections (TOCs) to aligned tables. Datatypes.html Removed the sentence "I'm deferring definition until later since they're probably not as important as the other data types." from Section 3.3, "Properties of Date and Time Atomic Types." Added info regarding 'char' versus 'string' datatypes. Added as Section 3.7, "Character and String Datatype Issues." References.html Commented out substantial material (at end of document) from References planning document that is not appropriate for the User Guide but that is worth keeping around. Groups.html Final edits from elimination of "current working group." HDF5 Reference Manual ===================== Removed "Draft" from the <title>__</title> lines. RM_H5Front.html Removed 2nd and 3rd indices from page. Changed "freeform" lists of sections (TOCs) to aligned tables. RM_H5F.html RM_H5P.html Add file mounting information.
1998-12-22 06:52:56 +08:00
</td></tr>
</table>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</center>
<hr>
[svn-r985] Checking in changes from "HDF5 Release 1.0" CVS branch that have not yet been checked into "HDF5 Development" branch. General ======= Various "copy edit" types of repairs. Revisions to document cross-linking. Added structural links tying all docs together (banners at top and bottom of documents, similar to Reference Manual banners of the Beta release). Set background color to white in all documents. NCSAfooterlogo.gif hdf2.jpg New image files to make the documents more self-contained (i.e., to prevent loading images from NCSA and HDF home servers). index.html Redesigned to isolate links external to the installation in a single location. Intro to HDF5 ============= H5.intro.html Fixed banner linking Intro to other docs. Set all URLs to be relative within the distribution; nothing points back to the HDF server. Updates to "Limits of the Current Release" and "Changes in the Current Release." HDF5 User's Guide ================= Changed several User Guide section titles such that all sections that are primarily about a particular interface are now titled in the format "The xxxxx Interface (H5x)". H5.user.html Commented out links to developer docs since they are marked in MANIFEST as not being for distribution in the release. Removed 2nd and 3rd indices from page. Changed "freeform" lists of sections (TOCs) to aligned tables. Datatypes.html Removed the sentence "I'm deferring definition until later since they're probably not as important as the other data types." from Section 3.3, "Properties of Date and Time Atomic Types." Added info regarding 'char' versus 'string' datatypes. Added as Section 3.7, "Character and String Datatype Issues." References.html Commented out substantial material (at end of document) from References planning document that is not appropriate for the User Guide but that is worth keeping around. Groups.html Final edits from elimination of "current working group." HDF5 Reference Manual ===================== Removed "Draft" from the <title>__</title> lines. RM_H5Front.html Removed 2nd and 3rd indices from page. Changed "freeform" lists of sections (TOCs) to aligned tables. RM_H5F.html RM_H5P.html Add file mounting information.
1998-12-22 06:52:56 +08:00
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<center>
<h1>H5P: Property List Interface</h1>
</center>
<h2>Property List API Functions</h2>
These functions manipulate property list objects to allow objects which require
many different parameters to be easily manipulated.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<p>
<strong>The C Interfaces:</strong>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<table border=0>
<tr><td valign=top>
<i>General Property List Operations</i>
<ul>
<li><a href="#Property-Create">H5Pcreate</a>
<li><a href="#Property-GetClass">H5Pget_class</a>
<li><a href="#Property-Copy">H5Pcopy</a>
<li><a href="#Property-Close">H5Pclose</a>
</ul>
<p><i>File Creation Properties</i>
<ul>
<li><a href="#Property-GetVersion">H5Pget_version</a>
<li><a href="#Property-SetUserblock">H5Pset_userblock</a>
<li><a href="#Property-GetUserblock">H5Pget_userblock</a>
<li><a href="#Property-SetSizes">H5Pset_sizes</a>
<li><a href="#Property-GetSizes">H5Pget_sizes</a>
<li><a href="#Property-SetSymK">H5Pset_sym_k</a>
<li><a href="#Property-GetSymK">H5Pget_sym_k</a>
<li><a href="#Property-SetIstoreK">H5Pset_istore_k</a>
<li><a href="#Property-GetIstoreK">H5Pget_istore_k</a>
</ul>
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<p><i>Variable-length Datatype Properties</i>
<ul>
<li><a href="#Property-SetVLMemManager">H5Pset_vlen_mem_manager</a>
<li><a href="#Property-GetVLMemManager">H5Pget_vlen_mem_manager</a>
</ul>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td valign=top>
<i>File Access Properties</i>
<ul>
[svn-r2760] Purpose: Removing functions that have been removed from library. Solution: Removed H5Pget_driver, H5P[gs]et_stdio, H5P[gs]et_sec2, H5P[gs]et_core, H5P[gs]et_split, H5P[gs]et_family, H5P[gs]et_mpi, and H5P[gs]et_xfer. Platforms tested: IE5
2000-11-01 00:04:29 +08:00
<li><a href="#Property-xxx">xxx</a>
<li><a href="#Property-xxx">xxx</a>
<li><a href="#Property-xxx">xxx</a>
<li><a href="#Property-xxx">xxx</a>
<li><a href="#Property-xxx">xxx</a>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<li><a href="#Property-SetAlignment">H5Pset_alignment</a>
<li><a href="#Property-GetAlignment">H5Pget_alignment</a>
[svn-r2760] Purpose: Removing functions that have been removed from library. Solution: Removed H5Pget_driver, H5P[gs]et_stdio, H5P[gs]et_sec2, H5P[gs]et_core, H5P[gs]et_split, H5P[gs]et_family, H5P[gs]et_mpi, and H5P[gs]et_xfer. Platforms tested: IE5
2000-11-01 00:04:29 +08:00
<li><a href="#Property-xxx">xxx</a>
<li><a href="#Property-xxx">xxx</a>
<li><a href="#Property-xxx">xxx</a>&nbsp;&nbsp;&nbsp;||
<li><a href="#Property-xxx">xxx</a>&nbsp;&nbsp;&nbsp;||
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
<!-- Not implemented. Probably never will be.
[svn-r2760] Purpose: Removing functions that have been removed from library. Solution: Removed H5Pget_driver, H5P[gs]et_stdio, H5P[gs]et_sec2, H5P[gs]et_core, H5P[gs]et_split, H5P[gs]et_family, H5P[gs]et_mpi, and H5P[gs]et_xfer. Platforms tested: IE5
2000-11-01 00:04:29 +08:00
<li><a href="#Property-xxx">xxx</a>
<li><a href="#Property-xxx">xxx</a>
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<li><a href="#Property-SetCache">H5Pset_cache</a>
<li><a href="#Property-GetCache">H5Pget_cache</a>
[svn-r2760] Purpose: Removing functions that have been removed from library. Solution: Removed H5Pget_driver, H5P[gs]et_stdio, H5P[gs]et_sec2, H5P[gs]et_core, H5P[gs]et_split, H5P[gs]et_family, H5P[gs]et_mpi, and H5P[gs]et_xfer. Platforms tested: IE5
2000-11-01 00:04:29 +08:00
<li><a href="#Property-xxx">xxx</a>
<li><a href="#Property-xxx">xxx</a>
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<li><a href="#Property-SetGCReferences">H5Pset_gc_references</a>
<li><a href="#Property-GetGCReferences">H5Pget_gc_references</a>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</ul>
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
<br>&nbsp;
<br>&nbsp;
<br>&nbsp;
<br>&nbsp;
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<br>&nbsp;
<br>&nbsp;
<br>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
||&nbsp;&nbsp;<i>Available only in the parallel HDF5 library.</i>
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td valign=top>
<i>Dataset Creation Properties</i>
<ul>
<li><a href="#Property-SetLayout">H5Pset_layout</a>
<li><a href="#Property-GetLayout">H5Pget_layout</a>
<li><a href="#Property-SetChunk">H5Pset_chunk</a>
<li><a href="#Property-GetChunk">H5Pget_chunk</a>
<li><a href="#Property-SetDeflate">H5Pset_deflate</a>
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
<!--
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<li><a href="#Property-GetDeflate">H5Pget_deflate</a>
<li><a href="#Property-SetCompression">H5Pset_compression</a>
<li><a href="#Property-GetCompression">H5Pget_compression</a>
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
-->
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<li><a href="#Property-SetFillValue">H5Pset_fill_value</a>
<li><a href="#Property-GetFillValue">H5Pget_fill_value</a>
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
<li><a href="#Property-SetFilter">H5Pset_filter</a>
<li><a href="#Property-GetNFilters">H5Pget_nfilters</a>
<li><a href="#Property-GetFilter">H5Pget_filter</a>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<li><a href="#Property-SetExternal">H5Pset_external</a>
<li><a href="#Property-GetExternalCount">H5Pget_external_count</a>
<li><a href="#Property-GetExternal">H5Pget_external</a>
</ul>
<p><i>Dataset Memory and Transfer Properties</i>
<ul>
<li><a href="#Property-SetBuffer">H5Pset_buffer</a>
<li><a href="#Property-GetBuffer">H5Pget_buffer</a>
<li><a href="#Property-SetPreserve">H5Pset_preserve</a>
<li><a href="#Property-GetPreserve">H5Pget_preserve</a>
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<li><a href="#Property-SetHyperCache">H5Pset_hyper_cache</a>
<li><a href="#Property-GetHyperCache">H5Pget_hyper_cache</a>
<li><a href="#Property-SetBTreeRatios">H5Pset_btree_ratios</a>
<li><a href="#Property-GetBTreeRatios">H5Pget_btree_ratios</a>
[svn-r2760] Purpose: Removing functions that have been removed from library. Solution: Removed H5Pget_driver, H5P[gs]et_stdio, H5P[gs]et_sec2, H5P[gs]et_core, H5P[gs]et_split, H5P[gs]et_family, H5P[gs]et_mpi, and H5P[gs]et_xfer. Platforms tested: IE5
2000-11-01 00:04:29 +08:00
<li><a href="#Property-xxx">xxx</a>&nbsp;&nbsp;&nbsp;||
<li><a href="#Property-xxx">xxx</a>&nbsp;&nbsp;&nbsp;||
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</ul>
</td></tr>
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<!--
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<tr><td colspan=5 align=right>
<br>
||&nbsp;&nbsp;&nbsp;<i>Available only in the parallel HDF5 library.</i>
</td></tr>
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</table>
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<p>
<strong>The FORTRAN90 Interfaces:</strong>
<br>
<font size=-1>
<i>In general, each FORTRAN90 subroutine performs exactly the same task
as the corresponding C function. The links below go to the C function
descriptions, which serve as general descriptions for both. A button,
under <strong>Non-C API(s)</strong> at the end of the C function description,
opens an external browser window displaying the FORTRAN90-specific
information. You will probably want to adjust the size and location of
this external window so that both browser windows are visible and to
facilitate moving easily between them.</i>
</font>
<table border=0>
<tr><td valign=top>
<i>General Property List Operations</i>
<ul>
<li><a href="#Property-Create">h5pcreate_f</a>
<li><a href="#Property-GetClass">h5pget_class_f</a>
<li><a href="#Property-Copy">h5pcopy_f</a>
<li><a href="#Property-Close">h5pclose_f</a>
</ul>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<p><i>File Creation Properties</i>
<ul>
<li><a href="#Property-GetVersion">h5pget_version_f</a>
<li><a href="#Property-SetUserblock">h5pset_userblock_f</a>
<li><a href="#Property-GetUserblock">h5pget_userblock_f</a>
<li><a href="#Property-SetSizes">h5pset_sizes_f</a>
<li><a href="#Property-GetSizes">h5pget_sizes_f</a>
<li><a href="#Property-SetSymK">h5pset_sym_k_f</a>
<li><a href="#Property-GetSymK">h5pget_sym_k_f</a>
<li><a href="#Property-SetIstoreK">h5pset_istore_k_f</a>
<li><a href="#Property-GetIstoreK">h5pget_istore_k_f</a>
</ul>
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<!--<p><i>Variable-length Datatype Properties</i> -->
<!--<ul> -->
<!--<li><a href="#Property-SetVLMemManager">h5pset_vlen_mem_manager_f</a> -->
<!--<li><a href="#Property-GetVLMemManager">h5pget_vlen_mem_manager_f</a> -->
<!--</ul> -->
</td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td valign=top>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<i>File Access Properties</i>
<ul>
<li><a href="#Property-GetDriver">h5pget_driver_f</a>
<li><a href="#Property-SetStdio">h5pset_stdio_f</a>
<li><a href="#Property-GetStdio">h5pget_stdio_f</a>
<li><a href="#Property-SetSec2">h5pset_sec2_f</a>
<li><a href="#Property-GetSec2">h5pget_sec2_f</a>
<li><a href="#Property-SetAlignment">h5pset_alignment_f</a>
<li><a href="#Property-GetAlignment">h5pget_alignment_f</a>
<li><a href="#Property-SetCore">h5pset_core_f</a>
<li><a href="#Property-GetCore">h5pget_core_f</a>
<li><a href="#Property-SetMPI">h5pset_mpi_f</a>&nbsp;&nbsp;&nbsp;||
<li><a href="#Property-GetMPI">h5pget_mpi_f</a>&nbsp;&nbsp;&nbsp;||
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<!--<li><a href="#Property-SetFamily">h5pset_family_f</a> -->
<!--<li><a href="#Property-GetFamily">h5pget_family_f</a> -->
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<li><a href="#Property-SetCache">h5pset_cache_f</a>
<li><a href="#Property-GetCache">h5pget_cache_f</a>
<li><a href="#Property-SetSplit">h5pset_split_f</a>
<li><a href="#Property-GetSplit">h5pget_split_f</a>
<li><a href="#Property-SetGCReferences">h5pset_gc_references_f</a>
<li><a href="#Property-GetGCReferences">h5pget_gc_references_f</a>
</ul>
<!--
<br>&nbsp;
<br>&nbsp;
<br>&nbsp;
<br>&nbsp;
<br>&nbsp;
-->
<br>&nbsp;
<br>
||&nbsp;&nbsp;<i>Available only in the parallel HDF5 library.</i>
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
</td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td valign=top>
<i>Dataset Creation Properties</i>
<ul>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<li><a href="#Property-SetLayout">h5pset_layout_f</a>
<li><a href="#Property-GetLayout">h5pget_layout_f</a>
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<li><a href="#Property-SetChunk">h5pset_chunk_f</a>
<li><a href="#Property-GetChunk">h5pget_chunk_f</a>
<li><a href="#Property-SetDeflate">h5pset_deflate_f</a>
<!--<li><a href="#Property-GetDeflate">h5pget_deflate_f</a> -->
<!--<li><a href="#Property-SetCompression">h5pset_compression_f</a> -->
<!--<li><a href="#Property-GetCompression">h5pget_compression_f</a> -->
<li><a href="#Property-SetFillValue">h5pset_fill_value_f</a>
<li><a href="#Property-GetFillValue">h5pget_fill_value_f</a>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<li><a href="#Property-SetFilter">h5pset_filter_f</a>
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<!--<li><a href="#Property-GetNFilters">h5pget_nfilters_f</a> -->
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<li><a href="#Property-GetFilter">h5pget_filter_f</a>
<li><a href="#Property-SetExternal">h5pset_external_f</a>
<li><a href="#Property-GetExternalCount">h5pget_external_count_f</a>
<li><a href="#Property-GetExternal">h5pget_external_f</a>
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
</ul>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<p><i>Dataset Memory and Transfer Properties</i>
<ul>
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<!--<li><a href="#Property-SetBuffer">h5pset_buffer_f</a> -->
<!--<li><a href="#Property-GetBuffer">h5pget_buffer_f</a> -->
<!--<li><a href="#Property-SetPreserve">h5pset_preserve_f</a> -->
<!--<li><a href="#Property-GetPreserve">h5pget_preserve_f</a> -->
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<li><a href="#Property-SetHyperCache">h5pset_hyper_cache_f</a>
<li><a href="#Property-GetHyperCache">h5pget_hyper_cache_f</a>
<li><a href="#Property-SetBTreeRatios">h5pset_btree_ratios_f</a>
<li><a href="#Property-GetBTreeRatios">h5pget_btree_ratios_f</a>
<li><a href="#Property-SetXfer">h5pset_xfer_f</a>&nbsp;&nbsp;&nbsp;||
<li><a href="#Property-GetXfer">h5pget_xfer_f</a>&nbsp;&nbsp;&nbsp;||
</ul>
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
</td></tr>
</table>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-Create">H5Pcreate</a>
<dt><strong>Signature:</strong>
<dd><em>hid_t </em><code>H5Pcreate</code>(<em>H5P_class_t</em> <code>type</code>
)
<dt><strong>Purpose:</strong>
<dd>Creates a new property as an instance of a property list class.
<dt><strong>Description:</strong>
<dd><code>H5Pcreate</code> creates a new property as an instance of some
property list class. The new property list is initialized
with default values for the specified class. The classes are:
<dl>
<dt><code>H5P_FILE_CREATE</code>
<dd>Properties for file creation.
See <a href="Files.html">Files</a>
in the <cite>HDF User's Guide</cite>
for details about the file creation properties.
<dt><code>H5P_FILE_ACCESS</code>
<dd>Properties for file access.
See <a href="Files.html">Files</a>
in the <cite>HDF User's Guide</cite>
for details about the file creation properties.
<dt><code>H5P_DATASET_CREATE</code>
<dd>Properties for dataset creation.
See <a href="Datasets.html">Datasets</a>
in the <cite>HDF User's Guide</cite>
for details about dataset creation properties.
<dt><code>H5P_DATASET_XFER</code>
<dd>Properties for raw data transfer.
See <a href="Datasets.html">Datasets</a>
in the <cite>HDF User's Guide</cite>
for details about raw data transfer properties.
[svn-r985] Checking in changes from "HDF5 Release 1.0" CVS branch that have not yet been checked into "HDF5 Development" branch. General ======= Various "copy edit" types of repairs. Revisions to document cross-linking. Added structural links tying all docs together (banners at top and bottom of documents, similar to Reference Manual banners of the Beta release). Set background color to white in all documents. NCSAfooterlogo.gif hdf2.jpg New image files to make the documents more self-contained (i.e., to prevent loading images from NCSA and HDF home servers). index.html Redesigned to isolate links external to the installation in a single location. Intro to HDF5 ============= H5.intro.html Fixed banner linking Intro to other docs. Set all URLs to be relative within the distribution; nothing points back to the HDF server. Updates to "Limits of the Current Release" and "Changes in the Current Release." HDF5 User's Guide ================= Changed several User Guide section titles such that all sections that are primarily about a particular interface are now titled in the format "The xxxxx Interface (H5x)". H5.user.html Commented out links to developer docs since they are marked in MANIFEST as not being for distribution in the release. Removed 2nd and 3rd indices from page. Changed "freeform" lists of sections (TOCs) to aligned tables. Datatypes.html Removed the sentence "I'm deferring definition until later since they're probably not as important as the other data types." from Section 3.3, "Properties of Date and Time Atomic Types." Added info regarding 'char' versus 'string' datatypes. Added as Section 3.7, "Character and String Datatype Issues." References.html Commented out substantial material (at end of document) from References planning document that is not appropriate for the User Guide but that is worth keeping around. Groups.html Final edits from elimination of "current working group." HDF5 Reference Manual ===================== Removed "Draft" from the <title>__</title> lines. RM_H5Front.html Removed 2nd and 3rd indices from page. Changed "freeform" lists of sections (TOCs) to aligned tables. RM_H5F.html RM_H5P.html Add file mounting information.
1998-12-22 06:52:56 +08:00
<dt><code>H5P_MOUNT</code>
<dd>Properties for file mounting.
With this parameter, <code>H5Pcreate</code>
creates and returns a new mount property list
initialized with default values.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<dt><strong>Parameters:</strong>
<dl>
<dt><em>H5P_class_t</em> <code>type</code>
<dd>IN: The type of property list to create.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a property list identifier (<code>plist</code>) if successful;
otherwise Fail (-1).
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pcreate_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-Close">H5Pclose</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t </em><code>H5Pclose</code>(<em>hid_t</em> <code>plist</code>
)
<dt><strong>Purpose:</strong>
<dd>Terminates access to a property list.
<dt><strong>Description:</strong>
<dd><code>H5Pclose</code> terminates access to a property list.
All property lists should be closed when the application is
finished accessing them.
This frees resources used by the property list.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of the property list to terminate access to.
</dl>
<dt><strong>Returns:</strong>
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pclose_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetClass">H5Pget_class</a>
<dt><strong>Signature:</strong>
<dd><em>H5P_class_t </em><code>H5Pget_class</code>(<em>hid_t</em> <code>plist</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns the property list class for a property list.
<dt><strong>Description:</strong>
<dd><code>H5Pget_class</code> returns the property list class for the
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
property list identified by the <code>plist</code> parameter.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
Valid property list classes are defined in the description of
<code>H5Pcreate()</code>.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of property list to query.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a property list class if successful.
Otherwise returns H5P_NO_CLASS (-1).
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_class_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-Copy">H5Pcopy</a>
<dt><strong>Signature:</strong>
<dd><em>hid_t </em><code>H5Pcopy</code>(<em>hid_t</em> <code>plist</code>
)
<dt><strong>Purpose:</strong>
<dd>Copies an existing property list to create a new property list.
<dt><strong>Description:</strong>
<dd><code>H5Pcopy</code> copies an existing property list to create
a new property list.
The new property list has the same properties and values
as the original property list.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of property list to duplicate.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a property list identifier if successful;
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pcopy_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetVersion">H5Pget_version</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t </em><code>H5Pget_version</code>(<em>hid_t</em> <code>plist</code>,
[svn-r2002] Changed 'boot block' to 'super block'.
2000-03-09 06:03:11 +08:00
<em>int *</em> <code>super</code>,
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<em>int *</em> <code>freelist</code>,
<em>int *</em> <code>stab</code>,
<em>int *</em> <code>shhdr</code>
)
<dt><strong>Purpose:</strong>
<dd>Retrieves the version information of various objects for
a file creation property list.
<dt><strong>Description:</strong>
<dd><code>H5Pget_version</code> retrieves the version information of various objects
for a file creation property list. Any pointer parameters which are
passed as NULL are not queried.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of the file creation property list.
[svn-r2002] Changed 'boot block' to 'super block'.
2000-03-09 06:03:11 +08:00
<dt><em>int *</em> <code>super</code>
<dd>OUT: Pointer to location to return super block version number.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><em>int *</em> <code>freelist</code>
<dd>OUT: Pointer to location to return global freelist version number.
<dt><em>int *</em> <code>stab</code>
<dd>OUT: Pointer to location to return symbol table version number.
<dt><em>int *</em> <code>shhdr</code>
<dd>OUT: Pointer to location to return shared object header version number.
</dl>
<dt><strong>Returns:</strong>
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_version_f"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<!--
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetUserblock">H5Pset_userblock</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t </em><code>H5Pset_userblock</code>(<em>hid_t</em> <code>plist</code>,
<em>hsize_t</em> <code>size</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets user block size.
<dt><strong>Description:</strong>
<dd><code>H5Pset_userblock</code> sets the user block size of a
file creation property list.
The default user block size is 0; it may be set to any
power of 2 equal to 512 or greater (512, 1024, 2048, etc.).
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of property list to modify.
<dt><em>hsize_t</em> <code>size</code>
<dd>IN: Size of the user-block in bytes.
</dl>
<dt><strong>Returns:</strong>
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_userblock_f"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<!--
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetUserblock">H5Pget_userblock</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t </em><code>H5Pget_userblock</code>(<em>hid_t</em> <code>plist</code>,
<em>hsize_t *</em> <code>size</code>
)
<dt><strong>Purpose:</strong>
<dd>Retrieves the size of a user block.
<dt><strong>Description:</strong>
<dd><code>H5Pget_userblock</code> retrieves the size of a user block
in a file creation property list.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for property list to query.
<dt><em>hsize_t *</em> <code>size</code>
<dd>OUT: Pointer to location to return user-block size.
</dl>
<dt><strong>Returns:</strong>
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_userblock_f"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<!--
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetSizes">H5Pset_sizes</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t </em><code>H5Pset_sizes</code>(<em>hid_t</em> <code>plist</code>,
<em>size_t</em> <code>sizeof_addr</code>,
<em>size_t</em> <code>sizeof_size</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets the byte size of the offsets and lengths used to address objects
in an HDF5 file.
<dt><strong>Description:</strong>
<dd><code>H5Pset_sizes</code> sets the byte size of the offsets and lengths used to
address objects in an HDF5 file. This function is only valid for
file creation property lists. Passing in a value of 0 for one of the
sizeof parameters retains the current value. The default value
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
for both values is 4 bytes. Valid values currently are 2, 4, 8 and
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
16.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of property list to modify.
<dt><em>size_t</em> <code>sizeof_addr</code>
<dd>IN: Size of an object offset in bytes.
<dt><em>size_t</em> <code>sizeof_size</code>
<dd>IN: Size of an object length in bytes.
</dl>
<dt><strong>Returns:</strong>
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_sizes_f"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<!--
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetSizes">H5Pget_sizes</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t </em><code>H5Pget_sizes</code>(<em>hid_t</em> <code>plist</code>,
<em>size_t *</em> <code>sizeof_addr</code>,
<em>size_t *</em> <code>sizeof_size</code>
)
<dt><strong>Purpose:</strong>
<dd>Retrieves the size of the offsets and lengths used in an HDF5 file.
<dt><strong>Description:</strong>
<dd><code>H5Pget_sizes</code> retrieves the size of the offsets
and lengths used in an HDF5 file.
This function is only valid for file creation property lists.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of property list to query.
<dt><em>size_t *</em> <code>size</code>
<dd>OUT: Pointer to location to return offset size in bytes.
<dt><em>size_t *</em> <code>size</code>
<dd>OUT: Pointer to location to return length size in bytes.
</dl>
<dt><strong>Returns:</strong>
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_sizes_f"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<!--
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetSymK">H5Pset_sym_k</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t </em><code>H5Pset_sym_k</code>(<em>hid_t</em> <code>plist</code>,
<em>int</em> <code>ik</code>,
<em>int</em> <code>lk</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets the size of parameters used to control the symbol table nodes.
<dt><strong>Description:</strong>
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
<dd><code>H5Pset_sym_k</code> sets the size of parameters used to
control the symbol table nodes. This function is only valid
for file creation property lists. Passing in a value of 0 for
one of the parameters retains the current value.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<p>
<code>ik</code> is one half the rank of a tree that stores a symbol
table for a group. Internal nodes of the symbol table are on
average 75% full. That is, the average rank of the tree is
1.5 times the value of <code>ik</code>.
<p>
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
<code>lk</code> is one half of the number of symbols that can
be stored in a symbol table node. A symbol table node is the
leaf of a symbol table tree which is used to store a group.
When symbols are inserted randomly into a group, the group's
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
symbol table nodes are 75% full on average. That is, they
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
contain 1.5 times the number of symbols specified by
<code>lk</code>.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for property list to query.
<dt><em>int</em> <code>ik</code>
<dd>IN: Symbol table tree rank.
<dt><em>int</em> <code>lk</code>
<dd>IN: Symbol table node size.
</dl>
<dt><strong>Returns:</strong>
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_sym_k_f"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<!--
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetSymK">H5Pget_sym_k</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t </em><code>H5Pget_sym_k</code>(<em>hid_t</em> <code>plist</code>,
<em>int *</em> <code>ik</code>,
<em>int *</em> <code>lk</code>
)
<dt><strong>Purpose:</strong>
<dd>Retrieves the size of the symbol table B-tree 1/2 rank
and the symbol table leaf node 1/2 size.
<dt><strong>Description:</strong>
<dd><code>H5Pget_sym_k</code> retrieves the size of the
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
symbol table B-tree 1/2 rank and the symbol table leaf
node 1/2 size. This function is only valid for file creation
property lists. If a parameter valued is set to NULL, that
parameter is not retrieved. See the description for
<a href="#Property-SetSymK">H5Pset_sym_k</a> for more
information.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Property list to query.
<dt><em>int *</em> <code>ik</code>
<dd>OUT: Pointer to location to return the symbol table's B-tree 1/2 rank.
<dt><em>int *</em> <code>size</code>
<dd>OUT: Pointer to location to return the symbol table's leaf node 1/2 size.
</dl>
<dt><strong>Returns:</strong>
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_sym_k_f"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<!--
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetIstoreK">H5Pset_istore_k</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t </em><code>H5Pset_istore_k</code>(<em>hid_t</em> <code>plist</code>,
<em>int</em> <code>ik</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets the size of the parameter used to control the
B-trees for indexing chunked datasets.
<dt><strong>Description:</strong>
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
<dd><code>H5Pset_istore_k</code> sets the size of the parameter
used to control the B-trees for indexing chunked datasets.
This function is only valid for file creation property lists.
Passing in a value of 0 for one of the parameters retains
the current value.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<p>
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
<code>ik</code> is one half the rank of a tree that stores
chunked raw data. On average, such a tree will be 75% full,
or have an average rank of 1.5 times the value of
<code>ik</code>.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of property list to query.
<dt><em>int</em> <code>ik</code>
<dd>IN: 1/2 rank of chunked storage B-tree.
</dl>
<dt><strong>Returns:</strong>
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_istore_k_f"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<!--
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetIstoreK">H5Pget_istore_k</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t </em><code>H5Pget_istore_k</code>(<em>hid_t</em> <code>plist</code>,
<em>int *</em> <code>ik</code>
)
<dt><strong>Purpose:</strong>
<dd>Queries the 1/2 rank of an indexed storage B-tree.
<dt><strong>Description:</strong>
<dd><code>H5Pget_istore_k</code> queries the 1/2 rank of
an indexed storage B-tree.
The argument <code>ik</code> may be the null pointer (NULL).
This function is only valid for file creation property lists.
<p>
See <a href="#Property-SetIstoreK">H5Pset_istore_k</a> for details.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of property list to query.
<dt><em>int *</em> <code>ik</code>
<dd>OUT: Pointer to location to return the chunked storage B-tree 1/2 rank.
</dl>
<dt><strong>Returns:</strong>
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_istore_k_f"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<!--
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetLayout">H5Pset_layout</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t </em><code>H5Pset_layout</code>(<em>hid_t</em> <code>plist</code>,
<em>H5D_layout_t</em> <code>layout</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets the type of storage used store the raw data for a dataset.
<dt><strong>Description:</strong>
<dd><code>H5Pset_layout</code> sets the type of storage used store the
raw data for a dataset.
This function is only valid for dataset creation property lists.
Valid parameters for <code>layout</code> are:
<ul><dl>
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt>H5D_COMPACT &nbsp;&nbsp; <i><b>(Not yet implemented.)</b></i>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dd>Store raw data and object header contiguously in file.
This should only be used for very small amounts of raw
data (suggested less than 1KB).
<dt>H5D_CONTIGUOUS
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<dd>Store raw data separately from object header in one
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
large chunk in the file.
<dt>H5D_CHUNKED
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<dd>Store raw data separately from object header in one
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
large chunk in the file and store chunks of the raw
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
data in separate locations in the file.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl></ul>
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of property list to query.
<dt><em>H5D_layout_t</em> <code>layout</code>
<dd>IN: Type of storage layout for raw data.
</dl>
<dt><strong>Returns:</strong>
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_layout_f"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<!--
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetLayout">H5Pget_layout</a>
<dt><strong>Signature:</strong>
<dd><em>H5D_layout_t</em> <code>H5Pget_layout</code>(<em>hid_t</em> <code>plist</code>)
<dt><strong>Purpose:</strong>
<dd>Returns the layout of the raw data for a dataset.
<dt><strong>Description:</strong>
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
<dd><code>H5Pget_layout</code> returns the layout of the raw data for
a dataset. This function is only valid for dataset creation
property lists. Valid types for <code>layout</code> are:
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<ul> <dl>
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt>H5D_COMPACT &nbsp;&nbsp; <i><b>(Not yet implemented.)</b></i>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dd>Raw data and object header stored contiguously in file.
<dt>H5D_CONTIGUOUS
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<dd>Raw data stored separately from object header in one
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
large chunk in the file.
<dt>H5D_CHUNKED
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<dd>Raw data stored separately from object header in
chunks in separate locations in the file.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl> </ul>
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for property list to query.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns the layout type of a a dataset creation property list
if successful.
Otherwise returns H5D_LAYOUT_ERROR (-1).
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_layout_f"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<!--
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetChunk">H5Pset_chunk</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t </em><code>H5Pset_chunk</code>(<em>hid_t</em> <code>plist</code>,
<em>int</em> <code>ndims</code>,
<em>const hsize_t *</em> <code>dim</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets the size of the chunks used to store a chunked layout dataset.
<dt><strong>Description:</strong>
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
<dd><code>H5Pset_chunk</code> sets the size of the chunks used to
store a chunked layout dataset. This function is only valid
for dataset creation property lists.
The <code>ndims</code> parameter currently must be the same size
as the rank of the dataset. The values of the <code>dim</code>
array define the size of the chunks to store the dataset's raw data.
As a side-effect, the layout of the dataset is changed to
<code>H5D_CHUNKED</code>, if it is not already.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for property list to query.
<dt><em>int</em> <code>ndims</code>
<dd>IN: The number of dimensions of each chunk.
<dt><em>const hsize_t *</em> <code>dim</code>
<dd>IN: An array containing the size of each chunk.
</dl>
<dt><strong>Returns:</strong>
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_chunk_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetChunk">H5Pget_chunk</a>
<dt><strong>Signature:</strong>
<dd><em>int </em><code>H5Pget_chunk</code>(<em>hid_t</em> <code>plist</code>,
<em>int</em> <code>max_ndims</code>,
<em>hsize_t *</em> <code>dims</code>
)
<dt><strong>Purpose:</strong>
<dd>Retrieves the size of chunks for the raw data of a chunked layout dataset.
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Description:</strong>
<dd><code>H5Pget_chunk</code> retrieves the size of chunks for the
raw data of a chunked layout dataset.
This function is only valid for dataset creation property lists.
At most, <code>max_ndims</code> elements of <code>dims</code>
will be initialized.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of property list to query.
<dt><em>int</em> <code>max_ndims</code>
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
<dd>IN: Size of the <code>dims</code> array.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><em>hsize_t *</em> <code>dims</code>
<dd>OUT: Array to store the chunk dimensions.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns chunk dimensionality successful;
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_chunk_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetAlignment">H5Pset_alignment</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_alignment</code>(<em>hid_t</em> <code>plist</code>,
<em>hsize_t</em> <code>threshold</code>,
<em>hsize_t</em> <code>alignment</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets alignment properties of a file access property list.
<dt><strong>Description:</strong>
<dd><code>H5Pset_alignment</code> sets the alignment properties
of a file access property list
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
so that any file object greater than or equal in size to
<code>threshold</code> bytes will be aligned on an address
which is a multiple of <code>alignment</code>. The addresses
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
are relative to the end of the user block; the alignment is
calculated by subtracting the user block size from the
absolute file address and then adjusting the address to be a
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
multiple of <code>alignment</code>.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<p>
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
Default values for <code>threshold</code> and
<code>alignment</code> are one, implying
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
no alignment. Generally the default values will result in
the best performance for single-process access to the file.
For MPI-IO and other parallel systems, choose an alignment
which is a multiple of the disk block size.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for a file access property list.
<dt><em>hsize_t</em> <code>threshold</code>
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
<dd>IN: Threshold value.
Must be non-negative.
Note that setting the threshold value to 0 (zero) has
the effect of a special case, forcing everything
to be aligned.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><em>hsize_t</em> <code>alignment</code>
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
<dd>IN: Alignment value.
Must be a positive value.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<dt><strong>Returns:</strong>
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_alignment_f"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<!--
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetAlignment">H5Pget_alignment</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pget_alignment</code>(<em>hid_t</em> <code>plist</code>,
<em>hsize_t</em> <code>*threshold</code>,
<em>hsize_t</em> <code>*alignment</code>
)
<dt><strong>Purpose:</strong>
<dd>Retrieves the current settings for alignment properties from a
file access property list.
<dt><strong>Description:</strong>
<dd><code>H5Pget_alignment</code> retrieves the current settings for
alignment properties from a file access property list.
The <code>threshold</code> and/or <code>alignment</code> pointers
may be null pointers (NULL).
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of a file access property list.
<dt><em>hsize_t</em> <code>*threshold</code>
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<dd>OUT: Pointer to location of return threshold value.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><em>hsize_t</em> <code>*alignment</code>
<dd>OUT: Pointer to location of return alignment value.
</dl>
<dt><strong>Returns:</strong>
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_alignment_f"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<!--
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetExternal">H5Pset_external</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_external</code>(<em>hid_t</em> <code>plist</code>,
<em>const char</em> <code>*name</code>,
<em>off_t</em> <code>offset</code>,
<em>hsize_t</em> <code>size</code>
)
<dt><strong>Purpose:</strong>
<dd>Adds an external file to the list of external files.
<dt><strong>Description:</strong>
<dd><code>H5Pset_external</code> adds an external file to the
list of external files.
<p>
If a dataset is split across multiple files then the files
should be defined in order. The total size of the dataset is
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
the sum of the <code>size</code> arguments for all the external files. If
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
the total size is larger than the size of a dataset then the
dataset can be extended (provided the data space also allows
the extending).
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<p>
The <code>size</code> argument specifies number of bytes reserved
for data in the external file.
If <code>size</code> is set to <code>H5F_UNLIMITED</code>, the
external file can be of unlimited size and no more files can be added to
the external files list.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of a dataset creation property list.
<dt><em>const char</em> <code>*name</code>
<dd>IN: Name of an external file.
<dt><em>off_t</em> <code>offset</code>
<dd>IN: Offset, in bytes, from the beginning of the file
to the location in the file where the data starts.
<dt><em>hsize_t</em> <code>size</code>
<dd>IN: Number of bytes reserved in the file for the data.
</dl>
<dt><strong>Returns:</strong>
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_external_f"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<!--
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetExternalCount">H5Pget_external_count</a>
<dt><strong>Signature:</strong>
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
<dd><em>int</em> <code>H5Pget_external_count</code>(<em>hid_t</em> <code>plist</code>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
)
<dt><strong>Purpose:</strong>
<dd>Returns the number of external files for a dataset.
<dt><strong>Description:</strong>
<dd><code>H5Pget_external_count</code> returns the number of external files
for the specified dataset.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of a dataset creation property list.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns the number of external files if successful;
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_external_count_f"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<!--
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetExternal">H5Pget_external</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pget_external</code>(<em>hid_t</em> <code>plist</code>,
<em>int</em> <code>idx</code>,
<em>size_t</em> <code>name_size</code>,
<em>char</em> <code>*name</code>,
<em>off_t</em> <code>*offset</code>,
<em>hsize_t</em> <code>*size</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns information about an external file.
<dt><strong>Description:</strong>
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
<dd><code>H5Pget_external</code> returns information about an external
file. The external file is specified by its index, <code>idx</code>,
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
which is a number from zero to N-1, where N is the value
returned by <code>H5Pget_external_count()</code>.
At most <code>name_size</code> characters are copied into the
<code>name</code> array. If the external file name is
longer than <code>name_size</code> with the null terminator, the
return value is not null terminated (similar to <code>strncpy()</code>).
<p>
If <code>name_size</code> is zero or <code>name</code> is the
null pointer, the external file name is not returned.
If <code>offset</code> or <code>size</code> are null pointers
then the corresponding information is not returned.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of a dataset creation property list.
<dt><em>int</em> <code>idx</code>
<dd>IN: External file index.
<dt><em>size_t</em> <code>name_size</code>
<dd>IN: Maximum length of <code>name</code> array.
<dt><em>char</em> <code>*name</code>
<dd>OUT: Name of the external file.
<dt><em>off_t</em> <code>*offset</code>
<dd>OUT: Pointer to a location to return an offset value.
<dt><em>hsize_t</em> <code>*size</code>
<dd>OUT: Pointer to a location to return the size of the
external file data.
</dl>
<dt><strong>Returns:</strong>
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_external_f"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<!--
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetFillValue">H5Pset_fill_value</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_fill_value</code>(<em>hid_t</em> <code>plist_id</code>,
<em>hid_t</em> <code>type_id</code>,
<em>const void *</em><code>value</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets a dataset fill value.
<dt><strong>Description:</strong>
<dd><code>H5Pset_fill_value</code> sets the fill value for a
dataset creation property list.
<p>
The <code>value</code> is interpreted as being of type
<code>type_id</code>. This need not be the same type
as the dataset, but the library must be able to convert
<code>value</code> to the dataset type when the dataset
is created.
<dt><strong>Notes:</strong>
<dd>If a fill value is set for a dataset (even if the
fill value is all zeros), the fill value will be written
to the file. If no fill value is set, then HDF5 relies on
the underlying file driver (usually a Unix file system)
to initialize unwritten parts of the file to zeros.
<p>
Creating a contiguous dataset with a fill value can be a
very expensive operation since the optimization has not
yet been implemented that would delay the writing of the
fill values until after some data has been written.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist_id</code>
<dd>IN: Property list identifier.
<dt><em>hid_t</em> <code>type_id</code>,
<dd>IN: The datatype identifier of <code>value</code>.
<dt><em>const void *</em><code>value</code>
<dd>IN: The fill value.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_fill_value_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetFillValue">H5Pget_fill_value</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pget_fill_value</code>(<em>hid_t</em> <code>plist_id</code>,
<em>hid_t</em> <code>type_id</code>,
<em>void *</em><code>value</code>
)
<dt><strong>Purpose:</strong>
<dd>Retrieves a dataset fill value.
<dt><strong>Description:</strong>
<dd><code>H5Pget_fill_value</code> queries the
fill value property of a dataset creation property list.
<p>
The fill value is returned through the <code>value</code>
pointer.
<p>
Memory is allocated by the caller.
<p>
The fill value will be converted from its current
data type to the type specified by <code>type_id</code>.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist_id</code>
<dd>IN: Property list identifier.
<dt><em>hid_t</em> <code>type_id</code>,
<dd>IN: The datatype identifier of <code>value</code>.
<dt><em>const void *</em><code>value</code>
<dd>IN: The fill value.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_fill_value_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetFilter">H5Pset_filter</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_filter</code>(<em>hid_t</em> <code>plist</code>,
<em>H5Z_filter_t</em> <code>filter</code>,
<em>unsigned int</em> <code>flags</code>,
<em>size_t</em> <code>cd_nelmts</code>,
<em>const unsigned int</em> <code>cd_values[]</code>
)
<dt><strong>Purpose:</strong>
<dd>Adds a filter to the filter pipeline.
<dt><strong>Description:</strong>
<dd><code>H5Pset_filter</code> adds the specified
<code>filter</code> and corresponding properties to the
end of an output filter pipeline.
If <code>plist</code> is a dataset creation property list,
the filter is added to the permanent filter pipeline;
if <code>plist</code> is a dataset transfer property list,
the filter is added to the transient filter pipeline.
<p>
The array <code>cd_values</code> contains
<code>cd_nelmts</code> integers which are auxiliary data
for the filter. The integer values will be stored in the
dataset object header as part of the filter information.
<p>
The <code>flags</code> argument is a bit vector with
the following fields specifying certain general properties
of the filter:
<center>
<table align=center width="80%">
<tr valign=top>
<td valign=top><code>H5Z_FLAG_OPTIONAL</code></td>
<td>&nbsp;&nbsp;</td>
<td valign=top>If this bit is set then the filter is
optional. If the filter fails (see below) during an
<code>H5Dwrite()</code> operation then the filter is
just excluded from the pipeline for the chunk for which
it failed; the filter will not participate in the
pipeline during an <code>H5Dread()</code> of the chunk.
This is commonly used for compression filters: if the
compression result would be larger than the input then
the compression filter returns failure and the
uncompressed data is stored in the file. If this bit is
clear and a filter fails then <code>H5Dwrite()</code>
or <code>H5Dread()</code> also fails.</td>
</tr>
</table>
</center>
<dt><strong>Note:</strong>
<dd>This function currently supports only the permanent filter
pipeline; <code>plist_id</code> must be a dataset creation
property list.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Property list identifier.
<dt><em>H5Z_filter_t</em> <code>filter</code>
<dd>IN: Filter to be added to the pipeline.
<dt><em>unsigned int</em> <code>flags</code>
<dd>IN: Bit vector specifying certain general properties
of the filter.
<dt><em>size_t</em> <code>cd_nelmts</code>
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
<dd>IN: Number of elements in <code>cd_values</code>.
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
<dt><em>const unsigned int</em> <code>cd_values[]</code>
<dd>IN: Auxiliary data for the filter.
</dl>
<dt><strong>Returns:</strong>
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_filter_f"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<!--
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetNFilters">H5Pget_nfilters</a>
<dt><strong>Signature:</strong>
<dd><em>int</em> <code>H5Pget_nfilters</code>(<em>hid_t</em> <code>plist</code>)
<dt><strong>Purpose:</strong>
<dd>Returns the number of filters in the pipeline.
<dt><strong>Description:</strong>
<dd><code>H5Pget_nfilters</code> returns the number of filters
defined in the filter pipeline associated with the property list
<code>plist</code>.
<p>
In each pipeline, the filters are numbered from
0 through <em>N</em>-1, where <em>N</em> is the value returned
by this function. During output to the file, the filters are
applied in increasing order; during input from the file, they
are applied in decreasing order.
<p>
<code>H5Pget_nfilters</code> returns the number of filters
in the pipeline, including zero (<code>0</code>) if there
are none.
<dt><strong>Note:</strong>
<dd>This function currently supports only the permanent filter
pipeline; <code>plist_id</code> must be a dataset creation
property list.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Property list identifier.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns the number of filters in the pipeline if successful;
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<!--
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_nfilters_f"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
--> <!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetFilter">H5Pget_filter</a>
<dt><strong>Signature:</strong>
<dd><em>H5Z_filter_t</em> <code>H5Pget_filter</code>(<em>hid_t</em> <code>plist</code>,
<em>int</em> <code>filter_number</code>,
<em>unsigned int *</em><code>flags</code>,
<em>size_t *</em><code>cd_nelmts</code>,
<em>unsigned int *</em><code>cd_values</code>,
<em>size_t</em> <code>namelen</code>,
<em>char</em> <code>name[]</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns information about a filter in a pipeline.
<dt><strong>Description:</strong>
<dd><code> </code>
<code>H5Pget_filter</code> returns information about a
filter, specified by its filter number, in a filter pipeline,
specified by the property list with which it is associated.
<p>
If <code>plist</code> is a dataset creation property list,
the pipeline is a permanent filter pipeline;
if <code>plist</code> is a dataset transfer property list,
the pipeline is a transient filter pipeline.
<p>
On input, <code>cd_nelmts</code> indicates the number of entries
in the <code>cd_values</code> array, as allocated by the caller;
on return,<code>cd_nelmts</code> contains the number of values
defined by the filter.
<p>
<code>filter_number</code> is a value between zero and
<em>N</em>-1, as described in
<a href="#Property-GetNFilters"><code>H5Pget_nfilters()</code></a>.
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
The function will return a negative value if the filter number
is out of range.
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
<p>
If <code>name</code> is a pointer to an array of at least
<code>namelen</code> bytes, the filter name will be copied
into that array. The name will be null terminated if
<code>namelen</code> is large enough. The filter name returned
will be the name appearing in the file, the name registered
for the filter, or an empty string.
<p>
The structure of the <code>flags</code> argument is discussed
in <a href="#Property-SetFilter"><code>H5Pset_filter()</code></a>.
<dt><strong>Note:</strong>
<dd>This function currently supports only the permanent filter
pipeline; <code>plist</code> must be a dataset creation property
list.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Property list identifier.
<dt><em>int</em> <code>filter_number</code>
<dd>IN: Sequence number within the filter pipeline of
the filter for which information is sought.
<dt><em>unsigned int *</em><code>flags</code>
<dd>OUT: Bit vector specifying certain general properties
of the filter.
<dt><em>size_t *</em><code>cd_nelmts</code>
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
<dd>IN/OUT: Number of elements in <code>cd_values</code>.
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
<dt><em>unsigned int *</em><code>cd_values</code>
<dd>OUT: Auxiliary data for the filter.
<dt><em>size_t</em> <code>namelen</code>
<dd>IN: Anticipated number of characters in <code>name</code>.
<dt><em>char</em> <code>name[]</code>
<dd>OUT: Name of the filter.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns the filter identification number if successful.
Otherwise returns H5Z_FILTER_ERROR (-1).
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_filter_f"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<!--
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
</dl>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<hr>
<dl>
[svn-r2760] Purpose: Removing functions that have been removed from library. Solution: Removed H5Pget_driver, H5P[gs]et_stdio, H5P[gs]et_sec2, H5P[gs]et_core, H5P[gs]et_split, H5P[gs]et_family, H5P[gs]et_mpi, and H5P[gs]et_xfer. Platforms tested: IE5
2000-11-01 00:04:29 +08:00
<dt><strong>Name:</strong> <a name="Property-xxx">xxx</a>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Signature:</strong>
[svn-r2760] Purpose: Removing functions that have been removed from library. Solution: Removed H5Pget_driver, H5P[gs]et_stdio, H5P[gs]et_sec2, H5P[gs]et_core, H5P[gs]et_split, H5P[gs]et_family, H5P[gs]et_mpi, and H5P[gs]et_xfer. Platforms tested: IE5
2000-11-01 00:04:29 +08:00
<dd><em>xxx</em> <code>xxx</code>(<em>xxx</em> <code>xxx</code>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
)
<dt><strong>Purpose:</strong>
[svn-r2760] Purpose: Removing functions that have been removed from library. Solution: Removed H5Pget_driver, H5P[gs]et_stdio, H5P[gs]et_sec2, H5P[gs]et_core, H5P[gs]et_split, H5P[gs]et_family, H5P[gs]et_mpi, and H5P[gs]et_xfer. Platforms tested: IE5
2000-11-01 00:04:29 +08:00
<dd>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Description:</strong>
[svn-r2760] Purpose: Removing functions that have been removed from library. Solution: Removed H5Pget_driver, H5P[gs]et_stdio, H5P[gs]et_sec2, H5P[gs]et_core, H5P[gs]et_split, H5P[gs]et_family, H5P[gs]et_mpi, and H5P[gs]et_xfer. Platforms tested: IE5
2000-11-01 00:04:29 +08:00
<dd><code>xxx</code>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Parameters:</strong>
<dl>
[svn-r2760] Purpose: Removing functions that have been removed from library. Solution: Removed H5Pget_driver, H5P[gs]et_stdio, H5P[gs]et_sec2, H5P[gs]et_core, H5P[gs]et_split, H5P[gs]et_family, H5P[gs]et_mpi, and H5P[gs]et_xfer. Platforms tested: IE5
2000-11-01 00:04:29 +08:00
<dt><em>xxx</em> <code>xxx</code>
<dd>IN:
<dd>OUT:
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<dt><strong>Returns:</strong>
[svn-r2760] Purpose: Removing functions that have been removed from library. Solution: Removed H5Pget_driver, H5P[gs]et_stdio, H5P[gs]et_sec2, H5P[gs]et_core, H5P[gs]et_split, H5P[gs]et_family, H5P[gs]et_mpi, and H5P[gs]et_xfer. Platforms tested: IE5
2000-11-01 00:04:29 +08:00
<dd>Returns xxx if successful.
Otherwise returns xxx.
<!--
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
[svn-r2760] Purpose: Removing functions that have been removed from library. Solution: Removed H5Pget_driver, H5P[gs]et_stdio, H5P[gs]et_sec2, H5P[gs]et_core, H5P[gs]et_split, H5P[gs]et_family, H5P[gs]et_mpi, and H5P[gs]et_xfer. Platforms tested: IE5
2000-11-01 00:04:29 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<!--
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<hr>
<dl>
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Name:</strong> <a name="Property-SetGCReferences">H5Pset_gc_references</a>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Signature:</strong>
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
<dd><em>herr_t</em> <code>H5Pset_gc_reference</code>(<em>hid_t</em> <code>plist</code>,
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<em>unsigned</em> <code>gc_ref</code>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
)
<dt><strong>Purpose:</strong>
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dd>Sets garbage collecting references flag.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Description:</strong>
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dd><code>H5Pset_gc_references</code> sets the flag for
garbage collecting references for the file.
<p>
Dataset region references and other reference types use space
in an HDF5 file's global heap. If garbage collection is on
and the user passes in an uninitialized value in a reference structure,
the heap might get corrupted. When garbage collection is off, however,
and the user re-uses a reference, the previous heap block will be
orphaned and not returned to the free heap space.
<p>
When garbage collection is on, the user must initialize the
reference structures to 0 or risk heap corruption.
<p>
The default value for garbage collecting references is off.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dd>IN: File access property list identifier.
<dt><em>unsigned</em> <code>gc_ref</code>
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
<dd>IN: Flag setting reference garbage collection to
on (<code>1</code>) or off (<code>0</code>).
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<dt><strong>Returns:</strong>
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_gc_references_f"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<!--
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetGCReferences">H5Pget_gc_references</a>
<dt><strong>Signature:</strong>
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
<dd><em>herr_t</em> <code>H5Pget_gc_references</code>(<em>hid_t</em> <code>plist</code>,
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<em>unsigned</em> *<code>gc_ref</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns garbage collecting references setting.
<dt><strong>Description:</strong>
<dd><code>H5Pget_gc_references</code> returns the current setting
for the garbage collection references property from
the specified file access property list.
The garbage collection references property is set
by <a href="#Property-SetGCReferences">H5Pset_gc_references</a>.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: File access property list identifier.
<dt><em>unsigned</em> <code>gc_ref</code>
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
<dd>OUT: Flag returning the state of reference garbage collection.
A returned value of <code>1</code> indicates that
garbage collection is on while
<code>0</code> indicates that garbage collection is off.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_gc_references_f"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<!--
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetCache">H5Pset_cache</a>
<dt><strong>Signature:</strong>
[svn-r1886] RM_H5P.html H5Pset/get_cache: Added missing rdcc_nelmts parameter. Corrected inconsistent references to rdcc_wo parameter. Clarified Purpose and Description sections. H5Pget_sec2: Corrected return type from 'returntype' to 'herr_t'.
1999-12-17 23:34:35 +08:00
<dd><em>herr_t</em> <code>H5Pset_cache</code>(<em>hid_t</em> <code>plist_id</code>,
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<em>int</em> <code>mdc_nelmts</code>,
[svn-r1886] RM_H5P.html H5Pset/get_cache: Added missing rdcc_nelmts parameter. Corrected inconsistent references to rdcc_wo parameter. Clarified Purpose and Description sections. H5Pget_sec2: Corrected return type from 'returntype' to 'herr_t'.
1999-12-17 23:34:35 +08:00
<em>int</em> <code>rdcc_nelmts</code>,
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<em>size_t</em> <code>rdcc_nbytes</code>,
<em>double</em> <code>rdcc_w0</code>
)
<dt><strong>Purpose:</strong>
[svn-r1886] RM_H5P.html H5Pset/get_cache: Added missing rdcc_nelmts parameter. Corrected inconsistent references to rdcc_wo parameter. Clarified Purpose and Description sections. H5Pget_sec2: Corrected return type from 'returntype' to 'herr_t'.
1999-12-17 23:34:35 +08:00
<dd>Sets the meta data cache and raw data chunk cache parameters.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Description:</strong>
[svn-r1886] RM_H5P.html H5Pset/get_cache: Added missing rdcc_nelmts parameter. Corrected inconsistent references to rdcc_wo parameter. Clarified Purpose and Description sections. H5Pget_sec2: Corrected return type from 'returntype' to 'herr_t'.
1999-12-17 23:34:35 +08:00
<dd><code>H5Pset_cache</code> sets
the number of elements (objects) in the meta data cache and
the number of elements, the total number of bytes, and
the preemption policy value in the raw data chunk cache.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<p>
[svn-r1886] RM_H5P.html H5Pset/get_cache: Added missing rdcc_nelmts parameter. Corrected inconsistent references to rdcc_wo parameter. Clarified Purpose and Description sections. H5Pget_sec2: Corrected return type from 'returntype' to 'herr_t'.
1999-12-17 23:34:35 +08:00
The <em>plist_id</em> is a file access property list.
The number of elements (objects) in the meta data cache
and the raw data chunk cache are <em>mdc_nelmts</em> and
<em>rdcc_nelmts</em>, respectively.
The total size of the raw data chunk cache and the preemption policy
are <em>rdcc_nbytes</em> and <em>rdcc_w0</em>.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<p>
[svn-r1886] RM_H5P.html H5Pset/get_cache: Added missing rdcc_nelmts parameter. Corrected inconsistent references to rdcc_wo parameter. Clarified Purpose and Description sections. H5Pget_sec2: Corrected return type from 'returntype' to 'herr_t'.
1999-12-17 23:34:35 +08:00
Any (or all) of the <code>H5Pget_cache()</code> pointer arguments
may be null pointers.
<p>
The <em>rdcc_w0</em> value should be between 0 and 1 inclusive and
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
indicates how much chunks that have been fully read are
favored for preemption. A value of zero means fully read
chunks are treated no differently than other chunks (the
preemption is strictly LRU) while a value of one means fully
read chunks are always preempted before other chunks.
<dt><strong>Parameters:</strong>
<dl>
[svn-r1886] RM_H5P.html H5Pset/get_cache: Added missing rdcc_nelmts parameter. Corrected inconsistent references to rdcc_wo parameter. Clarified Purpose and Description sections. H5Pget_sec2: Corrected return type from 'returntype' to 'herr_t'.
1999-12-17 23:34:35 +08:00
<dt><em>hid_t</em> <code>plist_id</code>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dd>IN: Identifier of the file access property list.
<dt><em>int</em> <code>mdc_nelmts</code>
<dd>IN: Number of elements (objects) in the meta data cache.
[svn-r1886] RM_H5P.html H5Pset/get_cache: Added missing rdcc_nelmts parameter. Corrected inconsistent references to rdcc_wo parameter. Clarified Purpose and Description sections. H5Pget_sec2: Corrected return type from 'returntype' to 'herr_t'.
1999-12-17 23:34:35 +08:00
<dt><em>int</em> <code>rdcc_nelmts</code>
<dd>IN: Number of elements (objects) in the raw data chunk cache.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><em>size_t</em> <code>rdcc_nbytes</code>
<dd>IN: Total size of the raw data chunk cache, in bytes.
<dt><em>double</em> <code>rdcc_w0</code>
<dd>IN: Preemption policy.
</dl>
<dt><strong>Returns:</strong>
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_cache_f"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<!--
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetCache">H5Pget_cache</a>
<dt><strong>Signature:</strong>
[svn-r1886] RM_H5P.html H5Pset/get_cache: Added missing rdcc_nelmts parameter. Corrected inconsistent references to rdcc_wo parameter. Clarified Purpose and Description sections. H5Pget_sec2: Corrected return type from 'returntype' to 'herr_t'.
1999-12-17 23:34:35 +08:00
<dd><em>herr_t</em> <code>H5Pget_cache</code>(<em>hid_t</em> <code>plist_id</code>,
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<em>int</em> <code>*mdc_nelmts</code>,
[svn-r1886] RM_H5P.html H5Pset/get_cache: Added missing rdcc_nelmts parameter. Corrected inconsistent references to rdcc_wo parameter. Clarified Purpose and Description sections. H5Pget_sec2: Corrected return type from 'returntype' to 'herr_t'.
1999-12-17 23:34:35 +08:00
<em>int</em> <code>*rdcc_nelmts</code>,
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<em>size_t</em> <code>*rdcc_nbytes</code>,
<em>double</em> <code>*rdcc_w0</code>
)
<dt><strong>Purpose:</strong>
[svn-r1886] RM_H5P.html H5Pset/get_cache: Added missing rdcc_nelmts parameter. Corrected inconsistent references to rdcc_wo parameter. Clarified Purpose and Description sections. H5Pget_sec2: Corrected return type from 'returntype' to 'herr_t'.
1999-12-17 23:34:35 +08:00
<dd>Queries the meta data cache and raw data chunk cache parameters.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Description:</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><code>H5Pget_cache</code> retrieves the maximum possible
number of elements in the meta
[svn-r1886] RM_H5P.html H5Pset/get_cache: Added missing rdcc_nelmts parameter. Corrected inconsistent references to rdcc_wo parameter. Clarified Purpose and Description sections. H5Pget_sec2: Corrected return type from 'returntype' to 'herr_t'.
1999-12-17 23:34:35 +08:00
data cache and raw data chunk cache, the maximum possible number of
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
bytes in the raw data chunk cache, and the preemption policy value.
<p>
[svn-r1886] RM_H5P.html H5Pset/get_cache: Added missing rdcc_nelmts parameter. Corrected inconsistent references to rdcc_wo parameter. Clarified Purpose and Description sections. H5Pget_sec2: Corrected return type from 'returntype' to 'herr_t'.
1999-12-17 23:34:35 +08:00
Any (or all) arguments may be null pointers, in which case the
corresponding datum is not returned.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Parameters:</strong>
<dl>
[svn-r1886] RM_H5P.html H5Pset/get_cache: Added missing rdcc_nelmts parameter. Corrected inconsistent references to rdcc_wo parameter. Clarified Purpose and Description sections. H5Pget_sec2: Corrected return type from 'returntype' to 'herr_t'.
1999-12-17 23:34:35 +08:00
<dt><em>hid_t</em> <code>plist_id</code>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dd>IN: Identifier of the file access property list.
<dt><em>int</em> <code>*mdc_nelmts</code>
<dd>IN/OUT: Number of elements (objects) in the meta data cache.
[svn-r1886] RM_H5P.html H5Pset/get_cache: Added missing rdcc_nelmts parameter. Corrected inconsistent references to rdcc_wo parameter. Clarified Purpose and Description sections. H5Pget_sec2: Corrected return type from 'returntype' to 'herr_t'.
1999-12-17 23:34:35 +08:00
<dt><em>int</em> <code>*rdcc_nelmts</code>
<dd>IN/OUT: Number of elements (objects) in the raw data chunk cache.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><em>size_t</em> <code>*rdcc_nbytes</code>
<dd>IN/OUT: Total size of the raw data chunk cache, in bytes.
<dt><em>double</em> <code>*rdcc_w0</code>
<dd>IN/OUT: Preemption policy.
</dl>
<dt><strong>Returns:</strong>
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_cache_f"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<!--
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetHyperCache">H5Pset_hyper_cache</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_hyper_cache</code>(<em>hid_t</em> <code>plist</code>,
<em>unsigned</em> <code>cache</code>,
<em>unsigned</em> <code>limit</code>
)
<dt><strong>Purpose:</strong>
<dd>Indicates whether to cache hyperslab blocks during I/O.
<dt><strong>Description:</strong>
<dd>Given a dataset transfer property list, <code>H5Pset_hyper_cache</code>
indicates whether to cache hyperslab blocks during I/O,
a process which can significantly increase I/O speeds.
<p>
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
When working with hyperslab selections, it is possible to
significantly speed up I/O operations by retrieving an
entire hyperslab from the file in one operation and
caching it in memory.
The <code>cache</code> parameter specifies whether to turn
caching on for hyperslab I/O operations.
If <code>cache</code> is set to <code>1</code>,
caching is turned on;
if set to <code>0</code>, caching is turned off.
<p>
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
The parameter <code>limit</code> sets the maximum size of the
hyperslab block to cache. If a block is smaller than that limit,
it may still not be cached if no memory is available.
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
Setting <code>limit</code> to <code>0</code> (zero) indicates
no limitation on the size of block to attempt to cache.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<p>
The default is to cache blocks with no limit on block size
for serial I/O and to not cache blocks for parallel I/O.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Dataset transfer property list identifier.
<dt><em>unsigned</em> <code>cache</code>
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
<dd>IN: A flag indicating whether caching is to be
set to on (<code>1</code>) or off (<code>0</code>).
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><em>unsigned</em> <code>limit</code>
<dd>IN: Maximum size of the hyperslab block to cache.
<code>0</code> (zero) indicates no limit.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_hyper_cache_f"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<!--
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetHyperCache">H5Pget_hyper_cache</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pget_hyper_cache</code>(<em>hid_t</em> <code>plist</code>,
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
<em>unsigned</em> *<code>cache</code>,
<em>unsigned</em> *<code>limit</code>
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
)
<dt><strong>Purpose:</strong>
<dd>Returns information regarding the caching of hyperslab blocks during I/O.
<dt><strong>Description:</strong>
<dd>Given a dataset transfer property list, <code>H5Pget_hyper_cache</code>
returns instructions regarding the caching of hyperslab blocks during I/O.
These parameters are set with the <code>H5Pset_hyper_cache</code> function.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Dataset transfer property list identifier.
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
<dt><em>unsigned</em> *<code>cache</code>
<dd>OUT: A flag indicating whether caching is
set to on (<code>1</code>) or off (<code>0</code>).
<dt><em>unsigned</em> *<code>limit</code>
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dd>OUT: Maximum size of the hyperslab block to cache.
<code>0</code> (zero) indicates no limit.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_hyper_cache_f"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<!--
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetBTreeRatios">H5Pset_btree_ratios</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_btree_ratios</code>(<em>hid_t</em> <code>plist</code>,
<em>double</em> <code>left</code>,
<em>double</em> <code>middle</code>,
<em>double</em> <code>right</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets B-tree split ratios for a dataset transfer property list.
<dt><strong>Description:</strong>
<dd><code>H5Pset_btree_ratios</code> sets the B-tree split ratios
for a dataset transfer property list. The split ratios determine
what percent of children go in the first node when a node splits.
<p>
The ratio <code>left</code> is used when the splitting node is
the left-most node at its level in the tree;
the ratio <code>right</code> is used when the splitting node is
the right-most node at its level;
and the ratio <code>middle</code> is used for all other cases.
<p>
A node which is the only node at its level in the tree uses
the ratio <code>right</code> when it splits.
<p>
All ratios are real numbers between 0 and 1, inclusive.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: The dataset transfer property list identifier.
<dt><em>double</em> <code>left</code>
<dd>IN: The B-tree split ratio for left-most nodes.
<dt><em>double</em> <code>right</code>
<dd>IN: The B-tree split ratio for right-most nodes and lone nodes.
<dt><em>double</em> <code>middle</code>
<dd>IN: The B-tree split ratio for all other nodes.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_btree_ratios_f"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<!--
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetBTreeRatios">H5Pget_btree_ratios</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pget_btree_ratios</code>(<em>hid_t</em> <code>plist</code>,
<em>double</em> *<code>left</code>,
<em>double</em> *<code>middle</code>,
<em>double</em> *<code>right</code>
)
<dt><strong>Purpose:</strong>
<dd>Gets B-tree split ratios for a dataset transfer property list.
<dt><strong>Description:</strong>
<dd><code>H5Pget_btree_ratios</code> returns the B-tree split ratios
for a dataset transfer property list.
<p>
The B-tree split ratios are returned through the non-<code>NULL</code>
arguments <code>left</code>, <code>middle</code>, and <code>right</code>,
as set by the <a href="#Property-SetBTreeRatios">H5Pset_btree_ratios</a> function.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: The dataset transfer property list identifier.
<dt><em>double</em> <code>left</code>
<dd>OUT: The B-tree split ratio for left-most nodes.
<dt><em>double</em> <code>right</code>
<dd>OUT: The B-tree split ratio for right-most nodes and lone nodes.
<dt><em>double</em> <code>middle</code>
<dd>OUT: The B-tree split ratio for all other nodes.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_btree_ratios_f"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<!--
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetBuffer">H5Pset_buffer</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_buffer</code>(<em>hid_t</em> <code>plist</code>,
<em>size_t</em> <code>size</code>,
<em>void</em> <code>*tconv</code>,
<em>void</em> <code>*bkg</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets type conversion and background buffers.
<dt><strong>Description:</strong>
<dd> Given a dataset transfer property list, <code>H5Pset_buffer</code>
sets the maximum size
for the type conversion buffer and background buffer and
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
optionally supplies pointers to application-allocated buffers.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
If the buffer size is smaller than the entire amount of data
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
being transferred between the application and the file, and a type
conversion buffer or background buffer is required, then
strip mining will be used.
<p>
Note that there are minimum size requirements for the buffer.
Strip mining can only break the data up along the first dimension,
so the buffer must be large enough to accommodate a complete slice
that encompasses all of the remaining dimensions.
For example, when strip mining a 100x200x300 hyperslab
of a simple data space, the buffer must be large enough to
hold 1x200x300 data elements.
When strip mining a 100x200x300x150 hyperslab of a simple data space,
the buffer must be large enough to hold 1x200x300x150 data elements.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<p>
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
If <code>tconv</code> and/or <code>bkg</code> are null pointers,
then buffers will be allocated and freed during the data transfer.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<p>
The default value for the maximum buffer is 1 Mb.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for the dataset transfer property list.
<dt><em>size_t</em> <code>size</code>
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
<dd>IN: Size, in bytes, of the type conversion and background buffers.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><em>void</em> <code>tconv</code>
<dd>IN: Pointer to application-allocated type conversion buffer.
<dt><em>void</em> <code>bkg</code>
<dd>IN: Pointer to application-allocated background buffer.
</dl>
<dt><strong>Returns:</strong>
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<!--
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
--> <!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetBuffer">H5Pget_buffer</a>
<dt><strong>Signature:</strong>
<dd><em>size_t</em> <code>H5Pget_buffer</code>(<em>hid_t</em> <code>plist</code>,
<em>void</em> <code>**tconv</code>,
<em>void</em> <code>**bkg</code>
)
<dt><strong>Purpose:</strong>
<dd>Reads buffer settings.
<dt><strong>Description:</strong>
<dd><code>H5Pget_buffer</code> reads values previously set
with H5Pset_buffer().
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for the dataset transfer property list.
<dt><em>void</em> <code>**tconv</code>
<dd>OUT: Address of the pointer to application-allocated
type conversion buffer.
<dt><em>void</em> <code>**bkg</code>
<dd>OUT: Address of the pointer to application-allocated
background buffer.
</dl>
<dt><strong>Returns:</strong>
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
<dd>Returns buffer size, in bytes, if successful;
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
otherwise 0 on failure.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<!--
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
--> <!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetPreserve">H5Pset_preserve</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_preserve</code>(<em>hid_t</em> <code>plist</code>,
<em>hbool_t</em> <code>status</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets the dataset transfer property list status to TRUE or FALSE.
<dt><strong>Description:</strong>
<dd><code>H5Pset_preserve</code> sets the
dataset transfer property list status to TRUE or FALSE.
<p>
When reading or writing compound data types and the
destination is partially initialized and the read/write is
intended to initialize the other members, one must set this
property to TRUE. Otherwise the I/O pipeline treats the
destination datapoints as completely uninitialized.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for the dataset transfer property list.
<dt><em>hbool_t</em> <code>status</code>
<dd>IN: Status of for the dataset transfer property list
(TRUE/FALSE).
</dl>
<dt><strong>Returns:</strong>
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<!--
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
--> <!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetPreserve">H5Pget_preserve</a>
<dt><strong>Signature:</strong>
<dd><em>int</em> <code>H5Pget_preserve</code>(<em>hid_t</em> <code>plist</code>)
<dt><strong>Purpose:</strong>
<dd>Checks status of the dataset transfer property list.
<dt><strong>Description:</strong>
<dd><code>H5Pget_preserve</code> checks the status of the
dataset transfer property list.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for the dataset transfer property list.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns TRUE or FALSE if successful;
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<!--
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
--> <!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
<!--
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetCompression">H5Pset_compression</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_compression</code>(<em>hid_t</em> <code>plist</code>,
<em>H5Z_method_t</em> <code>method</code>,
<em>unsigned int</em> <code>flags</code>,
<em>size_t</em> <code>cd_size</code>,
<em>const void</em> <code>*client_data</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets compression method.
<dt><strong>Description:</strong>
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
<dd><code>H5Pset_compression</code> sets the compression method
in a dataset creation property list. This is a catch-all
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
function for defining compression methods
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
and is intended to be called from a wrapper such as
<code>H5Pset_deflate()</code>. The dataset creation property
list <em>plist</em> is adjusted to use the specified
compression method. The <em>flags</em> is an 8-bit vector
which is stored in the file as part of the compression message
and passed to the compress and uncompress functions. The
<em>client_data</em> is a byte array of length
<em>cd_size</em> which is copied to the file and passed to the
compress and uncompress methods.
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
<p>
The FLAGS, CD_SIZE, and CLIENT_DATA are copied to the
property list and eventually to the file and passed to the
compression functions.
<p>
[svn-r2525] RM_H5P.html RM_H5Z.html Corrected compression cross-reference.
2000-09-08 23:35:39 +08:00
See <a href="Datasets.html"><cite>The Dataset Interface (H5D)</cite></a>
in the <cite>HDF5 User's Guide</cite> for further information
regarding data compression.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for the dataset creation property list.
<dt><em>H5Z_method_t</em> <code>method</code>
<dd>IN: Compression method, an integer from 16 to 225.
<dt><em>unsigned int</em> <code>flags</code>
<dd>IN: Compression flags.
<dt><em>size_t</em> <code>cd_size</code>
<dd>IN: Size of the byte array <code>client_data</code>.
<dt><em>const void</em> <code>*client_data</code>
<dd>IN: Client data byte array passed to the compression method.
</dl>
<dt><strong>Returns:</strong>
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
-->
<!--
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetCompression">H5Pget_compression</a>
<dt><strong>Signature:</strong>
<dd><em>H5Z_method_t</em> <code>H5Pget_compression</code>(<em>hid_t</em> <code>plist</code>,
<em>unsigned int</em> <code>*flags</code>,
<em>size_t</em> <code>*cd_size</code>,
<em>void</em> <code>*client_data</code>
)
<dt><strong>Purpose:</strong>
<dd>Gets compression method.
<dt><strong>Description:</strong>
<dd><code>H5Pget_compression</code> gets the compression method
information from a dataset creation property list.
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
The <code>client_data</code> buffer is initially
<code>cd_size</code> bytes. On return, <code>client_data</code>
will be initialized with at most that many bytes, and
<code>cd_size</code> will contain the actual size of the
client data, which might be larger than its original value.
<dt><strong>Parameters:</strong>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for the dataset creation property list.
<dt><em>unsigned int</em> <code>*flags</code>
<dd>OUT: Compression flags.
<dt><em>size_t</em> <code>*cd_size</code>
<dd>IN/OUT: Size of the <code>client_data</code> array.
<dt><em>void</em> <code>*client_data</code>
<dd>OUT: Byte array for the client data.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns compression method if successful;
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetDeflate">H5Pset_deflate</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_deflate</code>(<em>hid_t</em> <code>plist</code>,
<em>int</em> <code>level</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets compression method and compression level.
<dt><strong>Description:</strong>
<dd><code>H5Pset_deflate</code> sets the compression method for a
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
dataset creation property list to <code>H5D_COMPRESS_DEFLATE</code>
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
and the compression level to <code>level</code>, which should
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
be a value from zero to nine, inclusive.
Lower compression levels are faster but result in less compression.
This is the same algorithm as used by the GNU gzip program.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for the dataset creation property list.
<dt><em>int</em> <code>level</code>
<dd>IN: Compression level.
</dl>
<dt><strong>Returns:</strong>
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_deflate_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
<!--
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetDeflate">H5Pget_deflate</a>
<dt><strong>Signature:</strong>
<dd><em>int</em> <code>H5Pget_deflate</code>(<em>hid_t</em> <code>plist</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns the deflate compression level from a dataset creation
property list.
<dt><strong>Description:</strong>
<dd><code>H5Pget_deflate</code> returns the deflate compression level
from a dataset creation property list that uses that method.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for the dataset creation property list.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns compression level, a value between 0 and 9, if successful.
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
Otherwise returns a negative value.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</dl>
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetVLMemManager">H5Pset_vlen_mem_manager</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_vlen_mem_manager</code>(<em>hid_t</em> <code>plist</code>,
<em>H5MM_allocate_t</em> <code>alloc</code>,
<em>void</em> *<code>alloc_info</code>,
<em>H5MM_free_t</em> <code>free</code>,
<em>void</em> *<code>free_info</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets the memory manager for variable-length datatype allocation in
<code>H5Dread</code> and <code>H5Dvlen_reclaim</code>.
<dt><strong>Description:</strong>
<dd><code>H5Pset_vlen_mem_manager</code> sets the memory manager for
variable-length datatype allocation in <code>H5Dread</code>
and free in <code>H5Dvlen_reclaim</code>.
<p>
The <code>alloc</code> and <code>free</code> parameters
identify the memory management routines to be used.
If the user has defined custom memory management routines,
<code>alloc</code> and/or <code>free</code> should be set to make
those routine calls (i.e., the name of the routine is used as
the value of the parameter);
if the user prefers to use the system's <code> malloc</code>
and/or <code>free</code>, the <code>alloc</code> and
<code>free</code> parameters, respectively, should be set to
<code> NULL</code>
<p>
The prototypes for these user-defined functions would appear as follows:
<br>&nbsp;&nbsp;&nbsp;&nbsp;
<em>typedef void</em> *(*<code>H5MM_allocate_t</code>)(<em>size_t</em> <code>size</code>,
<em>void</em> *<code>alloc_info</code>) ;
<br>&nbsp;&nbsp;&nbsp;&nbsp;
<em>typedef void</em> (*<code>H5MM_free_t</code>)(<em>void</em> *<code>mem</code>,
<em>void</em> *<code>free_info</code>) ;
<br>
The <code>alloc_info</code> and <code>free_info</code> parameters
can be used to pass along any required information to
the user's memory management routines.
<p>
In summary, if the user has defined custom memory management
routines, the name(s) of the routines are passed in the
<code>alloc</code> and <code>free</code> parameters and the
custom routines' parameters are passed in the
<code>alloc_info</code> and <code>free_info</code> parameters.
If the user wishes to use the system <code> malloc</code> and
<code>free</code> functions, the <code>alloc</code> and/or
<code>free</code> parameters are set to <code> NULL</code>
and the <code>alloc_info</code> and <code>free_info</code>
parameters are ignored.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for the dataset transfer property list.
<dt><em>H5MM_allocate_t</em> <code>alloc</code>
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
<dd>IN: User's allocate routine, or &nbsp; <code> NULL</code>
for system &nbsp; <code> malloc</code>.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><em>void</em> *<code>alloc_info</code>
<dd>IN: Extra parameter for user's allocation routine.
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
<br>
Contents are ignored if preceding parameter is &nbsp;
<code> NULL</code>.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><em>H5MM_free_t</em> <code>free</code>
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
<dd>IN: User's free routine, or &nbsp; <code> NULL</code>
for system <code>free</code>.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><em>void</em> *<code>free_info</code>
<dd>IN: Extra parameter for user's free routine.
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
<br>
Contents are ignored if preceding parameter is &nbsp;
<code> NULL</code>.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
--> <!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetVLMemManager">H5Pget_vlen_mem_manager</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pget_vlen_mem_manager</code>(<em>hid_t</em> <code>plist</code>,
<em>H5MM_allocate_t</em> *<code>alloc</code>,
<em>void</em> **<code>alloc_info</code>,
<em>H5MM_free_t</em> *<code>free</code>,
<em>void</em> **<code>free_info</code>
)
<dt><strong>Purpose:</strong>
<dd>Gets the memory manager for variable-length datatype allocation in
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
<code>H5Dread</code> and <code>H5Dvlen_reclaim</code>.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><strong>Description:</strong>
<dd><code>H5Pget_vlen_mem_manager</code> is the companion function to
<code>H5Pset_vlen_mem_manager</code>, returning the parameters
set by that function.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for the dataset transfer property list.
<dt><em>H5MM_allocate_t</em> <code>alloc</code>
<dd>OUT: User's allocate routine, or &nbsp; <code> NULL</code>
for system &nbsp; <code> malloc</code>.
<dt><em>void</em> *<code>alloc_info</code>
<dd>OUT: Extra parameter for user's allocation routine.
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
<br>
Contents are ignored if preceding parameter is &nbsp;
<code> NULL</code>.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
<dt><em>H5MM_free_t</em> <code>free</code>
<dd>OUT: User's free routine, or &nbsp; <code> NULL</code> for
system <code>free</code>.
<dt><em>void</em> *<code>free_info</code>
<dd>OUT: Extra parameter for user's free routine.
[svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes. H5Pget_chunk: Changed max_ndims parameter description to IN. H5Pget/set_gc_references: Corrected signature errors, added missing parameter description and values. H5Pget/set_family: Removed. These are not implemented. H5Pget/set_hyper_cache: Corrected signature and parameter expressions, added missing parameter description. H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html H5Pget/set_split: Corrected misnamed parameters. H5Pset_alignment and H5_set_core: Edited for clarity. Added statement regarding "special case" effect of setting 'threshold' to 0 (zero). Stated clearly that 'threshold' is non-negative and 'alignment' and 'increment' are both positive. H5Pget/set_vlen_mem_manager: Corrected cross-ref to H5Dvlen_reclaim. Minor clarification regarding circumstances under which contents of a parameter are ignored. H5Pget_cache: Removed redundant material.
2000-07-07 00:28:38 +08:00
<br>
Contents are ignored if preceding parameter is &nbsp;
<code> NULL</code>.
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx"
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree. (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-14 04:39:48 +08:00
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
--> <!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<hr>
<center>
[svn-r985] Checking in changes from "HDF5 Release 1.0" CVS branch that have not yet been checked into "HDF5 Development" branch. General ======= Various "copy edit" types of repairs. Revisions to document cross-linking. Added structural links tying all docs together (banners at top and bottom of documents, similar to Reference Manual banners of the Beta release). Set background color to white in all documents. NCSAfooterlogo.gif hdf2.jpg New image files to make the documents more self-contained (i.e., to prevent loading images from NCSA and HDF home servers). index.html Redesigned to isolate links external to the installation in a single location. Intro to HDF5 ============= H5.intro.html Fixed banner linking Intro to other docs. Set all URLs to be relative within the distribution; nothing points back to the HDF server. Updates to "Limits of the Current Release" and "Changes in the Current Release." HDF5 User's Guide ================= Changed several User Guide section titles such that all sections that are primarily about a particular interface are now titled in the format "The xxxxx Interface (H5x)". H5.user.html Commented out links to developer docs since they are marked in MANIFEST as not being for distribution in the release. Removed 2nd and 3rd indices from page. Changed "freeform" lists of sections (TOCs) to aligned tables. Datatypes.html Removed the sentence "I'm deferring definition until later since they're probably not as important as the other data types." from Section 3.3, "Properties of Date and Time Atomic Types." Added info regarding 'char' versus 'string' datatypes. Added as Section 3.7, "Character and String Datatype Issues." References.html Commented out substantial material (at end of document) from References planning document that is not appropriate for the User Guide but that is worth keeping around. Groups.html Final edits from elimination of "current working group." HDF5 Reference Manual ===================== Removed "Draft" from the <title>__</title> lines. RM_H5Front.html Removed 2nd and 3rd indices from page. Changed "freeform" lists of sections (TOCs) to aligned tables. RM_H5F.html RM_H5P.html Add file mounting information.
1998-12-22 06:52:56 +08:00
<table border=0 width=98%>
<tr><td valign=top align=left>
<a href="H5.intro.html">Introduction to HDF5</a>&nbsp;<br>
<a href="H5.user.html">HDF5 User Guide</a>&nbsp;<br>
<a href="index.html">Other HDF5 documents and links</a>&nbsp;<br>
<!--
<a href="Glossary.html">Glossary</a><br>
-->
</td>
<td valign=top align=right>
And in this document, the
<a href="RM_H5Front.html">HDF5 Reference Manual</a>&nbsp;&nbsp;
<br>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<a href="RM_H5.html">H5</a>&nbsp;&nbsp;
<a href="RM_H5A.html">H5A</a>&nbsp;&nbsp;
<a href="RM_H5D.html">H5D</a>&nbsp;&nbsp;
<a href="RM_H5E.html">H5E</a>&nbsp;&nbsp;
<a href="RM_H5F.html">H5F</a>&nbsp;&nbsp;
<a href="RM_H5G.html">H5G</a>&nbsp;&nbsp;
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<a href="RM_H5I.html">H5I</a>&nbsp;&nbsp;
[svn-r985] Checking in changes from "HDF5 Release 1.0" CVS branch that have not yet been checked into "HDF5 Development" branch. General ======= Various "copy edit" types of repairs. Revisions to document cross-linking. Added structural links tying all docs together (banners at top and bottom of documents, similar to Reference Manual banners of the Beta release). Set background color to white in all documents. NCSAfooterlogo.gif hdf2.jpg New image files to make the documents more self-contained (i.e., to prevent loading images from NCSA and HDF home servers). index.html Redesigned to isolate links external to the installation in a single location. Intro to HDF5 ============= H5.intro.html Fixed banner linking Intro to other docs. Set all URLs to be relative within the distribution; nothing points back to the HDF server. Updates to "Limits of the Current Release" and "Changes in the Current Release." HDF5 User's Guide ================= Changed several User Guide section titles such that all sections that are primarily about a particular interface are now titled in the format "The xxxxx Interface (H5x)". H5.user.html Commented out links to developer docs since they are marked in MANIFEST as not being for distribution in the release. Removed 2nd and 3rd indices from page. Changed "freeform" lists of sections (TOCs) to aligned tables. Datatypes.html Removed the sentence "I'm deferring definition until later since they're probably not as important as the other data types." from Section 3.3, "Properties of Date and Time Atomic Types." Added info regarding 'char' versus 'string' datatypes. Added as Section 3.7, "Character and String Datatype Issues." References.html Commented out substantial material (at end of document) from References planning document that is not appropriate for the User Guide but that is worth keeping around. Groups.html Final edits from elimination of "current working group." HDF5 Reference Manual ===================== Removed "Draft" from the <title>__</title> lines. RM_H5Front.html Removed 2nd and 3rd indices from page. Changed "freeform" lists of sections (TOCs) to aligned tables. RM_H5F.html RM_H5P.html Add file mounting information.
1998-12-22 06:52:56 +08:00
<br>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
H5P&nbsp;&nbsp;
[svn-r830] ====== Intro ====== H5.intro.html Major rewrite to Groups section. New Example 7 (groups). Added TOC and requisite links. Numbered sections. Labelled figures and centered those that were not. Fixed table formatting. =========== User Guide =========== H5.user.html Linked in Chunking.html. Linked in References.html. Linked in DDL.html. Chunking.html Minor edits. DDL.html References.html New documents. Datatypes.html Added "R Reference" to base name description and "H5T_STD_ROBJ -- Reference to an entire object in a file" to list of datatype names. Files.html H5Fflush Added scope parameter. Groups.html Removed references to "current working group." Removed H5Gpush, H5Gpop, and H5Gset functions. Removed note that H5Glink and H5Gunlink were not implemented. ================= Reference Manual ================= RM_*.html and Tools.html Updated Reference Manual internal cross-linking (the link banner at the top and bottom of each page). Changed Returns SUCCEED (0) if successful; otherwise FAIL (-1). to read Returns a non-negative value if successful; otherwise returns a negative value. and several derived changes where circumstances differred only slightly. Minor copy edits throughout. RM_H5.html Corrected H5open "Purpose" statement. RM_H5A.html Changed H5Aget_name return type to hssize_t. RM_H5F.html H5Fflush Added scope parameter. Added H5Freopen. RM_H5Front.html Reordered listing of interfaces to alphabetical order (H5, H5A, H5D, ...) Added H5I, H5R, and H5RA. RM_H5G.html H5Gopen Edited "Description." H5Gget_objinfo Added named datatype to list of valid values for loc_id. RM_H5I.html Identifier Interface New section. RM_H5P.html Added H5Pset_fill_value and H5Pget_fill_value. Several minor copy edits. RM_H5R.html Reference Interface New section. H5RA.html Essentially a new section. It was in the tree previously, but it did not actually have content. RM_H5S.html Changed H5Sget_select_npoints return type to hssize_t. Tools.html Updated h5dump documentation.
1998-10-30 06:13:17 +08:00
<a href="RM_H5R.html">H5R</a>&nbsp;&nbsp;
<a href="RM_H5RA.html">H5RA</a>&nbsp;&nbsp;
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<a href="RM_H5S.html">H5S</a>&nbsp;&nbsp;
<a href="RM_H5T.html">H5T</a>&nbsp;&nbsp;
<a href="RM_H5Z.html">H5Z</a>&nbsp;&nbsp;
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
<a href="Tools.html">Tools</a>&nbsp;&nbsp;
[svn-r985] Checking in changes from "HDF5 Release 1.0" CVS branch that have not yet been checked into "HDF5 Development" branch. General ======= Various "copy edit" types of repairs. Revisions to document cross-linking. Added structural links tying all docs together (banners at top and bottom of documents, similar to Reference Manual banners of the Beta release). Set background color to white in all documents. NCSAfooterlogo.gif hdf2.jpg New image files to make the documents more self-contained (i.e., to prevent loading images from NCSA and HDF home servers). index.html Redesigned to isolate links external to the installation in a single location. Intro to HDF5 ============= H5.intro.html Fixed banner linking Intro to other docs. Set all URLs to be relative within the distribution; nothing points back to the HDF server. Updates to "Limits of the Current Release" and "Changes in the Current Release." HDF5 User's Guide ================= Changed several User Guide section titles such that all sections that are primarily about a particular interface are now titled in the format "The xxxxx Interface (H5x)". H5.user.html Commented out links to developer docs since they are marked in MANIFEST as not being for distribution in the release. Removed 2nd and 3rd indices from page. Changed "freeform" lists of sections (TOCs) to aligned tables. Datatypes.html Removed the sentence "I'm deferring definition until later since they're probably not as important as the other data types." from Section 3.3, "Properties of Date and Time Atomic Types." Added info regarding 'char' versus 'string' datatypes. Added as Section 3.7, "Character and String Datatype Issues." References.html Commented out substantial material (at end of document) from References planning document that is not appropriate for the User Guide but that is worth keeping around. Groups.html Final edits from elimination of "current working group." HDF5 Reference Manual ===================== Removed "Draft" from the <title>__</title> lines. RM_H5Front.html Removed 2nd and 3rd indices from page. Changed "freeform" lists of sections (TOCs) to aligned tables. RM_H5F.html RM_H5P.html Add file mounting information.
1998-12-22 06:52:56 +08:00
</td></tr>
</table>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</center>
<hr>
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<address>
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
<br>
[svn-r2435] RM_H5[EIPRT].html RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
2000-07-18 03:14:30 +08:00
Last modified: 13 July 2000
<br>
Describes HDF5 Version 1.3 (Unrelased development version. Dynamic.)
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</body>
</html>
[svn-r693] Update for beta release. Complete CVS log messages can be found with the versions of these files that are maintained in hdf5/doc/src/.
1998-09-12 00:00:43 +08:00
Reference in New Issue Copy Permalink