summaryrefslogtreecommitdiffstats
path: root/doc/html/RM_H5G.html
Commit message (Collapse)AuthorAgeFilesLines
* [svn-r11084] Frank Baker2005-07-191-1521/+0
| | | | | | | | | Description: All HDF5 user documentation has been moved to a separate hdf5doc/ repository, managed under Subversion. With this 'cvs commit', all files are stripped from hdf5/doc/. THIS CHANGE IS APPLIED ONLY TO THE HDF5 DEVELOPMENT BRANCH, post Release 1.6.x; it is not applied to the release branches.
* [svn-r10973] Frank Baker2005-06-231-0/+10
| | | | | | | Purpose: Added links to HDF5 High-Level API reference pages. Platforms tested: Firefox
* [svn-r9727] Purpose:Quincey Koziol2004-12-291-6/+34
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | Bug Fix/Code Cleanup/Doc Cleanup/Optimization/Branch Sync :-) Description: Generally speaking, this is the "signed->unsigned" change to selections. However, in the process of merging code back, things got stickier and stickier until I ended up doing a big "sync the two branches up" operation. So... I brought back all the "infrastructure" fixes from the development branch to the release branch (which I think were actually making some improvement in performance) as well as fixed several bugs which had been fixed in one branch, but not the other. I've also tagged the repository before making this checkin with the label "before_signed_unsigned_changes". Platforms tested: FreeBSD 4.10 (sleipnir) w/parallel & fphdf5 FreeBSD 4.10 (sleipnir) w/threadsafe FreeBSD 4.10 (sleipnir) w/backward compatibility Solaris 2.7 (arabica) w/"purify options" Solaris 2.8 (sol) w/FORTRAN & C++ AIX 5.x (copper) w/parallel & FORTRAN IRIX64 6.5 (modi4) w/FORTRAN Linux 2.4 (heping) w/FORTRAN & C++ Misc. update:
* [svn-r8573] Frank Baker2004-05-251-16/+28
| | | | | | | | | | | | | | | | | Purpose: Bugfixes in H5Gset_comment, h5gget_comment_f, and h5gset_comment_f. (Follow-on to the H5Gget_comment bugfix of last week.) Description: Changed C parameter descriptions to indicate the following: 'loc_id' can be file, group, dataset, or named datatype. 'name' can be '.' if 'loc_id' fully describes the object. 'name' is ignored if 'loc_id' is a dataset or named datatype. Modified h5gget_comment_f and h5gset_comment_f notes accordingly. Copy edits in H5Gget/set_comment and h5gget/set_comment_f. Platforms tested: Safari
* [svn-r8566] Frank Baker2004-05-211-12/+22
| | | | | | | | | | | | | | | | | Purpose: H5Gget_comment bugfix Description: H5Gget_comment: Changed "Description" text and "Parameters" descriptions to indicate the following: 'loc_id' can be file, group, dataset, or named datatype. 'name' can be '.' if 'loc_id' fully describes the object. 'name' is ignored if 'loc_id' is a dataset or nemed datatype. Also corrected the fact that the 'name' parameter description referred to setting the comment rather than retriving it. Platforms tested: Safari
* [svn-r8221] Frank Baker2004-02-241-169/+216
| | | | | | | | | | | | | | | | | 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
* [svn-r8087] Frank Baker2004-01-221-4/+8
| | | | | | | | Purpose: Correct H5G_stat_t struct description in H5Gget_objinfo Copy edits Platforms tested: Safari, IE 5
* [svn-r7787] Frank Baker2003-10-291-2/+2
| | | | | | | | | | | | Purpose: Fixes for user-reported Ref Manual bugs: H5Gget_objname_by_idx: corrected 'size' parameter specification H5Sselect_elements: Expanded 'coord' parameter description to make it clear that values are 0-based. Additional minor copy edits and formatting cleanup. Platforms tested: IE 5
* [svn-r7758] Frank Baker2003-10-271-3/+5
| | | | | | | | | 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
* [svn-r7690] Frank Baker2003-10-211-94/+309
| | | | | | | | | | | 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 Corrected H5Gget_objname_by_idx return value description Platforms tested: Safari
* [svn-r7585] Frank Baker2003-10-091-523/+520
| | | | | | | | | | | Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Function index formatting Platforms tested: IE 5, Safari
* [svn-r7430] Frank Baker2003-08-281-3/+3
| | | | | | | | | Purpose: RM_H5G.html -- Minor copy edits H5.intro.html -- Removed Library version # from doc title Platforms tested: IE 5, Safari
* [svn-r7412] Purpose:Quincey Koziol2003-08-261-14/+14
| | | | | | | | | | | | | | | | | | | Bug fix Description: H5Gget_objname_by_idx should allow NULL for the 'name' parameter, to allow for querying for the name's length. Solution: Allow NULL for the 'name' parameter, the internal functions were already ready to handle that case. Clean up RM information about H5Gget_objname_by_idx and H5Gget_objtype_by_idx also. Platforms tested: FreeBSD 4.8 (sleipnir) h5committest
* [svn-r7335] Purpose:Quincey Koziol2003-08-111-4/+4
| | | | | | | Update docs Description: Updated docs with new H5G_stat_t structure.
* [svn-r7159] Frank Baker2003-07-031-2/+2
| | | | | | | | | | | | 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
* [svn-r7140] Frank Baker2003-07-021-2/+21
| | | | | | | | | | | | | | | 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
* [svn-r7014] Frank Baker2003-06-101-1/+39
| | | | | | | | | | | | | | | 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
* [svn-r6817] Frank Baker2003-05-061-17/+202
| | | | | | | | | | | | | | Purpose: New features. Description: Added 3 new functions: H5Gget_num_objs H5Gget_objname_by_idx H5Gget_objtype_by_idx Platforms tested: Safari, IE 5
* [svn-r6478] Frank Baker2003-03-141-17/+15
| | | | | | | | | | | 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
* [svn-r6210] Frank Baker2002-12-161-18/+129
| | | | | | | | | | Purpose: Adding H5Gmove2 and H5Glink2. Description: Added H5Gmove2 and H5Glink2. Renamed H5Gmove parameters for consistency. Platforms tested: IE 5
* [svn-r5338] Frank Baker2002-05-021-1/+10
| | | | | | | | | | Purpose: Elaboration on a struct field Description: H5Gget_objinfo: Added caveats regarding 'fileno' field in H5G_stat_t struct. Platforms tested: IE 5
* [svn-r4835] Frank Baker2002-01-161-22/+23
| | | | | | | | | | | | Purpose: Bugfix. Clarification. Copy edits and minor formatting. Description: H5Gunlink: Corrected loc_id parameter to be 'file or group' rather than just 'file'. Added IN/OUT designations to parameters. Minor formatting. Removed () from public H5 functions in running text. Platforms tested: IE 5
* [svn-r4301] Purpose:Frank Baker2001-08-021-8/+6
| | | | | | | | | | | Bringing 'last minute' release branch edits into development branch. Description: Removed link to non-existent description of non-existent F90 function h5gget_objinfo_f. Added links, with explanatory note, to the new freespace management section in Performance.html. Platforms tested: IE 5
* [svn-r4163] Purpose:Frank Baker2001-07-091-9/+22
| | | | | | | | | | Fixes bug #503 Description: H5Gunlink -- Changed "file space is reclaimed" ot "released". Added note re: freespace and packing. Heavy edit of Purpose and Description. Platforms tested: IE 5
* [svn-r3823] Frank Baker2001-04-181-1/+1
| | | | | | | | Purpose: Update "Describes HDF5 Release..." footer from R1.4 to "Release 1.5, Unreleased Development Branch" Platforms tested: IE 5
* [svn-r3822] Frank Baker2001-04-181-1/+2
| | | | | | | | Purpose: Update "Describes HDF5 Release..." footer from R1.4 to "Release 1.5, Unreleased Development Branch" Platforms tested: IE 5
* [svn-r3387] Frank Baker2001-02-091-1/+1
| | | | | | | | | | | | | Purpose: Marking files for "Release 1.4, February 2001." Description: Across doc files Updating "Describes HDF5 Release..." entry to "Describes HDF5 Release 1.4, February 2001." Copyright.html: Added 2001 to years copyrighted. index.html: Changed header to Release 1.4 (from 1.4 Beta) Platforms tested: IE 5
* [svn-r3311] Frank Baker2001-01-191-2/+0
| | | | | | | Purpose, Description, and Solution: Removed cross-links to Ragged Array doc files (above). Platforms tested: IE 5
* [svn-r3117] Frank Baker2000-12-121-2/+4
| | | | | | | | | Purpose: Linking the new "Predefined Dataypes" document into the RM. Description: Added PredefDTypes.html link into all RM files. Platforms tested: IE 5
* [svn-r3105] Frank Baker2000-12-081-1/+1
| | | | | | | | | Purpose: Thoughout doc set (UG, RM, Intro, FormatSpec, and index/TOC pages): Added/updated "Describes HDF5 Release ..." entry. In many cases, verified/updated "Last modified ..." entry. Platforms tested: IE 5
* [svn-r2789] Purpose:Frank Baker2000-11-011-1/+11
| | | | | | | | | | | | | To warn users that RM_H5G.html and Groups.html can render groups and datasets inaccessible in a file. Solution: Modified RM_H5G.html and Groups.html as follows: -- Added warning (new section) to Groups.html that H5Gunlink and H5Gmove can result in inaccessible groups and datasets. -- Added links to that new section from H5Gunlink and H5Gmove in RM_H5G.html. Platforms tested: IE5
* [svn-r2438] Added "Describes HDF5 Release..." line in page footers.Frank Baker2000-07-171-1/+3
|
* [svn-r2002] Changed 'boot block' to 'super block'.Frank Baker2000-03-081-1/+1
|
* [svn-r1890] RM_H5G.html H5Giterate: Corrected H5G_operator_t to read ↵Frank Baker1999-12-171-4/+10
| | | | | | | | H5G_iterate_t. Minor corrections to H5G_iterate_t prototype syntax. Added note that H5Giterate's behavior is undefined if the group structure or membership changes.
* [svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree.Frank Baker1999-12-131-3/+159
| | | | | (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
* [svn-r1425] Frank Baker1999-07-061-18/+25
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | RM_H5S.html Dataspaces.html H5Sselect_hyperslab H5Sselect_elements Add H5S_SELECT_OR operator. Converted operator list to a table. H5Sextent_copy Corrected source and destination descriptions. (RM_H5S.html only) H5Screate Removed unused H5S_NONE dataspace type. H5Sset_extent_none Corrected reset class type to H5S_NO_CLASS (previously said H5S_NONE). RM_H5G.html H5Gget_linkval Corrected descriptions of 'loc_id', 'name', and 'value'. Corrected "Purpose". Emphasized need to call H5Gget_objinfo first. H5Gset_comment H5Gget_comment Corrected description of 'loc_id'. H5Gget_objinfo Corrected description of 'loc_id'. Added H5G_TYPE to list of valid values of 'type'. RM_H5F.html ExternalFiles.html H5Fmount H5Funmount Corrected description of 'loc_id'. Changed function descriptions in ExternalFiles.html to correspond to RM. RM_H5T.html Moved H5Tget_class and H5Tget_size to "General Datatype Operations" in top index.
* [svn-r1221] Fixed Bug #293Frank Baker1999-04-261-2/+2
| | | | | | | RM_H5Front.html "H5A Annotation" Interface corrected to "H5A Attribute" interface. RM_H5G.html H5Glink loc_id description corrected.
* [svn-r985] Checking in changes from "HDF5 Release 1.0" CVS branch that have ↵Frank Baker1998-12-211-16/+38
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* [svn-r830] ======Frank Baker1998-10-291-32/+42
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* [svn-r777] RM_H5S.htmlFrank Baker1998-10-221-139/+5
| | | | | | | | | | | | | | | | | | | Changed H5Sget_space_type to H5Sget_simple_extent_type. Changed H5Sget_simple_extent_type FAIL return value to H5S_NO_CLASS. RM_H5F.html H5Fflush. Corrected function name in sytax line, which had read H5Fis_hdf. RM_H5G.html Removed discussion of "current working group" and associated information from the introductory discussion. H5Gset, H5Gpush, H5Gpop Removed these functions. H5Gunlink, H5Gmove Removed the "not yet implemented" notations from these functions.
* [svn-r693] Update for beta release. Complete CVS log messages can be found withFrank Baker1998-09-111-15/+120
| | | | the versions of these files that are maintained in hdf5/doc/src/.
* [svn-r503] HDF5 Reference ManualFrank Baker1998-07-151-0/+639
Updated for Alpha2.