summaryrefslogtreecommitdiffstats
path: root/doc/html/RM_H5T.html
Commit message (Collapse)AuthorAgeFilesLines
* [svn-r10686] Frank Baker2005-04-271-3/+9
| | | | | | | | | | | Purpose: Added note to H5Tget_class description that library returns H5T_STRING for both fixed-length and variable-length strings. Fixes Bugzilla #329. In H5Tget_member_class, added reference to list of valid class identifiers in H5Tget_class. Platforms tested: Firefox
* [svn-r10683] Purpose:Frank Baker2005-04-271-2/+2
| | | | | | | Corrected return value of H5Tget_member_value. Fixed Bugzilla #309 Platforms tested: Firefox
* [svn-r10573] Frank Baker2005-04-071-51/+53
| | | | | | | | | Purpose: Add h5tget_member_index_f and h5tget_member_class_f. Reformat links index at top of page to balance Fortran lists and cleanup the C listing. Platforms tested: Firefox
* [svn-r9727] Purpose:Quincey Koziol2004-12-291-10/+12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-r9231] Frank Baker2004-09-081-4/+4
| | | | | | | | | Description: H5T_conv_t (appears in H5Tregister description) -- changed datatype of the nelmts parameter H5Tconvert -- changed datatype of the nelmts parameter Platforms tested: Mozilla
* [svn-r8221] Frank Baker2004-02-241-393/+519
| | | | | | | | | | | | | | | | | 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-r8090] Frank Baker2004-01-221-5/+5
| | | | | | | | Purpose: Correct 'strpad' values in h5tset/get_strpad_f e.g., H5T_STR_NULL_F corrected to H5T_STR_NULLPAD_F Description: Safari, IE 5
* [svn-r7758] Frank Baker2003-10-271-1/+1
| | | | | | | | | 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-r7719] Frank Baker2003-10-231-277/+1009
| | | | | | | | | | | | Purpose: Integrate Fortran90 function descriptions Remove "Non-C APIs" sections; add "Fortran90 Interface" sections Remove note that Fortran APIs are described in a separate window Touch up function index Minor format fixes and copy edits Platforms tested: Safari
* [svn-r7577] Frank Baker2003-10-081-1301/+1364
| | | | | | | | | | | Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Minor copy edits Platforms tested: IE 5, Safari
* [svn-r7476] Purpose:Quincey Koziol2003-09-161-1/+3
| | | | Clarify documentation about H5Tset_size for string datatypes.
* [svn-r7468] Purpose:Quincey Koziol2003-09-121-4/+4
| | | | | | | | | | | | | | | | | | Code cleanup, etc. Description: Generalize Ray's datatype fixes to handle packing compound datatypes which are the base type of an array or variable-length type, etc. Also track "packedness" of a compound datatype from it's creation, instead of only setting the 'packed' flag after the datatype was explicitly packed. Updated docs to reflect that a compound datatype is allowed to grow (but not shrink). Platforms tested: FreeBSD 4.9 (sleipnir) h5committest
* [svn-r7434] Purpose:Quincey Koziol2003-08-311-3/+3
| | | | | | | | | | | | | | | | | | | | Bug Fix and code cleanup Description: Correct error in H5T_detect_class that was causing nested compound datatypes with to not detect the datatype class of fields correctly, which caused errors with fill-values, variable-length datatypes and chunks later on. Return the rank of the array datatype from H5Tget_array_dims(), like H5Sget_dims(). Lots of cleanups to datatype code, to make the handling of arrays, compound types, variable-length strings and sequences and enumerated types more consistent and robust. Platforms tested: FreeBSD 4.9 (sleipnir) h5committest
* [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-r7157] Frank Baker2003-07-031-15/+9
| | | | | | | | | | | | | | | | | | | Purpose: Linking in additional Fortran90 functions Description: Add links to In RM_H5T.html h5tarray_create_f, h5tget_array_ndims_f, h5tget_array_dims_f In RM_H5P.html h5pmodify_filter_f, h5pget_filter_by_id_f, h5pset_family_offset_f h5pset(get)_fapl_core_f, h5pset(get)_fapl_family_f h5pset(get)_fapl_multi_f, h5pset_fapl_sec2_f, h5pset_fapl_sdio_f h5pset_fapl_split_f, h5pget_driver_f, h5pset_szip_f h5pget_nfilters_f, h5pset(get)_preserve_f 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-r7077] Frank Baker2003-06-201-4/+16
| | | | | | | | | | | | | | | | | Purpose: Edits based on review feedback. Description: H5Tis_variable_str H5Tdetect_class -- Added notes regarding applicability of these 2 functions. H5Tget_native_type -- Copy edits. Added note to close returned identifier with H5Tclose and clarification WRT array, compoud, etc datatypes. Misc copy edits. Platforms tested: IE 5, Safari
* [svn-r7014] Frank Baker2003-06-101-1/+83
| | | | | | | | | | | | | | | 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-r6816] Frank Baker2003-05-061-12/+141
| | | | | | | | | | | | | | Purpose: New features. Description: Added 3 new functions: H5Tis_variable_str H5Tdetect_class H5Tget_native_type Platforms tested: Safari, IE 5
* [svn-r6600] Frank Baker2003-04-081-6/+33
| | | | | | | | | | | | | | 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-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-r5319] Frank Baker2002-05-011-25/+86
| | | | | | | | | | | | | | | | | | | | | Purpose: 1 new function; 3 revised functions; 2 bugfixes; copy edits Solution: H5Tget_member_index: Added this new function. H5Tget_member_name: Revised, based on lessons learned with H5Tget_member_index. H5Tget_nmembers: Revised to indicate that function works for both compound and enumeration datatypes. --> Fixes Bug# 747. Cross-listed H5Tget_nmembers, H5Tget_member_index, and H5Tget_member_name under both compound and enum datatypes, as they work for both. H5Tset_tag: Corrected tag description (it is descriptive, uniqueness is not required). Corrected several spelling errors. --> Partially fixes Bug# 760 (though just for this file *sigh*). Platforms tested: IE 5
* [svn-r4299] Purpose:Frank Baker2001-08-021-13/+28
| | | | | | | | | | | | | Bringing 'last minute' release branch edits into development branch. Description: RM_H5T.html Datatypes.html Reworked H5T_conv_t description in both. Added H5T_cdata_t struct definition to both. Details in Datatypes.html; structs and pointer in RM_H5T.html. Copy edits. Platforms tested: IE 5
* [svn-r4126] Purpose:Frank Baker2001-07-061-2/+3
| | | | | | | | | | | | | | | | 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-16/+11
| | | | | 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-r3378] Frank Baker2001-02-071-1/+39
| | | | | | | Purpose: Adding H5Tget_member_class to RM. 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-r3254] Frank Baker2001-01-091-2/+2
| | | | | | | | | | Purpose: Correcting docs to match code bugfixes. Solution: Changed per recent bugfix in code: H5Tconvert 'nelmts' parameter type H5Pset_buffer 'size' parameter type H5Pget_buffer return type
* [svn-r3206] Frank Baker2000-12-271-1/+1
| | | | | | | | | | Purpose: Return value error in H5Tarray_create Solution: H5Tarray_create Fixed return value to read 'int' (was 'int *') Platforms tested: IE 5
* [svn-r3205] Frank Baker2000-12-271-2/+2
| | | | | | | | | | Purpose: Error in H5Tget_array_dims and H5Tget_array_ndims return types Solution: H5Tget_array_dims and H5Tget_array_ndims Fixed return value to read 'int' (was 'int *') Platforms tested: IE 5
* [svn-r3181] Frank Baker2000-12-211-3/+3
| | | | | | | | | | Purpose: Bugfix -- #446 Description: H5Tget_offset has been fixed so that it returns a negative value on failure. This is now reflected in RM. 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-r2881] Purpose:Frank Baker2000-11-131-128/+13
| | | | | | | | | Clean up formatting and delete two functions. Description: Minor reformatting at the head of each file (in the functions list). Delete 2 functions from HM_H5T.html -- H5Tget_member_dims, H5Tinsert_array. Platforms tested: IE 5.
* [svn-r2873] Frank Baker2000-11-131-1/+144
| | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* [svn-r2435] RM_H5[EIPRT].htmlFrank Baker2000-07-171-175/+137
| | | | | | | RM_H5Front.html Added new Fortran90 functions and links. Related edits. Added "Describes HDF5 Release..." line in page footers. Minor editorial corrections.
* [svn-r2427] RM_H5T.htmlFrank Baker2000-07-061-9/+13
| | | | | | | | | | | 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-12/+16
| | | | | | | | | | | | | | | | 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-r2006] RM_H5D.htmlFrank Baker2000-03-081-10/+29
| | | | | | | | | | | | | | | | | | H5Dopen: Corrected description of 'loc_id' parameter. RM_H5T.html H5Tset_strpad: Corrected string padding values list (replaced 'H5T_STR_NULL & H5T_STR_SPACE' with ''H5T_STR_NULLTERM, 'H5T_STR_NULLPAD, & H5T_STR_SPACEPAD'. Added notes re conversion from shorter to longer strings and from longer to shorter strings. Other minor edits and formatting. H5Tget_class Corrected H5T_ENUM and H5T_REFERENCE entries in class identifiers table (they were reversed). Tools.html h5dump: Added note that '-bb' option is not yet implemented. Changed 'boot block' to 'super block'.
* [svn-r1897] RM_H5T.html H5Tset/get_fields: Added spos parameter.Frank Baker1999-12-171-11/+26
| | | | H5Tconvert: Added plist_id parameter.
* [svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree.Frank Baker1999-12-131-103/+955
| | | | | (except Datatypes.html, H5.format.html, ddl.html) This version of HDF5 Ref Manual includes FORTRAN API references.
* [svn-r1425] Frank Baker1999-07-061-7/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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/+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-59/+65
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-r693] Update for beta release. Complete CVS log messages can be found withFrank Baker1998-09-111-3/+17
| | | | the versions of these files that are maintained in hdf5/doc/src/.
* [svn-r503] HDF5 Reference ManualFrank Baker1998-07-151-0/+1755
Updated for Alpha2.