mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2025-01-30 15:32:37 +08:00
Code Issues Packages Projects Releases Wiki Activity
9fb77d56b8
hdf5/doc/html/RM_H5E.html

734 lines
26 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/H5E 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">
<!-- #EndLibraryItem --></head>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
[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-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
<!-- HEADER RIGHT " " -->
[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
[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-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;
[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_H5E.html">H5E</a>&nbsp;&nbsp;
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<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>H5E: Error Interface</h1>
</center>
<h2>Error API Functions</h2>
These functions provide error handling capabilities in the HDF5 environment.
[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>
<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="#Error-Clear">H5Eclear</a>
[svn-r2873] Purpose: Adding all functions new to Release 1.4. Solution: Adding first cut of all new API functions. H5Dvlen_get_buf_size H5Epush H5Pset_fapl_family H5Pget_fapl_family H5Pset_fapl_mpio H5Pget_fapl_mpio H5Pset_dxpl_mpio H5Pget_dxpl_mpio H5Pset_fapl_multi H5Pget_fapl_multi H5Pset_dxpl_multi H5Pget_dxpl_multi H5Pset_fapl_split H5Pset_fapl_sec2 H5Pset_fapl_stdio H5Pset_fapl_stream H5Pget_fapl_stream H5Pset_fapl_log H5Pset_driver H5Pget_driver H5Pget_driver_info H5Pset_meta_block_size H5Pget_meta_block_size H5Pset_sieve_buf_size H5Pget_sieve_buf_size H5Pset_fapl_dpss H5Pset_fapl_gass H5Pget_fapl_gass H5Pset_fapl_srb H5Pget_fapl_srb H5Tarray_create H5Tget_array_ndims H5Tget_array_dims Platforms tested: IE 5.
2000-11-14 00:35:49 +08:00
<li><a href="#Error-Print">H5Eprint</a>
<li><a href="#Error-Push">H5Epush</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-r2873] Purpose: Adding all functions new to Release 1.4. Solution: Adding first cut of all new API functions. H5Dvlen_get_buf_size H5Epush H5Pset_fapl_family H5Pget_fapl_family H5Pset_fapl_mpio H5Pget_fapl_mpio H5Pset_dxpl_mpio H5Pget_dxpl_mpio H5Pset_fapl_multi H5Pget_fapl_multi H5Pset_dxpl_multi H5Pget_dxpl_multi H5Pset_fapl_split H5Pset_fapl_sec2 H5Pset_fapl_stdio H5Pset_fapl_stream H5Pget_fapl_stream H5Pset_fapl_log H5Pset_driver H5Pget_driver H5Pget_driver_info H5Pset_meta_block_size H5Pget_meta_block_size H5Pset_sieve_buf_size H5Pget_sieve_buf_size H5Pset_fapl_dpss H5Pset_fapl_gass H5Pget_fapl_gass H5Pset_fapl_srb H5Pget_fapl_srb H5Tarray_create H5Tget_array_ndims H5Tget_array_dims Platforms tested: IE 5.
2000-11-14 00:35:49 +08:00
<li><a href="#Error-SetAuto">H5Eset_auto</a>
<li><a href="#Error-GetAuto">H5Eget_auto</a>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<li><a href="#Error-Walk">H5Ewalk</a>
</ul>
</td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td valign=top>
<ul>
[svn-r2873] Purpose: Adding all functions new to Release 1.4. Solution: Adding first cut of all new API functions. H5Dvlen_get_buf_size H5Epush H5Pset_fapl_family H5Pget_fapl_family H5Pset_fapl_mpio H5Pget_fapl_mpio H5Pset_dxpl_mpio H5Pget_dxpl_mpio H5Pset_fapl_multi H5Pget_fapl_multi H5Pset_dxpl_multi H5Pget_dxpl_multi H5Pset_fapl_split H5Pset_fapl_sec2 H5Pset_fapl_stdio H5Pset_fapl_stream H5Pget_fapl_stream H5Pset_fapl_log H5Pset_driver H5Pget_driver H5Pget_driver_info H5Pset_meta_block_size H5Pget_meta_block_size H5Pset_sieve_buf_size H5Pget_sieve_buf_size H5Pset_fapl_dpss H5Pset_fapl_gass H5Pget_fapl_gass H5Pset_fapl_srb H5Pget_fapl_srb H5Tarray_create H5Tget_array_ndims H5Tget_array_dims Platforms tested: IE 5.
2000-11-14 00:35:49 +08:00
<li><a href="#Error-WalkCB">H5Ewalk_cb</a>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<li><a href="#Error-GetMajor">H5Eget_major</a>
<li><a href="#Error-GetMinor">H5Eget_minor</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>
<td valign="top">
[svn-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +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="#Error-Clear">H5Eclear</a>
<li><a href="#Error-GetAuto">H5Eget_auto</a>
[svn-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
<li><a href="#Error-GetMajor">H5Eget_major</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-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +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="#Error-GetMinor">H5Eget_minor</a>
<li><a href="#Error-Print">H5Eprint</a>
<li><a href="#Error-Push">H5Epush</a>
[svn-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +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-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +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="#Error-SetAuto">H5Eset_auto</a>
<li><a href="#Error-Walk">H5Ewalk</a>
<li><a href="#Error-WalkCB">H5Ewalk_cb</a>
[svn-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +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-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
<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
<strong>The FORTRAN90 Interfaces:</strong>
<br>
[svn-r7691] Description: Integrate Fortran90 function descriptions Remove "Non-C APIs" sections; add "Fortran90 Interface" sections Remove note that Fortran APIs are described in a separate window Platforms tested: Safari
2003-10-22 06:18:46 +08:00
In general, each FORTRAN90 subroutine performs exactly the same task
as the corresponding C function.
<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
<table border=0>
<tr><td valign=top>
<ul>
<li><a href="#Error-Clear">h5eclear_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="#Error-Print">h5eprint_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
</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="#Error-SetAuto">h5eset_auto_f</a>
<!--<li><a href="#Error-GetAuto">h5eget_auto_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="#Error-Walk">h5ewalk_f</a> -->
<!--<li><a href="#Error-WalkCB">h5ewalk_cb_f</a> -->
</ul>
</td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td valign=top>
<ul>
<li><a href="#Error-GetMajor">h5eget_major_f</a>
<li><a href="#Error-GetMinor">h5eget_minor_f</a>
</ul>
</td></tr>
</table>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<p>
The Error interface provides error handling in the form of a stack.
The <code>FUNC_ENTER()</code> macro clears the error stack whenever
an interface function is entered.
When an error is detected, an entry is pushed onto the stack.
As the functions unwind, additional entries are pushed onto the stack.
The API function will return some indication that an error occurred and
the application can print the error stack.
<p>
[svn-r4837] Purpose: Bugfix. Copy edits. Description: Added IN/OUT designations to parameters. Copy edits. Removed () from public H5 functions in running text. Platforms tested: IE 5
2002-01-17 02:45:29 +08:00
Certain API functions in the H5E package, such as <code>H5Eprint</code>,
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
do not clear the error stack. Otherwise, any function which
does not have an underscore immediately after the package name
[svn-r4837] Purpose: Bugfix. Copy edits. Description: Added IN/OUT designations to parameters. Copy edits. Removed () from public H5 functions in running text. Platforms tested: IE 5
2002-01-17 02:45:29 +08:00
will clear the error stack. For instance, <code>H5Fopen</code>
clears the error stack while <code>H5F_open</code> does not.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<p>
An error stack has a fixed maximum size.
If this size is exceeded then the stack will be truncated and only the
inner-most functions will have entries on the stack.
This is expected to be a rare condition.
<p>
Each thread has its own error stack, but since
multi-threading has not been added to the library yet, this
package maintains a single error stack. The error stack is
statically allocated to reduce the complexity of handling
errors within the H5E package.
[svn-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
<!-- NEW PAGE -->
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Eclear" -->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<hr>
<dl>
[svn-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
<dt><strong>Name:</strong> <a name="Error-Clear">H5Eclear</a>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Signature:</strong>
[svn-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
<dd><em>herr_t</em> <code>H5Eclear</code>(<code>void</code>)
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Purpose:</strong>
[svn-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
<dd>Clears the error stack for the current thread.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Description:</strong>
[svn-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
<dd><code>H5Eclear</code> clears the error stack for the current thread.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<p>
[svn-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
The stack is also cleared whenever an API function is called,
with certain exceptions (for instance, <code>H5Eprint</code>).
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<p>
[svn-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
<code>H5Eclear</code> can fail if there are problems initializing
the library.
[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">None</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-r7691] Description: Integrate Fortran90 function descriptions Remove "Non-C APIs" sections; add "Fortran90 Interface" sections Remove note that Fortran APIs are described in a separate window Platforms tested: Safari
2003-10-22 06:18:46 +08:00
<dt><strong>Fortran90 Interface:</strong> h5eclear_f
<dd>
<pre>
SUBROUTINE h5eclear_f(hdferr)
IMPLICIT NONE
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5eclear_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
[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
<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-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Eget_auto" -->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Error-GetAuto">H5Eget_auto</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Eget_auto</code>(<em>H5E_auto_t *</em> <code>func</code>,
<em>void **</em><code>client_data</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns the current settings for the automatic error stack
traversal function and its data.
<dt><strong>Description:</strong>
<dd><code>H5Eget_auto</code> returns the current settings for the
automatic error stack traversal function, <code>func</code>,
and its data, <code>client_data</code>. Either (or both)
arguments may be null in which case the value is not returned.
<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>H5E_auto_t *</em> <code>func</code></td>
<td valign="top">OUT: Current setting for the function to be called upon an
error condition.</td></tr>
<tr>
<td valign="top"><em>void&nbsp;**</em><code>client_data&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
<td valign="top">OUT: Current setting for the data passed to the error function.</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-r7691] Description: Integrate Fortran90 function descriptions Remove "Non-C APIs" sections; add "Fortran90 Interface" sections Remove note that Fortran APIs are described in a separate window Platforms tested: Safari
2003-10-22 06:18:46 +08:00
<dt><strong>Fortran90 Interface:</strong>
<dd>None.
[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-r7691] Description: Integrate Fortran90 function descriptions Remove "Non-C APIs" sections; add "Fortran90 Interface" sections Remove note that Fortran APIs are described in a separate window Platforms tested: Safari
2003-10-22 06:18:46 +08:00
<pre>
SUBROUTINE
</pre>
-->
<!--<dt><strong>Non-C API(s):</strong>
<dd>
[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
<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-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Eget_major" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Error-GetMajor">H5Eget_major</a>
<dt><strong>Signature:</strong>
<dd><em>const char *</em> <code>H5Eget_major</code>(<em>H5E_major_t</em> <code>n</code>)
<dt><strong>Purpose:</strong>
<dd>Returns a character string describing an error specified by a
major error number.
<dt><strong>Description:</strong>
<dd>Given a major error number, <code>H5Eget_major</code> returns a
constant character string that describes the error.
<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>H5E_major_t</em>&nbsp;<code>n&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
<td valign="top">IN: Major error number.</td></tr>
</table></ul>
[svn-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
<dt><strong>Returns:</strong>
<dd> Returns a character string describing the error if successful.
Otherwise returns "Invalid major error number."
[svn-r7691] Description: Integrate Fortran90 function descriptions Remove "Non-C APIs" sections; add "Fortran90 Interface" sections Remove note that Fortran APIs are described in a separate window Platforms tested: Safari
2003-10-22 06:18:46 +08:00
<dt><strong>Fortran90 Interface:</strong> h5eget_major_f
<dd>
<pre>
SUBROUTINE h5eget_major_f(error_no, name, hdferr)
INTEGER, INTENT(IN) :: error_no !Major error number
CHARACTER(LEN=*), INTENT(OUT) :: name ! File name
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5eget_major_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
[svn-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Eget_minor" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Error-GetMinor">H5Eget_minor</a>
<dt><strong>Signature:</strong>
<dd><em>const char *</em> <code>H5Eget_minor</code>(<em>H5E_minor_t</em> <code>n</code>)
<dt><strong>Purpose:</strong>
<dd>Returns a character string describing an error specified by a
minor error number.
<dt><strong>Description:</strong>
<dd>Given a minor error number, <code>H5Eget_minor</code> returns a
constant character string that describes the error.
<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>H5E_minor_t</em>&nbsp;<code>n&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
<td valign="top">IN: Minor error number.</td></tr>
</table></ul>
[svn-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
<dt><strong>Returns:</strong>
<dd> Returns a character string describing the error if successful.
Otherwise returns "Invalid minor error number."
[svn-r7691] Description: Integrate Fortran90 function descriptions Remove "Non-C APIs" sections; add "Fortran90 Interface" sections Remove note that Fortran APIs are described in a separate window Platforms tested: Safari
2003-10-22 06:18:46 +08:00
<dt><strong>Fortran90 Interface:</strong> h5eget_minor_f
<dd>
<pre>
SUBROUTINE h5eget_minor_f(error_no, name, hdferr)
INTEGER, INTENT(IN) :: error_no !Major error number
CHARACTER(LEN=*), INTENT(OUT) :: name ! File name
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5eget_minor_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
[svn-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
<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
[svn-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Eprint" -->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<hr>
<dl>
[svn-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
<dt><strong>Name:</strong> <a name="Error-Print">H5Eprint</a>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Signature:</strong>
[svn-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
<dd><em>herr_t</em> <code>H5Eprint</code>(<em>FILE *</em> <code>stream</code>)
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Purpose:</strong>
[svn-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
<dd>Prints the error stack in a default manner.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Description:</strong>
[svn-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
<dd><code>H5Eprint</code> prints the error stack on the specified
stream, <code>stream</code>.
Even if the error stack is empty, a one-line message will be printed:
<br>&nbsp;&nbsp;&nbsp;&nbsp;
<code>HDF5-DIAG: Error detected in thread 0.</code>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<p>
[svn-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
<code>H5Eprint</code> is a convenience function for
<code>H5Ewalk</code> with a function that prints error messages.
Users are encouraged to write their own more specific error handlers.
[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>FILE&nbsp;*</em>&nbsp;<code>stream&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
<td valign="top">IN: File pointer, or stderr if NULL.</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-r7691] Description: Integrate Fortran90 function descriptions Remove "Non-C APIs" sections; add "Fortran90 Interface" sections Remove note that Fortran APIs are described in a separate window Platforms tested: Safari
2003-10-22 06:18:46 +08:00
<dt><strong>Fortran90 Interface:</strong> h5eprint_f
<dd>
<pre>
SUBROUTINE h5eprint_f(hdferr, name)
CHARACTER(LEN=*), OPTIONAL, INTENT(IN) :: name ! File name
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5eprint_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
[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
<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-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Epush" -->
[svn-r2873] Purpose: Adding all functions new to Release 1.4. Solution: Adding first cut of all new API functions. H5Dvlen_get_buf_size H5Epush H5Pset_fapl_family H5Pget_fapl_family H5Pset_fapl_mpio H5Pget_fapl_mpio H5Pset_dxpl_mpio H5Pget_dxpl_mpio H5Pset_fapl_multi H5Pget_fapl_multi H5Pset_dxpl_multi H5Pget_dxpl_multi H5Pset_fapl_split H5Pset_fapl_sec2 H5Pset_fapl_stdio H5Pset_fapl_stream H5Pget_fapl_stream H5Pset_fapl_log H5Pset_driver H5Pget_driver H5Pget_driver_info H5Pset_meta_block_size H5Pget_meta_block_size H5Pset_sieve_buf_size H5Pget_sieve_buf_size H5Pset_fapl_dpss H5Pset_fapl_gass H5Pget_fapl_gass H5Pset_fapl_srb H5Pget_fapl_srb H5Tarray_create H5Tget_array_ndims H5Tget_array_dims Platforms tested: IE 5.
2000-11-14 00:35:49 +08:00
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Error-Push">H5Epush</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Epush</code>(
<em>const char *</em><code>file</code>,
<em>const char *</em><code>func</code>,
<em>unsigned</em> <code>line</code>,
<em>H5E_major_t</em> <code>maj_num</code>,
<em>H5E_minor_t</em> <code>min_num</code>,
<em>const char *</em><code>str</code>
)
<dt><strong>Purpose:</strong>
<dd>Pushes new error record onto error stack.
<dt><strong>Description:</strong>
<dd><code>H5Epush</code> pushes a new error record onto the
error stack for the current thread.
<p>
The error has major and minor numbers <code>maj_num</code> and
<code>min_num</code>,
the function <code>func</code> where the error was detected,
the name of the file <code>file</code> where the error was detected,
the line <code>line</code> within that file,
and an error description string <code>str</code>.
<p>
The function name, file name, and error description strings
must be statically allocated.
<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>const char *</em><code>file</code>,</td>
<td valign="top">IN: Name of the file in which the error was detected.</td></tr>
<tr>
<td valign="top"><em>const char *</em><code>func</code>,</td>
<td valign="top">IN: Name of the function in which the error was detected.</td></tr>
<tr>
<td valign="top"><em>unsigned</em> <code>line</code>,</td>
<td valign="top">IN: Line within the file at which the error was detected.</td></tr>
<tr>
<td valign="top"><em>H5E_major_t</em>&nbsp;<code>maj_num,&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
<td valign="top">IN: Major error number.</td></tr>
<tr>
<td valign="top"><em>H5E_minor_t</em> <code>min_num</code>,</td>
<td valign="top">IN: Minor error number.</td></tr>
<tr>
<td valign="top"><em>const char *</em><code>str</code></td>
<td valign="top">IN: Error description string.</td></tr>
</table></ul>
[svn-r2873] Purpose: Adding all functions new to Release 1.4. Solution: Adding first cut of all new API functions. H5Dvlen_get_buf_size H5Epush H5Pset_fapl_family H5Pget_fapl_family H5Pset_fapl_mpio H5Pget_fapl_mpio H5Pset_dxpl_mpio H5Pget_dxpl_mpio H5Pset_fapl_multi H5Pget_fapl_multi H5Pset_dxpl_multi H5Pget_dxpl_multi H5Pset_fapl_split H5Pset_fapl_sec2 H5Pset_fapl_stdio H5Pset_fapl_stream H5Pget_fapl_stream H5Pset_fapl_log H5Pset_driver H5Pget_driver H5Pget_driver_info H5Pset_meta_block_size H5Pget_meta_block_size H5Pset_sieve_buf_size H5Pget_sieve_buf_size H5Pset_fapl_dpss H5Pset_fapl_gass H5Pget_fapl_gass H5Pset_fapl_srb H5Pget_fapl_srb H5Tarray_create H5Tget_array_ndims H5Tget_array_dims Platforms tested: IE 5.
2000-11-14 00:35:49 +08:00
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
[svn-r7691] Description: Integrate Fortran90 function descriptions Remove "Non-C APIs" sections; add "Fortran90 Interface" sections Remove note that Fortran APIs are described in a separate window Platforms tested: Safari
2003-10-22 06:18:46 +08:00
<dt><strong>Fortran90 Interface:</strong>
<dd>None.
[svn-r2873] Purpose: Adding all functions new to Release 1.4. Solution: Adding first cut of all new API functions. H5Dvlen_get_buf_size H5Epush H5Pset_fapl_family H5Pget_fapl_family H5Pset_fapl_mpio H5Pget_fapl_mpio H5Pset_dxpl_mpio H5Pget_dxpl_mpio H5Pset_fapl_multi H5Pget_fapl_multi H5Pset_dxpl_multi H5Pget_dxpl_multi H5Pset_fapl_split H5Pset_fapl_sec2 H5Pset_fapl_stdio H5Pset_fapl_stream H5Pget_fapl_stream H5Pset_fapl_log H5Pset_driver H5Pget_driver H5Pget_driver_info H5Pset_meta_block_size H5Pget_meta_block_size H5Pset_sieve_buf_size H5Pget_sieve_buf_size H5Pset_fapl_dpss H5Pset_fapl_gass H5Pget_fapl_gass H5Pset_fapl_srb H5Pget_fapl_srb H5Tarray_create H5Tget_array_ndims H5Tget_array_dims Platforms tested: IE 5.
2000-11-14 00:35:49 +08:00
<!--
[svn-r7691] Description: Integrate Fortran90 function descriptions Remove "Non-C APIs" sections; add "Fortran90 Interface" sections Remove note that Fortran APIs are described in a separate window Platforms tested: Safari
2003-10-22 06:18:46 +08:00
<pre>
SUBROUTINE
</pre>
-->
<!--<dt><strong>Non-C API(s):</strong>
<dd>
[svn-r2873] Purpose: Adding all functions new to Release 1.4. Solution: Adding first cut of all new API functions. H5Dvlen_get_buf_size H5Epush H5Pset_fapl_family H5Pget_fapl_family H5Pset_fapl_mpio H5Pget_fapl_mpio H5Pset_dxpl_mpio H5Pget_dxpl_mpio H5Pset_fapl_multi H5Pget_fapl_multi H5Pset_dxpl_multi H5Pget_dxpl_multi H5Pset_fapl_split H5Pset_fapl_sec2 H5Pset_fapl_stdio H5Pset_fapl_stream H5Pget_fapl_stream H5Pset_fapl_log H5Pset_driver H5Pget_driver H5Pget_driver_info H5Pset_meta_block_size H5Pget_meta_block_size H5Pset_sieve_buf_size H5Pget_sieve_buf_size H5Pset_fapl_dpss H5Pset_fapl_gass H5Pget_fapl_gass H5Pset_fapl_srb H5Pget_fapl_srb H5Tarray_create H5Tget_array_ndims H5Tget_array_dims Platforms tested: IE 5.
2000-11-14 00:35:49 +08:00
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
[svn-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Eset_auto" -->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<hr>
<dl>
[svn-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
<dt><strong>Name:</strong> <a name="Error-SetAuto">H5Eset_auto</a>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Signature:</strong>
[svn-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
<dd><em>herr_t</em> <code>H5Eset_auto</code>(<em>H5E_auto_t</em> <code>func</code>,
<em>void *</em><code>client_data</code>
)
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Purpose:</strong>
[svn-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
<dd>Turns automatic error printing on or off.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<dt><strong>Description:</strong>
[svn-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
<dd><code>H5Eset_auto</code> turns on or off automatic printing of
errors. When turned on (non-null <code>func</code> pointer),
any API function which returns an error indication will
first call <code>func</code>, passing it <code>client_data</code>
as an argument.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<p>
[svn-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
When the library is first initialized the auto printing function
is set to <code>H5Eprint</code> (cast appropriately) and
<code>client_data</code> is the standard error stream pointer,
<code>stderr</code>.
<p>
Automatic stack traversal is always in the
<code>H5E_WALK_DOWNWARD</code> direction.
[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>H5E_auto_t</em> <code>func</code></td>
<td valign="top">IN: Function to be called upon an error condition.</td></tr>
<tr>
<td valign="top"><em>void&nbsp;*</em><code>client_data&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
<td valign="top">IN: Data passed to the error function.</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-r7691] Description: Integrate Fortran90 function descriptions Remove "Non-C APIs" sections; add "Fortran90 Interface" sections Remove note that Fortran APIs are described in a separate window Platforms tested: Safari
2003-10-22 06:18:46 +08:00
<dt><strong>Fortran90 Interface:</strong> h5eset_auto_f
<dd>
<pre>
SUBROUTINE h5eset_auto_f(printflag, hdferr)
INTEGER, INTENT(IN) :: printflag !flag to turn automatic error
!printing on or off
!possible values are:
!printon (1)
!printoff(0)
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5eset_auto_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
[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
<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-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Ewalk" -->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Error-Walk">H5Ewalk</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Ewalk</code>(<em>H5E_direction_t</em> <code>direction</code>,
<em>H5E_walk_t</em> <code>func</code>,
<em>void *</em> <code>client_data</code>
)
<dt><strong>Purpose:</strong>
<dd>Walks the error stack for the current thread, calling a specified
function.
<dt><strong>Description:</strong>
<dd><code>H5Ewalk</code> walks the error stack for the current thread
and calls the specified function for each error along the way.
<p>
<code>direction</code> determines whether the stack is walked
from the inside out or the outside in.
A value of <code>H5E_WALK_UPWARD</code> means begin with the
most specific error and end at the API;
a value of <code>H5E_WALK_DOWNWARD</code> means to start at the
API and end at the inner-most function where the error was first
detected.
<p>
<code>func</code> will be called for each error in the error stack.
Its arguments will include an index number (beginning at zero
regardless of stack traversal direction), an error stack entry,
and the <code>client_data</code> pointer passed to
<code>H5E_print</code>.
[svn-r2090] RM_H5D.html H5Dclose: Corrected return type to herr_t (was hid_t). H5Dcreate: Inserted missing spaces in function syntax statement. RM_H5E.html H5Ewalk: Added H5E_walk_t prototype and prototype parameter descriptions. RM_H5F.html H5Fclose: Corrected behavior description, eliminating comment that function fials if other access identifiers are still open and describing actual behavior. RM_H5T.html H5Tregister: Corrected possible 'pers' values to H5T_PERS_HARD (was HARD) and H5T_PERS_SOFT (was SOFT). H5Tfind: Corrected 'pcdata' parameter IN/OUT designation.
2000-04-08 03:38:42 +08:00
The <code>H5E_walk_t</code> prototype is as follows:
<dir>
<p>
<code>typedef</code> <em>herr_t</em> <code>(*H5E_walk_t)(</code><em>int</em> <code>n,</code>
<em>H5E_error_t *</em><code>err_desc,</code>
<em>void *</em><code>client_data)</code>
<p>
where the parameters have the following meanings:
<dl>
<dt><em>int</em> <code>n</code>
<dd>Indexed position of the error in the stack.
<dt><em>H5E_error_t *</em><code>err_desc</code>
<dd>Pointer to a data structure describing the error.
<em>(This structure is currently described only in the
source code file </em><code>hdf5/src/H5Epublic.h</code><em>.
That file also contains the definitive list of major
and minor error codes. That information will
eventually be presented as an appendix to this
<cite>Reference Manual</cite>.)</em>
<dt><em>void *</em><code>client_data</code>
<dd>Pointer to client data in the format expected by
the user-defined function.
</dl>
</dir>
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<p>
<code>H5Ewalk</code> can fail if there are problems initializing
the library.
<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>H5E_direction_t</em>&nbsp;<code>direction&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
<td valign="top">IN: Direction in which the error stack is to be walked.</td></tr>
<tr>
<td valign="top"><em>H5E_walk_t</em> <code>func</code></td>
<td valign="top">IN: Function to be called for each error encountered.</td></tr>
<tr>
<td valign="top"><em>void *</em> <code>client_data</code></td>
<td valign="top">IN: Data to be passed with <code>func</code>.</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-r7691] Description: Integrate Fortran90 function descriptions Remove "Non-C APIs" sections; add "Fortran90 Interface" sections Remove note that Fortran APIs are described in a separate window Platforms tested: Safari
2003-10-22 06:18:46 +08:00
<dt><strong>Fortran90 Interface:</strong>
<dd>None.
[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-r7691] Description: Integrate Fortran90 function descriptions Remove "Non-C APIs" sections; add "Fortran90 Interface" sections Remove note that Fortran APIs are described in a separate window Platforms tested: Safari
2003-10-22 06:18:46 +08:00
<pre>
SUBROUTINE
</pre>
-->
<!--<dt><strong>Non-C API(s):</strong>
<dd>
[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
<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-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Ewalk_cb" -->
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Error-WalkCB">H5Ewalk_cb</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Ewalk_cb</code>(<em>int</em> <code>n</code>,
<em>H5E_error_t *</em><code>err_desc</code>,
<em>void</em> <code>*client_data</code>
)
<dt><strong>Purpose:</strong>
<dd>Default error stack traversal callback function
that prints error messages to the specified output stream.
<dt><strong>Description:</strong>
<dd><code>H5Ewalk_cb</code> is a default error stack traversal callback
function that prints error messages to the specified output stream.
It is not meant to be called directly but rather as an
[svn-r4837] Purpose: Bugfix. Copy edits. Description: Added IN/OUT designations to parameters. Copy edits. Removed () from public H5 functions in running text. Platforms tested: IE 5
2002-01-17 02:45:29 +08:00
argument to the <code>H5Ewalk</code> function.
This function is called also by <code>H5Eprint</code>.
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
Application writers are encouraged to use this function as a
model for their own error stack walking functions.
<p>
<code>n</code> is a counter for how many times this function
has been called for this particular traversal of the stack.
It always begins at zero for the first error on the stack
(either the top or bottom error, or even both, depending on
the traversal direction and the size of the stack).
<p>
<code>err_desc</code> is an error description. It contains all the
information about a particular error.
<p>
<code>client_data</code> is the same pointer that was passed as the
[svn-r4837] Purpose: Bugfix. Copy edits. Description: Added IN/OUT designations to parameters. Copy edits. Removed () from public H5 functions in running text. Platforms tested: IE 5
2002-01-17 02:45:29 +08:00
<code>client_data</code> argument of <code>H5Ewalk</code>.
[svn-r5317] Description: Minor copy edits. Platforms tested: IE 5
2002-05-02 06:33:50 +08:00
It is expected to be a file pointer (or stderr if NULL).
[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> <code>n</code></td>
<td valign="top">IN/OUT: Number of times this function has been called
for this traversal of the stack.</td></tr>
<tr>
<td valign="top"><em>H5E_error_t&nbsp;*</em><code>err_desc&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
<td valign="top">OUT: Error description.</td></tr>
<tr>
<td valign="top"><em>void</em> <code>*client_data</code></td>
<td valign="top">IN: A file pointer, or stderr if NULL.</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-r7691] Description: Integrate Fortran90 function descriptions Remove "Non-C APIs" sections; add "Fortran90 Interface" sections Remove note that Fortran APIs are described in a separate window Platforms tested: Safari
2003-10-22 06:18:46 +08:00
<dt><strong>Fortran90 Interface:</strong>
<dd>None.
[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-r7691] Description: Integrate Fortran90 function descriptions Remove "Non-C APIs" sections; add "Fortran90 Interface" sections Remove note that Fortran APIs are described in a separate window Platforms tested: Safari
2003-10-22 06:18:46 +08:00
<pre>
SUBROUTINE
</pre>
-->
<!--<dt><strong>Non-C API(s):</strong>
<dd>
[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
<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-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;
[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_H5E.html">H5E</a>&nbsp;&nbsp;
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
<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-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
<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-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +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-r7567] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Description: Solution: Platforms tested: Misc. update:
2003-10-08 03:56:17 +08:00
-->
</SCRIPT>
[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
[svn-r503] HDF5 Reference Manual Updated for Alpha2.
1998-07-15 12:51:50 +08:00
</body>
</html>
Reference in New Issue Copy Permalink