summaryrefslogtreecommitdiffstats
path: root/doc/html/RM_H5F.html
Commit message (Collapse)AuthorAgeFilesLines
* [svn-r11084] Frank Baker2005-07-191-1970/+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-r10976] Frank Baker2005-06-231-128/+701
| | | | | | | | | Purpose: Added new meta data cache functions. Added links to HDF5 High-Level API reference pages to nav bar. Other minor (though somewhat pervasive) reformatting. Platforms tested: Firefox
* [svn-r9727] Purpose:Quincey Koziol2004-12-291-17/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-r9143] Frank Baker2004-08-241-7/+143
| | | | | | | | | Purpose: Add H5Fget_name Add H5Fget_filesize Minor correction in HTML coding of H5Fget_freespace Platforms tested: Mozilla
* [svn-r8221] Frank Baker2004-02-241-117/+145
| | | | | | | | | | | | | | | | | 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-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-r7689] Frank Baker2003-10-211-60/+304
| | | | | | | | | | | 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 Add H5Fget_freelist/h5fget_freelist_f Platforms tested: Safari, IE 5
* [svn-r7567] Frank Baker2003-10-071-196/+217
| | | | | | | | | | | | | | | 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:
* [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-r7059] Purpose:Quincey Koziol2003-06-181-9/+17
| | | | | | | | | | | Refactoring Description: Track changes to H5Fget_obj_<foo> API functions. Platforms tested: FreeBSD 4.8 (sleipnir) h5committest
* [svn-r7014] Frank Baker2003-06-101-1/+36
| | | | | | | | | | | | | | | 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-r6705] Frank Baker2003-04-171-14/+146
| | | | | | | | | | | | | | Purpose: Add new functions. Rewrite existing function. Description: Added H5get_vfd_handle and H5get_obj_ids. Rewrote H5get_obj_count: function description was incomplete and 2 (of 3) parameters were missing. Platforms tested: Safari, IE 5
* [svn-r6600] Frank Baker2003-04-081-27/+19
| | | | | | | | | | | | | | 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
* [svn-r6478] Frank Baker2003-03-141-18/+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-r6209] Frank Baker2002-12-161-6/+55
| | | | | | | | | | | Purpose: Adding new H5Fget_obj_* functions. (Development branch only) Description: Added H5Fget_obj_count. Stubbed in H5Fget_obj_ids, but the entry is not filled in. Reordered entries to group similar functions. Platforms tested: IE 5
* [svn-r4678] Frank Baker2001-12-051-49/+123
| | | | | | | | | | | | | | | | | | Purpose: Expanded descriptions and minor copy edits. Description: H5Fcreate, H5Fopen, H5Fclose Changes stemming from Albert's H5Fxxx proposal Added IN/OUT designations to parameters. Minor formatting and copy edits [Sorry, but "no space left on device" error prevents deletion of extra blank lines!] Platforms tested: IE 5
* [svn-r4126] Purpose:Frank Baker2001-07-061-2/+8
| | | | | | | | | | | | | | | | Bugfixes and editing. Description: RM_H5T.html H5Tget_class -- Added H5T_ARRAY to list of valid datatype class IDs. Closes bug #611. -- Minor formatting issue in same command. RM_H5F.html H5Fflush -- Added "Note:" re H5 vs OS buffers. H5Fclose -- Corrected mentions of H5close to read H5Fclose. RM_H5P.html Removed () from several H5* function names in running text. 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-r3803] Frank Baker2001-04-111-1/+13
| | | | | Purpose: Importing RM changes from 1.4 release branch into development branch (1.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-2/+2
| | | | | | | | | 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-r2672] Frank Baker2000-10-121-1/+3
| | | | | | | | | Purpose: Clarification of H5Fclose Description: RM_H5F.html / H5Fclose: Added note that all data is flushed to file. Platforms tested: Tested with IE 5.
* [svn-r2438] Added "Describes HDF5 Release..." line in page footers.Frank Baker2000-07-171-1/+3
|
* [svn-r2427] RM_H5T.htmlFrank Baker2000-07-061-6/+16
| | | | | | | | | | | H5Tvlen_create: Added cross-reference to H5Dget_vlen_buf_size and H5Dvlen_reclaim. H5Tget_class: Removed numbers from class identifiers list. Added H5T_VLEN to class identifiers list. RM_H5F.html H5Freopen: Corrected description of file_id parameter. Added comment about eventually closing returned identifier. Added clarification that function cannot open closed files.
* [svn-r2090] RM_H5D.htmlFrank Baker2000-04-071-3/+13
| | | | | | | | | | | | | | | | 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.
* [svn-r1889] RM_H5F.html H5Fcreate, H5Fopen: Clarified description of file ↵Frank Baker1999-12-171-15/+14
| | | | | | | | access flags in parameters section and removed reference to H5Fpublic.h. RM_H5D.html H5Dvlen_reclaim: Inserted missing punctuation. H5Dcreate: Added paragraph explaining that 'name' must be unique.
* [svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree.Frank Baker1999-12-131-23/+161
| | | | | (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
* [svn-r1425] Frank Baker1999-07-061-4/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-r985] Checking in changes from "HDF5 Release 1.0" CVS branch that have ↵Frank Baker1998-12-211-11/+112
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-11/+61
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-1/+1
| | | | | | | | | | | | | | | | | | | 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-6/+40
| | | | the versions of these files that are maintained in hdf5/doc/src/.
* [svn-r673] Changes since 19980908Robb Matzke1998-09-081-13/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | ---------------------- ./COPYING Reformatted as text instead of C. Removed zlib crew from the list of contributors since no zlib code is actually in the hdf5 library. ./INSTALL ./INSTALL.ascired ./MANIFEST Minor updates for Beta release including version number change. ./INSTALL_MAINT Added information about making a release. ./RELEASE Updated function list based on public header files. ./bin/checkposix Got rid of complaints about some obvious things. ./doc/html/H5.api.html ./doc/html/RM_H5F.html ./src/H5F.c ./src/H5Fpublic.h ./test/tfile.c Changed H5Fget_create_template() and H5Fget_access_template() to H5Fget_create_plist() and H5Fget_access_plist() since that conforms better to lots of other names. ./doc/html/Datatypes.html ./doc/html/ExternalFiles.html ./doc/html/Files.html ./doc/html/H5.api.html ./doc/html/H5.sample_code.html ./doc/html/RM_H5F.html ./doc/html/RM_H5Front.html Changed `template' to `property list', etc. ./doc/html/Ragged.html [NEW] Documentation for ragged arrays. ./src/H5Iprivate.h ./src/H5Ipublic.h ./src/H5I.c Changed the scope of some symbols to be more local. ./src/H5.c ./src/H5AC.c ./src/H5D.c ./src/H5E.c ./src/H5F.c ./src/H5Ffamily.c ./src/H5Fistore.c ./src/H5Flow.c ./src/H5Fsec2.c ./src/H5Fsplit.c ./src/H5Fstdio.c ./src/H5G.c ./src/H5Gnode.c ./src/H5HG.c ./src/H5I.c ./src/H5O.c ./src/H5Ocomp.c ./src/H5Odtype.c ./src/H5Oefl.c ./src/H5Omtime.c ./src/H5Oname.c ./src/H5P.c ./src/H5S.c ./src/H5Shyper.c ./src/H5Tbit.c ./src/H5Tconv.c ./src/H5V.c ./src/H5Z.c ./src/H5private.h Fixed some violations of our naming scheme by adding HD to the beginning of all Posix functions.
* [svn-r503] HDF5 Reference ManualFrank Baker1998-07-151-0/+300
Updated for Alpha2.