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
16f559cb3c
hdf5/doc/html/RM_H5.html

641 lines
23 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/H5 API Specification
[svn-r6478] Purpose: DreamWeaver (DW) adaptation of the HDF5 doc set, introducing the use of stylesheets and DW libraries. Stylesheets -- for consistent format management. DW libraries -- for managing common elements across documents. Platforms tested: IE 5 and 6 Netscape
2003-03-15 03:12:34 +08:00
</title>
[svn-r7140] Purpose: Add short copyright notice. Update release tag line. Description: Added short copyright notice as comment in source files; does not display in browser. Updated release tag line in footers to read as follows: Describes HDF5 Release 1.6.0, July 2003 Platforms tested: IE 5
2003-07-03 05:28:11 +08:00
<!-- #BeginLibraryItem "/ed_libs/styles_RM.lbi" -->
<!--
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by the Board of Trustees of the University of Illinois. *
* All rights reserved. *
* *
* This file is part of HDF5. The full HDF5 copyright notice, including *
* terms governing use, modification, and redistribution, is contained in *
* the files COPYING and Copyright.html. COPYING can be found at the root *
* of the source code distribution tree; Copyright.html can be found at the *
* root level of an installed copy of the electronic HDF5 document set and *
* is linked from the top-level documents page. It can also be found at *
* http://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html. If you do not have *
* access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
-->
<link href="ed_styles/RMelect.css" rel="stylesheet" type="text/css">
[svn-r8221] Purpose: Clean up RM formatting. Modify RM HTML code to facilitate automated generation of PDF version. Minor edits. Description: Reworked format of "Parameters" sections. Added HTML tags (and pseudo-HTML tags) used by HTMLdoc to generate PDF files. Fixed the "Copyright" link on RM_H5Front.html. Other minor copy edits. Platforms tested: IE 5
2004-02-25 06:10:12 +08:00
<!-- #EndLibraryItem --></head> <body bgcolor="#FFFFFF">
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
[svn-r6478] Purpose: DreamWeaver (DW) adaptation of the HDF5 doc set, introducing the use of stylesheets and DW libraries. Stylesheets -- for consistent format management. DW libraries -- for managing common elements across documents. Platforms tested: IE 5 and 6 Netscape
2003-03-15 03:12:34 +08:00
<!-- #BeginLibraryItem "/ed_libs/NavBar_RM.lbi" --><hr>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<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>
[svn-r6478] Purpose: DreamWeaver (DW) adaptation of the HDF5 doc set, introducing the use of stylesheets and DW libraries. Stylesheets -- for consistent format management. DW libraries -- for managing common elements across documents. Platforms tested: IE 5 and 6 Netscape
2003-03-15 03:12:34 +08:00
<a href="index.html">HDF5 documents and links</a>&nbsp;<br>
[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
<a href="H5.intro.html">Introduction to HDF5</a>&nbsp;<br>
[svn-r7159] Purpose: Changed "HDF5 User's Guide" links (in navigation bars, primarily) to point to new user's guide, which will reside for a while yet on the HDF server. The old user's guide will still go out with the distribution under the label "HDF5 User's Guide, Release 1.4.5." Platforms tested: IE 5
2003-07-04 03:40:03 +08:00
<a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/UG/index.html">HDF5 User Guide</a>&nbsp;<br>
[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
<!--
<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-r6478] Purpose: DreamWeaver (DW) adaptation of the HDF5 doc set, introducing the use of stylesheets and DW libraries. Stylesheets -- for consistent format management. DW libraries -- for managing common elements across documents. Platforms tested: IE 5 and 6 Netscape
2003-03-15 03:12:34 +08:00
<a href="RM_H5.html">H5</a>&nbsp;&nbsp;
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<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-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<a href="RM_H5P.html">H5P</a>&nbsp;&nbsp;
[svn-r3117] Purpose: Linking the new "Predefined Dataypes" document into the RM. Description: Added PredefDTypes.html link into all RM files. Platforms tested: IE 5
2000-12-13 06:43:02 +08:00
<br>
[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;
[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-r3117] Purpose: Linking the new "Predefined Dataypes" document into the RM. Description: Added PredefDTypes.html link into all RM files. Platforms tested: IE 5
2000-12-13 06:43:02 +08:00
<a href="PredefDTypes.html">Datatypes</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>
[svn-r8221] Purpose: Clean up RM formatting. Modify RM HTML code to facilitate automated generation of PDF version. Minor edits. Description: Reworked format of "Parameters" sections. Added HTML tags (and pseudo-HTML tags) used by HTMLdoc to generate PDF files. Fixed the "Copyright" link on RM_H5Front.html. Other minor copy edits. Platforms tested: IE 5
2004-02-25 06:10:12 +08:00
<hr><!-- #EndLibraryItem --><center>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<h1>H5: General Library Functions</h1>
</center>
These functions serve general-purpose needs of the HDF5 library
and it users.
[svn-r3803] Purpose: Importing RM changes from 1.4 release branch into development branch (1.5)
2001-04-12 06:45:26 +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>
<ul>
<li><a href="#Library-Open">H5open</a>
<li><a href="#Library-Close">H5close</a>
</ul>
</td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td valign=top>
<ul>
[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="#Library-Version">H5get_libversion</a>
<li><a href="#Library-VersCheck">H5check_version</a>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</ul>
</td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td valign=top>
<ul>
[svn-r6704] Purpose: Add new function. Description: Added H5set_free_list_limits. Platforms tested: Safari, IE 5
2003-04-18 05:02:41 +08:00
<li><a href="#Library-SetFreeListLimits">H5set_free_list_limits</a>
[svn-r2430] RM_H5.html Added new function H5garbage_collect.
2000-07-18 01:54:48 +08:00
<li><a href="#Library-GarbageCollect">H5garbage_collect</a>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<li><a href="#Library-DontAtExit">H5dont_atexit</a>
</ul>
</td></tr>
</table>
[svn-r7014] Purpose: To facilitate finding functions, particularly in long Reference Manual sections. Solution: Added alphabetized function listings. (NOTE: Aside from the H5I and H5Z sections, this is not necessarily the final implementation; there will likely be another revision in the presentation of this listing before it is released.) Platforms tested: Safari, IE 5
2003-06-10 23:38:46 +08:00
<br>
<i>Alphabetical Listing</i>
<table border="0">
<tr>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
[svn-r7014] Purpose: To facilitate finding functions, particularly in long Reference Manual sections. Solution: Added alphabetized function listings. (NOTE: Aside from the H5I and H5Z sections, this is not necessarily the final implementation; there will likely be another revision in the presentation of this listing before it is released.) Platforms tested: Safari, IE 5
2003-06-10 23:38:46 +08:00
<td valign="top">
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<ul>
[svn-r7014] Purpose: To facilitate finding functions, particularly in long Reference Manual sections. Solution: Added alphabetized function listings. (NOTE: Aside from the H5I and H5Z sections, this is not necessarily the final implementation; there will likely be another revision in the presentation of this listing before it is released.) Platforms tested: Safari, IE 5
2003-06-10 23:38:46 +08:00
<li><a href="#Library-VersCheck">H5check_version</a>
<li><a href="#Library-Close">H5close</a>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<li><a href="#Library-DontAtExit">H5dont_atexit</a>
</ul>
[svn-r7014] Purpose: To facilitate finding functions, particularly in long Reference Manual sections. Solution: Added alphabetized function listings. (NOTE: Aside from the H5I and H5Z sections, this is not necessarily the final implementation; there will likely be another revision in the presentation of this listing before it is released.) Platforms tested: Safari, IE 5
2003-06-10 23:38:46 +08:00
</td>
<td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td>
<td valign="top">
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<ul>
[svn-r7014] Purpose: To facilitate finding functions, particularly in long Reference Manual sections. Solution: Added alphabetized function listings. (NOTE: Aside from the H5I and H5Z sections, this is not necessarily the final implementation; there will likely be another revision in the presentation of this listing before it is released.) Platforms tested: Safari, IE 5
2003-06-10 23:38:46 +08:00
<li><a href="#Library-GarbageCollect">H5garbage_collect</a>
<li><a href="#Library-Version">H5get_libversion</a>
<li><a href="#Library-Open">H5open</a>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
</ul>
[svn-r7014] Purpose: To facilitate finding functions, particularly in long Reference Manual sections. Solution: Added alphabetized function listings. (NOTE: Aside from the H5I and H5Z sections, this is not necessarily the final implementation; there will likely be another revision in the presentation of this listing before it is released.) Platforms tested: Safari, IE 5
2003-06-10 23:38:46 +08:00
</td>
<td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td>
<td valign="top">
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<ul>
[svn-r7014] Purpose: To facilitate finding functions, particularly in long Reference Manual sections. Solution: Added alphabetized function listings. (NOTE: Aside from the H5I and H5Z sections, this is not necessarily the final implementation; there will likely be another revision in the presentation of this listing before it is released.) Platforms tested: Safari, IE 5
2003-06-10 23:38:46 +08:00
<li><a href="#Library-SetFreeListLimits">H5set_free_list_limits</a>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
</ul>
[svn-r7014] Purpose: To facilitate finding functions, particularly in long Reference Manual sections. Solution: Added alphabetized function listings. (NOTE: Aside from the H5I and H5Z sections, this is not necessarily the final implementation; there will likely be another revision in the presentation of this listing before it is released.) Platforms tested: Safari, IE 5
2003-06-10 23:38:46 +08:00
</td>
</tr>
</table>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<br>
[svn-r3803] Purpose: Importing RM changes from 1.4 release branch into development branch (1.5)
2001-04-12 06:45:26 +08:00
<strong>The FORTRAN90 Interfaces:</strong>
<br>
[svn-r9727] Purpose: Bug Fix/Code Cleanup/Doc Cleanup/Optimization/Branch Sync :-) Description: Generally speaking, this is the "signed->unsigned" change to selections. However, in the process of merging code back, things got stickier and stickier until I ended up doing a big "sync the two branches up" operation. So... I brought back all the "infrastructure" fixes from the development branch to the release branch (which I think were actually making some improvement in performance) as well as fixed several bugs which had been fixed in one branch, but not the other. I've also tagged the repository before making this checkin with the label "before_signed_unsigned_changes". Platforms tested: FreeBSD 4.10 (sleipnir) w/parallel & fphdf5 FreeBSD 4.10 (sleipnir) w/threadsafe FreeBSD 4.10 (sleipnir) w/backward compatibility Solaris 2.7 (arabica) w/"purify options" Solaris 2.8 (sol) w/FORTRAN & C++ AIX 5.x (copper) w/parallel & FORTRAN IRIX64 6.5 (modi4) w/FORTRAN Linux 2.4 (heping) w/FORTRAN & C++ Misc. update:
2004-12-29 22:26:20 +08:00
In general, each FORTRAN90 subroutine performs exactly the same task
as the corresponding C function.
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<br>
[svn-r3803] Purpose: Importing RM changes from 1.4 release branch into development branch (1.5)
2001-04-12 06:45:26 +08:00
<table border=0>
<tr><td valign=top>
<ul>
<li><a href="#Library-Open">h5open_f</a>
[svn-r6600] Purpose: Link in additional Fortran90 functions. Description: Linked 68 new Fortran90 functions to the discussions of the corresponding C functions. Made the corresponding Fortran index changes in the function listings at the tops of the RM pages. Fixed formatting and link typos in RM_H5P.html & fortran/h5p_FORTRAN.html. Platforms tested: Safari and IE 5
2003-04-09 05:33:50 +08:00
<li><a href="#Library-Close">h5close_f</a>
[svn-r3803] Purpose: Importing RM changes from 1.4 release branch into development branch (1.5)
2001-04-12 06:45:26 +08:00
</ul>
</td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td valign=top>
<ul>
[svn-r6600] Purpose: Link in additional Fortran90 functions. Description: Linked 68 new Fortran90 functions to the discussions of the corresponding C functions. Made the corresponding Fortran index changes in the function listings at the tops of the RM pages. Fixed formatting and link typos in RM_H5P.html & fortran/h5p_FORTRAN.html. Platforms tested: Safari and IE 5
2003-04-09 05:33:50 +08:00
<li><a href="#Library-Version">h5get_libversion_f</a>
<li><a href="#Library-VersCheck">h5check_version_f</a>
[svn-r3803] Purpose: Importing RM changes from 1.4 release branch into development branch (1.5)
2001-04-12 06:45:26 +08:00
</ul>
</td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td valign=top>
<ul>
[svn-r7086] Purpose: H5set_free_list_limits review feedback. Link corresponding F90 function. Description: Added explanations of regular, array, and block free lists. Copy edits. (both in response to review comments) Linked in corresponding F90 function. Platforms tested: IE 5, Safari
2003-06-24 04:35:51 +08:00
<li><a href="#Library-SetFreeListLimits">h5set_free_list_limits_f</a>
[svn-r6600] Purpose: Link in additional Fortran90 functions. Description: Linked 68 new Fortran90 functions to the discussions of the corresponding C functions. Made the corresponding Fortran index changes in the function listings at the tops of the RM pages. Fixed formatting and link typos in RM_H5P.html & fortran/h5p_FORTRAN.html. Platforms tested: Safari and IE 5
2003-04-09 05:33:50 +08:00
<li><a href="#Library-GarbageCollect">h5garbage_collect_f</a>
<li><a href="#Library-DontAtExit">h5dont_atexit_f</a>
[svn-r3803] Purpose: Importing RM changes from 1.4 release branch into development branch (1.5)
2001-04-12 06:45:26 +08:00
</ul>
</td></tr>
</table>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<!-- NEW PAGE -->
[svn-r9727] Purpose: Bug Fix/Code Cleanup/Doc Cleanup/Optimization/Branch Sync :-) Description: Generally speaking, this is the "signed->unsigned" change to selections. However, in the process of merging code back, things got stickier and stickier until I ended up doing a big "sync the two branches up" operation. So... I brought back all the "infrastructure" fixes from the development branch to the release branch (which I think were actually making some improvement in performance) as well as fixed several bugs which had been fixed in one branch, but not the other. I've also tagged the repository before making this checkin with the label "before_signed_unsigned_changes". Platforms tested: FreeBSD 4.10 (sleipnir) w/parallel & fphdf5 FreeBSD 4.10 (sleipnir) w/threadsafe FreeBSD 4.10 (sleipnir) w/backward compatibility Solaris 2.7 (arabica) w/"purify options" Solaris 2.8 (sol) w/FORTRAN & C++ AIX 5.x (copper) w/parallel & FORTRAN IRIX64 6.5 (modi4) w/FORTRAN Linux 2.4 (heping) w/FORTRAN & C++ Misc. update:
2004-12-29 22:26:20 +08:00
<!-- HEADER RIGHT " " -->
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5check_version" -->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<hr>
<dl>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<dt><strong>Name:</strong> <a name="Library-VersCheck">H5check_version</a>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Signature:</strong>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<dd><em>herr_t</em> <code>H5check_version</code>(<em>unsigned</em> <code>majnum</code>,
<em>unsigned</em> <code>minnum</code>,
<em>unsigned</em> <code>relnum</code>
)
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Purpose:</strong>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<dd>Verifies that library versions are consistent.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Description:</strong>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<dd><code>H5check_version</code> verifies that the arguments provided
with the function call match the version numbers compiled into
the library.
<p>
<code>H5check_version</code> serves two slightly differing purposes.
<p>
First, the function is intended to be called by the user to verify
that the version of the header files compiled into an application
matches the version of the HDF5 library being used.
One may look at the <code>H5check</code> definition in the file
<code>H5public.h</code> as an example.
<p>
Due to the risks of data corruption or segmentation faults,
<code>H5check_version</code> causes the application to abort if the
version numbers do not match.
The abort is achieved by means of a call to the
standard C function <code>abort()</code>.
<p>
Note that <code>H5check_version</code> verifies only the
major and minor version numbers and the release number;
it does not verify the sub-release value as that should be
an empty string for any official release.
This means that any two incompatible library versions must
have different {major,minor,release} numbers. (Notice the
reverse is not necessarily true.)
<p>
Secondarily, <code>H5check_version</code> verifies that the
library version identifiers <code>H5_VERS_MAJOR</code>,
<code>H5_VERS_MINOR</code>, <code>H5_VERS_RELEASE</code>,
<code>H5_VERS_SUBRELEASE</code>, and <code>H5_VERS_INFO</code>
are consistent.
This is designed to catch source code inconsistencies,
but does not generate the fatal error as in the first stage
because this inconsistency does not cause errors in the data files.
If this check reveals inconsistencies, the library issues a warning
but the function does not fail.
<!--
<p>
<strong><em>Alternate to preceding paragraph / More to the point?</em></strong>
<br>
If the function passes the above test and does not generate
an <code>abort()</code> call, the function's second purpose
comes into play.
<code>H5check_version</code> then procedes to verify
that the additional library version identifiers
<code>H5_VERS_SUBRELEASE</code>, and <code>H5_VERS_INFO</code>
are consistent.
This is designed to catch source code inconsistencies,
but does not generate the fatal error
that is generated under the first function.
<p>
The version and release numbers passed as
<code>H5check_version</code> parameters have the
following relationsips to each other:
<dir>
An official HDF5 release is labelled as
<br>
HDF5 Release &lt;<code>majnum</code>&gt;<strong>.</strong>&lt;<code>minnum</code>&gt;<strong>.</strong>&lt;<code>relnum</code>&gt;
</dir>
For example, in the version of the library known as HDF5 Release 1.4.2,
the 1 is the major version number, <code>majnum</code>;
the 1 is the minor version number, <code>minnum</code>; and
the 1 is the release number, <code>relnum</code>.
-->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Parameters:</strong>
[svn-r8221] Purpose: Clean up RM formatting. Modify RM HTML code to facilitate automated generation of PDF version. Minor edits. Description: Reworked format of "Parameters" sections. Added HTML tags (and pseudo-HTML tags) used by HTMLdoc to generate PDF files. Fixed the "Copyright" link on RM_H5Front.html. Other minor copy edits. Platforms tested: IE 5
2004-02-25 06:10:12 +08:00
<ul><table>
<tr>
<td valign="top"><em>unsigned </em><code>majnum</code></td>
<td valign="top">IN: The major version of the library.</td></tr>
<tr>
<td valign="top"><em>unsigned&nbsp;</em><code>minnum&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
<td valign="top">IN: The minor version of the library.</td></tr>
<tr>
<td valign="top"><em>unsigned </em><code>relnum</code></td>
<td valign="top">IN: The release number of the library.</td></tr>
</table></ul>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Returns:</strong>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<dd>Returns a non-negative value if successful.
Upon failure, this function causes the application to abort.
[svn-r7599] Purpose: Integrate Fortran90 interfaces into C RM. Solution: Remove "Non-C APIs" sections. Add "Fortran90 Interfaces" sections with F90 descriptions. Platforms tested: IE 5, Safari
2003-10-10 23:53:24 +08:00
<dt><strong>Fortran90 Interface:</strong> h5check_version_f
<dd>
<pre>
SUBROUTINE h5check_version_f(hdferr)
IMPLICIT NONE
INTEGER, INTENT(IN) :: majnum ! The major version of the library
INTEGER, INTENT(IN) :: minnum ! The minor version of the library
INTEGER, INTENT(IN) :: relnum ! The release number
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5check_version_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
[svn-r3803] Purpose: Importing RM changes from 1.4 release branch into development branch (1.5)
2001-04-12 06:45:26 +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>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5close" -->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Library-Close">H5close</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5close</code>(<em>void</em>)
<dt><strong>Purpose:</strong>
<dd>Flushes all data to disk, closes file identifiers, and cleans up memory.
<dt><strong>Description:</strong>
<dd><code>H5close</code> flushes all data to disk,
closes all file identifiers, and cleans up all memory used by
[svn-r3803] Purpose: Importing RM changes from 1.4 release branch into development branch (1.5)
2001-04-12 06:45:26 +08:00
the library. This function is generally called when the
[svn-r7680] Purpose: Expand H5open/h5open_f and H5close/h5close_f descriptions to indicate that these two calls are mandatory in Fortran90 applications (though optional in C). Platforms tested: IE 5, Safari
2003-10-21 06:23:33 +08:00
application calls <code>exit()</code>, but may be called earlier
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
in event of an emergency shutdown or out of desire to free all
resources used by the HDF5 library.
[svn-r7680] Purpose: Expand H5open/h5open_f and H5close/h5close_f descriptions to indicate that these two calls are mandatory in Fortran90 applications (though optional in C). Platforms tested: IE 5, Safari
2003-10-21 06:23:33 +08:00
<p>
<code>h5close_f</code> and <code>h5open_f</code> are
required calls in Fortran90 applications.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Parameters:</strong>
<dl>
<dt>None.
</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-r7599] Purpose: Integrate Fortran90 interfaces into C RM. Solution: Remove "Non-C APIs" sections. Add "Fortran90 Interfaces" sections with F90 descriptions. Platforms tested: IE 5, Safari
2003-10-10 23:53:24 +08:00
<dt><strong>Fortran90 Interface:</strong> h5close_f
<dd>
<pre>
SUBROUTINE h5close_f(hdferr)
IMPLICIT NONE
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5close_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
[svn-r3803] Purpose: Importing RM changes from 1.4 release branch into development branch (1.5)
2001-04-12 06:45:26 +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>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5H5dont_atexit" -->
[svn-r6704] Purpose: Add new function. Description: Added H5set_free_list_limits. Platforms tested: Safari, IE 5
2003-04-18 05:02:41 +08:00
<hr>
<dl>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<dt><strong>Name:</strong> <a name="Library-DontAtExit">H5dont_atexit</a>
[svn-r6704] Purpose: Add new function. Description: Added H5set_free_list_limits. Platforms tested: Safari, IE 5
2003-04-18 05:02:41 +08:00
<dt><strong>Signature:</strong>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<dd><em>herr_t</em> <code>H5dont_atexit</code>(<em>void</em>)
[svn-r6704] Purpose: Add new function. Description: Added H5set_free_list_limits. Platforms tested: Safari, IE 5
2003-04-18 05:02:41 +08:00
<dt><strong>Purpose:</strong>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<dd>Instructs library not to install <code>atexit</code> cleanup routine.
[svn-r6704] Purpose: Add new function. Description: Added H5set_free_list_limits. Platforms tested: Safari, IE 5
2003-04-18 05:02:41 +08:00
<dt><strong>Description:</strong>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<dd><code>H5dont_atexit</code> indicates to the library that an
<code>atexit()</code> cleanup routine should not be installed.
The major purpose for this is in situations where the
library is dynamically linked into an application and is
un-linked from the application before <code>exit()</code> gets
called. In those situations, a routine installed with
<code>atexit()</code> would jump to a routine which was
no longer in memory, causing errors.
<p>
In order to be effective, this routine <em>must</em> be called
before any other HDF function calls, and must be called each
time the library is loaded/linked into the application
(the first time and after it's been un-loaded).
[svn-r6704] Purpose: Add new function. Description: Added H5set_free_list_limits. Platforms tested: Safari, IE 5
2003-04-18 05:02:41 +08:00
<dt><strong>Parameters:</strong>
<dl>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<dt>None.
[svn-r6704] Purpose: Add new function. Description: Added H5set_free_list_limits. Platforms tested: Safari, IE 5
2003-04-18 05:02:41 +08:00
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r7599] Purpose: Integrate Fortran90 interfaces into C RM. Solution: Remove "Non-C APIs" sections. Add "Fortran90 Interfaces" sections with F90 descriptions. Platforms tested: IE 5, Safari
2003-10-10 23:53:24 +08:00
<dt><strong>Fortran90 Interface:</strong> h5dont_atexit_f
<dd>
<pre>
SUBROUTINE h5dont_atexit_f(hdferr)
IMPLICIT NONE
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5dont_atexit_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
[svn-r6704] Purpose: Add new function. Description: Added H5set_free_list_limits. Platforms tested: Safari, IE 5
2003-04-18 05:02:41 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5garbage_collect" -->
[svn-r2430] RM_H5.html Added new function H5garbage_collect.
2000-07-18 01:54:48 +08:00
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Library-GarbageCollect">H5garbage_collect</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5garbage_collect</code>(<em>void</em>)
<dt><strong>Purpose:</strong>
<dd>Garbage collects on all free-lists of all types.
<dt><strong>Description:</strong>
<dd><code>H5garbage_collect</code> walks through all the garbage
collection routines of the library, freeing any unused memory.
<p>
It is not required that <code>H5garbage_collect</code> be called
at any particular time; it is only necessary in certain situations
where the application has performed actions that cause the library
to allocate many objects. The application should call
<code>H5garbage_collect</code> if it eventually releases those
objects and wants to reduce the memory used by the library from
the peak usage required.
<p>
The library automatically garbage collects all the free lists
when the application ends.
<dt><strong>Parameters:</strong>
<dl>
<dt>None.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r7599] Purpose: Integrate Fortran90 interfaces into C RM. Solution: Remove "Non-C APIs" sections. Add "Fortran90 Interfaces" sections with F90 descriptions. Platforms tested: IE 5, Safari
2003-10-10 23:53:24 +08:00
<dt><strong>Fortran90 Interface:</strong> h5garbage_collect_f
<dd>
<pre>
SUBROUTINE h5garbage_collect_f(hdferr)
IMPLICIT NONE
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5garbage_collect_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
[svn-r3803] Purpose: Importing RM changes from 1.4 release branch into development branch (1.5)
2001-04-12 06:45:26 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
[svn-r2430] RM_H5.html Added new function H5garbage_collect.
2000-07-18 01:54:48 +08:00
</dl>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5get_libversion" -->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<hr>
<dl>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<dt><strong>Name:</strong> <a name="Library-Version">H5get_libversion</a>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Signature:</strong>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<dd><em>herr_t</em> <code>H5get_libversion</code>(<em>unsigned *</em><code>majnum</code>,
<em>unsigned *</em><code>minnum</code>,
<em>unsigned *</em><code>relnum</code>
)
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Purpose:</strong>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<dd>Returns the HDF library release number.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Description:</strong>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<dd><code>H5get_libversion</code> retrieves the major, minor, and release
numbers of the version of the HDF library which is linked to
the application.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Parameters:</strong>
[svn-r8221] Purpose: Clean up RM formatting. Modify RM HTML code to facilitate automated generation of PDF version. Minor edits. Description: Reworked format of "Parameters" sections. Added HTML tags (and pseudo-HTML tags) used by HTMLdoc to generate PDF files. Fixed the "Copyright" link on RM_H5Front.html. Other minor copy edits. Platforms tested: IE 5
2004-02-25 06:10:12 +08:00
<ul><table>
<tr>
<td valign="top"><em>unsigned *</em><code>majnum</code></td>
<td valign="top">OUT: The major version of the library.</td></tr>
<tr>
<td valign="top"><em>unsigned&nbsp;*</em><code>minnum&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
<td valign="top">OUT: The minor version of the library.</td></tr>
<tr>
<td valign="top"><em>unsigned *</em><code>relnum</code></td>
<td valign="top">OUT: The release number of the library.</td></tr>
</table></ul>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<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-r7599] Purpose: Integrate Fortran90 interfaces into C RM. Solution: Remove "Non-C APIs" sections. Add "Fortran90 Interfaces" sections with F90 descriptions. Platforms tested: IE 5, Safari
2003-10-10 23:53:24 +08:00
<dt><strong>Fortran90 Interface:</strong> h5get_libversion_f
<dd>
<pre>
SUBROUTINE h5get_libversion_f(hdferr)
IMPLICIT NONE
INTEGER, INTENT(OUT) :: majnum ! The major version of the library
INTEGER, INTENT(OUT) :: minnum ! The minor version of the library
INTEGER, INTENT(OUT) :: relnum ! The release number
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5get_libversion_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
[svn-r3803] Purpose: Importing RM changes from 1.4 release branch into development branch (1.5)
2001-04-12 06:45:26 +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>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5open" -->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<hr>
<dl>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<dt><strong>Name:</strong> <a name="Library-Open">H5open</a>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Signature:</strong>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<dd><em>herr_t</em> <code>H5open</code>(<em>void</em>)
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Purpose:</strong>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<dd>Initializes the HDF5 library.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Description:</strong>
[svn-r7680] Purpose: Expand H5open/h5open_f and H5close/h5close_f descriptions to indicate that these two calls are mandatory in Fortran90 applications (though optional in C). Platforms tested: IE 5, Safari
2003-10-21 06:23:33 +08:00
<dd><code>H5open</code> initialize the library.
<p>
When the HDF5 Library is employed in a C application,
this function is normally called automatically, but if you
find that an HDF5 library function is failing inexplicably,
try calling this function first.
If you wish to elimnate this possibility, it is safe to
routinely call <code>H5open</code> before an application
starts working with the library as there are no damaging
side-effects in calling it more than once.
<p>
When the HDF5 Library is employed in a Fortran90 application,
<code>h5open_f</code> initializes global variables
(e.g. predefined types) and performs other tasks required to
initialize the library.
<code>h5open_f</code> and <code>h5close_f</code> are therefore
required calls in Fortran90 applications.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Parameters:</strong>
<dl>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<dt>None.
[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-r7599] Purpose: Integrate Fortran90 interfaces into C RM. Solution: Remove "Non-C APIs" sections. Add "Fortran90 Interfaces" sections with F90 descriptions. Platforms tested: IE 5, Safari
2003-10-10 23:53:24 +08:00
<dt><strong>Fortran90 Interface:</strong> h5open_f
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<dd>
[svn-r7599] Purpose: Integrate Fortran90 interfaces into C RM. Solution: Remove "Non-C APIs" sections. Add "Fortran90 Interfaces" sections with F90 descriptions. Platforms tested: IE 5, Safari
2003-10-10 23:53:24 +08:00
<pre>
SUBROUTINE h5open_f(hdferr)
IMPLICIT NONE
INTEGER, INTENT(OUT) :: hdferr ! Error code
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
[svn-r7599] Purpose: Integrate Fortran90 interfaces into C RM. Solution: Remove "Non-C APIs" sections. Add "Fortran90 Interfaces" sections with F90 descriptions. Platforms tested: IE 5, Safari
2003-10-10 23:53:24 +08:00
END SUBROUTINE h5open_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
[svn-r3803] Purpose: Importing RM changes from 1.4 release branch into development branch (1.5)
2001-04-12 06:45:26 +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>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5set_free_list_limits" -->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<hr>
<dl>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<dt><strong>Name:</strong> <a name="Library-SetFreeListLimits">H5set_free_list_limits</a>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Signature:</strong>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<dd><em>herr_t</em> <code>H5set_free_list_limits</code>(<em>int</em> <code>reg_global_lim</code>,
<em>int</em> <code>reg_list_lim</code>,
<em>int</em> <code>arr_global_lim</code>,
<em>int</em> <code>arr_list_lim</code>,
<em>int</em> <code>blk_global_lim</code>,
<em>int</em> <code>blk_list_lim</code>
)
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Purpose:</strong>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<dd>Sets free-list size limits.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Description:</strong>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<dd><code>H5set_free_list_limits</code> sets size limits
on all types of free lists.
The HDF5 library uses free lists internally to manage memory.
There are three types of free lists:
<ul><li><span class=termDef>Regular</span>
free lists manage a single data structure.
<li><span class=termDef>Array</span>
free lists manage arrays of a data structure.
<li><span class=termDef>Block</span>
free lists manage blocks of bytes.
</ul>
<em>Alternate phrasing?</em>:
<ul><li><span class=termDef>Regular</span>
free lists manage data structures containing atomic data.
<li><span class=termDef>Array</span>
free lists manage data structures containing array data.
<li><span class=termDef>Block</span>
free lists manage blocks of bytes.
</ul>
<p>
These are global limits, but each limit applies only to
free lists of the specified type.
Therefore, if an application sets a 1Mb limit on each of
the global lists, up to 3Mb of total storage might be
allocated, 1Mb for each of the regular, array, and
block type lists.
<p>
Using a value of <code>-1</code> for a limit means that
no limit is set for the specified type of free list.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Parameters:</strong>
[svn-r8221] Purpose: Clean up RM formatting. Modify RM HTML code to facilitate automated generation of PDF version. Minor edits. Description: Reworked format of "Parameters" sections. Added HTML tags (and pseudo-HTML tags) used by HTMLdoc to generate PDF files. Fixed the "Copyright" link on RM_H5Front.html. Other minor copy edits. Platforms tested: IE 5
2004-02-25 06:10:12 +08:00
<ul><table>
<tr>
<td valign="top"><em>int</em>&nbsp;<code>reg_global_lim&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
<td valign="top">IN: The limit on all regular free list memory used</td></tr>
<tr>
<td valign="top"><em>int</em> <code>reg_list_lim</code></td>
<td valign="top">IN: The limit on memory used in each regular free list</td></tr>
<tr>
<td valign="top"><em>int</em> <code>arr_global_lim</code></td>
<td valign="top">IN: The limit on all array free list memory used</td></tr>
<tr>
<td valign="top"><em>int</em> <code>arr_list_lim</code></td>
<td valign="top">IN: The limit on memory used in each array free list</td></tr>
<tr>
<td valign="top"><em>int</em> <code>blk_global_lim</code></td>
<td valign="top">IN: The limit on all block free list memory used</td></tr>
<tr>
<td valign="top"><em>int</em> <code>blk_list_lim</code></td>
<td valign="top">IN: The limit on memory used in each block free list</td></tr>
</table></ul>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Returns:</strong>
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r7599] Purpose: Integrate Fortran90 interfaces into C RM. Solution: Remove "Non-C APIs" sections. Add "Fortran90 Interfaces" sections with F90 descriptions. Platforms tested: IE 5, Safari
2003-10-10 23:53:24 +08:00
<dt><strong>Fortran90 Interface:</strong>
<dd>None.
<!--
<pre>
SUBROUTINE
</pre>
-->
<!--<dt><strong>Non-C API(s):</strong>
<dd>
[svn-r3803] Purpose: Importing RM changes from 1.4 release branch into development branch (1.5)
2001-04-12 06:45:26 +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>
[svn-r6478] Purpose: DreamWeaver (DW) adaptation of the HDF5 doc set, introducing the use of stylesheets and DW libraries. Stylesheets -- for consistent format management. DW libraries -- for managing common elements across documents. Platforms tested: IE 5 and 6 Netscape
2003-03-15 03:12:34 +08:00
<!-- #BeginLibraryItem "/ed_libs/NavBar_RM.lbi" --><hr>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<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>
[svn-r6478] Purpose: DreamWeaver (DW) adaptation of the HDF5 doc set, introducing the use of stylesheets and DW libraries. Stylesheets -- for consistent format management. DW libraries -- for managing common elements across documents. Platforms tested: IE 5 and 6 Netscape
2003-03-15 03:12:34 +08:00
<a href="index.html">HDF5 documents and links</a>&nbsp;<br>
[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
<a href="H5.intro.html">Introduction to HDF5</a>&nbsp;<br>
[svn-r7159] Purpose: Changed "HDF5 User's Guide" links (in navigation bars, primarily) to point to new user's guide, which will reside for a while yet on the HDF server. The old user's guide will still go out with the distribution under the label "HDF5 User's Guide, Release 1.4.5." Platforms tested: IE 5
2003-07-04 03:40:03 +08:00
<a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/UG/index.html">HDF5 User Guide</a>&nbsp;<br>
[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
<!--
<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-r6478] Purpose: DreamWeaver (DW) adaptation of the HDF5 doc set, introducing the use of stylesheets and DW libraries. Stylesheets -- for consistent format management. DW libraries -- for managing common elements across documents. Platforms tested: IE 5 and 6 Netscape
2003-03-15 03:12:34 +08:00
<a href="RM_H5.html">H5</a>&nbsp;&nbsp;
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<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-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<a href="RM_H5P.html">H5P</a>&nbsp;&nbsp;
[svn-r3117] Purpose: Linking the new "Predefined Dataypes" document into the RM. Description: Added PredefDTypes.html link into all RM files. Platforms tested: IE 5
2000-12-13 06:43:02 +08:00
<br>
[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;
[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-r3117] Purpose: Linking the new "Predefined Dataypes" document into the RM. Description: Added PredefDTypes.html link into all RM files. Platforms tested: IE 5
2000-12-13 06:43:02 +08:00
<a href="PredefDTypes.html">Datatypes</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>
[svn-r8221] Purpose: Clean up RM formatting. Modify RM HTML code to facilitate automated generation of PDF version. Minor edits. Description: Reworked format of "Parameters" sections. Added HTML tags (and pseudo-HTML tags) used by HTMLdoc to generate PDF files. Fixed the "Copyright" link on RM_H5Front.html. Other minor copy edits. Platforms tested: IE 5
2004-02-25 06:10:12 +08:00
<hr><!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
[svn-r2430] RM_H5.html Added new function H5garbage_collect.
2000-07-18 01:54:48 +08:00
<br>
[svn-r7758] Purpose: Updated footers to "Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0" Platforms tested: IE 5, Safari
2003-10-28 05:55:13 +08:00
Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
</address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT">
<!--
[svn-r8221] Purpose: Clean up RM formatting. Modify RM HTML code to facilitate automated generation of PDF version. Minor edits. Description: Reworked format of "Parameters" sections. Added HTML tags (and pseudo-HTML tags) used by HTMLdoc to generate PDF files. Fixed the "Copyright" link on RM_H5Front.html. Other minor copy edits. Platforms tested: IE 5
2004-02-25 06:10:12 +08:00
document.writeln("Last modified: 24 February 2004");
[svn-r7565] Purpose: Aphabetic sort of RM function entries Minor formatting Platforms tested: IE 5, Safari
2003-10-08 03:18:32 +08:00
-->
</SCRIPT>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</body>
</html>
Reference in New Issue Copy Permalink