diff options
| author | Quincey Koziol <koziol@hdfgroup.org> | 2004-12-29 14:32:06 (GMT) |
|---|---|---|
| committer | Quincey Koziol <koziol@hdfgroup.org> | 2004-12-29 14:32:06 (GMT) |
| commit | 37232bd4f0f8199f956c823cdff72ece2ca9aa16 (patch) | |
| tree | 38e37f7208355500b7f223e90bf014424c63300b /doc | |
| parent | 20146575aaeead9e05af73977dee863de63bf50f (diff) | |
| download | hdf5-37232bd4f0f8199f956c823cdff72ece2ca9aa16.zip hdf5-37232bd4f0f8199f956c823cdff72ece2ca9aa16.tar.gz hdf5-37232bd4f0f8199f956c823cdff72ece2ca9aa16.tar.bz2 | |
[svn-r9729] Purpose:
Bug Fix/Code Cleanup/Doc Cleanup/Optimization/Branch Sync :-)
Description:
Generally speaking, this is the "signed->unsigned" change to selections.
However, in the process of merging code back, things got stickier and stickier
until I ended up doing a big "sync the two branches up" operation. So... I
brought back all the "infrastructure" fixes from the development branch to the
release branch (which I think were actually making some improvement in
performance) as well as fixed several bugs which had been fixed in one branch,
but not the other.
I've also tagged the repository before making this checkin with the label
"before_signed_unsigned_changes".
Platforms tested:
FreeBSD 4.10 (sleipnir) w/parallel & fphdf5
FreeBSD 4.10 (sleipnir) w/threadsafe
FreeBSD 4.10 (sleipnir) w/backward compatibility
Solaris 2.7 (arabica) w/"purify options"
Solaris 2.8 (sol) w/FORTRAN & C++
AIX 5.x (copper) w/parallel & FORTRAN
IRIX64 6.5 (modi4) w/FORTRAN
Linux 2.4 (heping) w/FORTRAN & C++
Misc. update:
Diffstat (limited to 'doc')
33 files changed, 3025 insertions, 2352 deletions
diff --git a/doc/html/Copyright.html b/doc/html/Copyright.html index f5ce1aa..cf187b1 100644 --- a/doc/html/Copyright.html +++ b/doc/html/Copyright.html @@ -16,27 +16,27 @@ <br> NCSA HDF5 (Hierarchical Data Format 5) Software Library and Utilities</h3> <hr> - -<font size="-1"> <p> - + + NCSA HDF5 (Hierarchical Data Format 5) Software Library and Utilities <br> Copyright 1998, 1999, 2000, 2001, 2002, 2003, 2004 by the Board of Trustees of the University of Illinois <br> <strong>All rights reserved.</strong> - <p> + Contributors: National Center for Supercomputing Applications (NCSA) at the University of Illinois at Urbana-Champaign (UIUC), Lawrence Livermore National Laboratory (LLNL), Sandia National Laboratories (SNL), Los Alamos National Laboratory (LANL), Jean-loup Gailly and Mark Adler (gzip library). - <p> + Redistribution and use in source and binary forms, with or without modification, are permitted for any purpose (including commercial purposes) provided that the following conditions are met: +<p> <ol> <li>Redistributions of source code must retain the above copyright notice, @@ -65,10 +65,12 @@ WITH NO WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED. In no event shall the University or the Contributors be liable for any damages suffered by the users arising out of the use of this software, even if advised of the possibility of such damage. + </ol> + <hr> Portions of HDF5 were developed with support from the University of California, Lawrence Livermore National Laboratory (UC LLNL). @@ -82,8 +84,7 @@ documentation, and/or accompanying materials: W-7405-ENG-48 (Contract 48) between the U.S. Department of Energy (DOE) and The Regents of the University of California (University) for the operation of UC LLNL. - - <br><br> + <p> <b>DISCLAIMER:</b> This work was prepared as an account of work sponsored by an agency of the United States Government. Neither the United States @@ -101,7 +102,8 @@ documentation, and/or accompanying materials: United States Government or the University of California, and shall not be used for advertising or product endorsement purposes. </dir> -</font> + +<hr> <!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> @@ -113,6 +115,7 @@ document.writeln("Last modified: 23 January 2004"); --> </SCRIPT> + </body> </html> diff --git a/doc/html/Datasets.html b/doc/html/Datasets.html index ccea555..eca195d 100644 --- a/doc/html/Datasets.html +++ b/doc/html/Datasets.html @@ -314,7 +314,7 @@ H5Pset_chunk (plist, 2, size); external data then zero is returned. <br><br> - <dt><code>herr_t H5Pget_external (hid_t <em>plist</em>, int + <dt><code>herr_t H5Pget_external (hid_t <em>plist</em>, unsigned <em>idx</em>, size_t <em>name_size</em>, char *<em>name</em>, off_t *<em>offset</em>, hsize_t *<em>size</em>)</code> <dd>This is the counterpart for the <code>H5Pset_external()</code> @@ -800,7 +800,7 @@ H5Pset_external (plist, "scan3.data", 0, 16); <p><code><pre> 1 hid_t file, mem_space, file_space, dataset; 2 double dd[200][400]; - 3 hssize_t offset[2]; + 3 hsize_t offset[2]; 4 hsize size[2]; 5 6 /* diff --git a/doc/html/Dataspaces.html b/doc/html/Dataspaces.html index b19e0c3..c83d285 100644 --- a/doc/html/Dataspaces.html +++ b/doc/html/Dataspaces.html @@ -438,7 +438,7 @@ portions of a dataspace may be added in the future. <DL> <DT> <TT>herr_t H5Sselect_hyperslab (hid_t <I>space</I>, h5s_seloper_t <I>op</I>, - const hssize_t * <I>start</I>, const hsize_t * <I>stride</I>, + const hsize_t * <I>start</I>, const hsize_t * <I>stride</I>, const hsize_t * <I>count</I>, const hsize_t * <I>block</I>)</TT></DT> <DD> @@ -488,7 +488,7 @@ I/O is performed. <DT> <TT>herr_t H5Sselect_elements (hid_t <I>space</I>, h5s_seloper_t <I>op</I>, - const size_t <I>num_elements</I>, const hssize_t *<I>coord</I>[])</TT></DT> + const size_t <I>num_elements</I>, const hsize_t *<I>coord</I>[])</TT></DT> <DD> This function selects array elements to be included in the selection for the diff --git a/doc/html/Datatypes.html b/doc/html/Datatypes.html index f738d44..232d7fb 100644 --- a/doc/html/Datatypes.html +++ b/doc/html/Datatypes.html @@ -610,7 +610,7 @@ <code>H5Tget_nmembers()</code> returns -1 on failure. <br><br> - <dt><code>char *H5Tget_member_name (hid_t <em>type</em>, int + <dt><code>char *H5Tget_member_name (hid_t <em>type</em>, unsigned <em>membno</em>)</code> <dd>Each member has a name which is unique among its siblings in a compound datatype. This function returns a pointer to a @@ -620,7 +620,7 @@ function. <br><br> - <dt><code>size_t H5Tget_member_offset (hid_t <em>type</em>, int + <dt><code>size_t H5Tget_member_offset (hid_t <em>type</em>, unsigned <em>membno</em>)</code> <dd>The byte offset of member number <em>membno</em> with respect to the beginning of the containing compound datum is @@ -631,7 +631,7 @@ <em>membno</em> arguments. <br><br> - <dt><code>hid_t H5Tget_member_type (hid_t <em>type</em>, int + <dt><code>hid_t H5Tget_member_type (hid_t <em>type</em>, unsigned <em>membno</em>)</code> <dd>Each member has its own datatype, a copy of which is returned by this function. The returned datatype identifier @@ -1297,7 +1297,7 @@ H5Tlock(hdf_fr_colors);</pre> datatypes. <br><br> - <dt><code>char *H5Tget_member_name(hid_t <em>etype</em>, int + <dt><code>char *H5Tget_member_name(hid_t <em>etype</em>, unsigned <em>membno</em>)</code> <dd>Given an enumeration datatype <em>etype</em> this function returns the symbol name for the member indexed by @@ -1310,7 +1310,7 @@ H5Tlock(hdf_fr_colors);</pre> <code>free()</code>. <br><br> - <dt><code>herr_t H5Tget_member_value(hid_t <em>etype</em>, int + <dt><code>herr_t H5Tget_member_value(hid_t <em>etype</em>, unsigned <em>membno</em>, void *<em>value</em>/*out*/)</code> <dd>Given an enumeration datatype <em>etype</em> this function returns the value associated with the member indexed by @@ -1325,12 +1325,13 @@ H5Tlock(hdf_fr_colors);</pre> when the type is not known by the C compiler. <pre> -int i, n = H5Tget_nmembers(hdf_en_colors); -for (i=0; i<n; i++) { - char *symbol = H5Tget_member_name(hdf_en_colors, i); +int n = H5Tget_nmembers(hdf_en_colors); +unsigned u; +for (u=0; u<(unsigned)n; u++) { + char *symbol = H5Tget_member_name(hdf_en_colors, u); short val; - H5Tget_member_value(hdf_en_colors, i, &val); - printf("#%d %20s = %d\n", i, symbol, val); + H5Tget_member_value(hdf_en_colors, u, &val); + printf("#%u %20s = %d\n", u, symbol, val); free(symbol); }</pre> @@ -1502,13 +1503,13 @@ int n = H5Tget_nmembers(foreign); hid_t itype = H5Tget_super(foreign); void *val = malloc(n * MAX(H5Tget_size(itype), sizeof(int))); char *name = malloc(n * sizeof(char*)); -int i; +unsigned u; /* Get foreign type information */ -for (i=0; i<n; i++) { - name[i] = H5Tget_member_name(foreign, i); - H5Tget_member_value(foreign, i, - (char*)val+i*H5Tget_size(foreign)); +for (u=0; u<(unsigned)n; u++) { + name[u] = H5Tget_member_name(foreign, u); + H5Tget_member_value(foreign, u, + (char*)val+u*H5Tget_size(foreign)); } /* Convert integer values to new type */ diff --git a/doc/html/DatatypesEnum.html b/doc/html/DatatypesEnum.html index 2926e7c..607030a 100644 --- a/doc/html/DatatypesEnum.html +++ b/doc/html/DatatypesEnum.html @@ -239,7 +239,7 @@ H5Tlock(hdf_fr_colors);</pre> types. <br><br> - <dt><code>char *H5Tget_member_name(hid_t <em>etype</em>, int + <dt><code>char *H5Tget_member_name(hid_t <em>etype</em>, unsigned <em>membno</em>)</code> <dd>Given an enumeration data type <em>etype</em> this function returns the symbol name for the member indexed by @@ -252,7 +252,7 @@ H5Tlock(hdf_fr_colors);</pre> <code>free()</code>. <br><br> - <dt><code>herr_t H5Tget_member_value(hid_t <em>etype</em>, int + <dt><code>herr_t H5Tget_member_value(hid_t <em>etype</em>, unsigned <em>membno</em>, void *<em>value</em>/*out*/)</code> <dd>Given an enumeration data type <em>etype</em> this function returns the value associated with the member indexed by @@ -267,12 +267,13 @@ H5Tlock(hdf_fr_colors);</pre> when the type is not known by the C compiler. <pre> -int i, n = H5Tget_nmembers(hdf_en_colors); -for (i=0; i<n; i++) { - char *symbol = H5Tget_member_name(hdf_en_colors, i); +int n = H5Tget_nmembers(hdf_en_colors); +unsigned u; +for (u=0; u<(unsigned)n; u++) { + char *symbol = H5Tget_member_name(hdf_en_colors, u); short val; - H5Tget_member_value(hdf_en_colors, i, &val); - printf("#%d %20s = %d\n", i, symbol, val); + H5Tget_member_value(hdf_en_colors, u, &val); + printf("#%u %20s = %d\n", u, symbol, val); free(symbol); }</pre> @@ -445,13 +446,13 @@ int n = H5Tget_nmembers(foreign); hid_t itype = H5Tget_super(foreign); void *val = malloc(n * MAX(H5Tget_size(itype), sizeof(int))); char *name = malloc(n * sizeof(char*)); -int i; +unsigned u; /* Get foreign type information */ -for (i=0; i<n; i++) { - name[i] = H5Tget_member_name(foreign, i); - H5Tget_member_value(foreign, i, - (char*)val+i*H5Tget_size(foreign)); +for (u=0; u<(unsigned)n; u++) { + name[u] = H5Tget_member_name(foreign, u); + H5Tget_member_value(foreign, u, + (char*)val+u*H5Tget_size(foreign)); } /* Convert integer values to new type */ diff --git a/doc/html/H5.intro.html b/doc/html/H5.intro.html index d4689cd..b0cee5f 100644 --- a/doc/html/H5.intro.html +++ b/doc/html/H5.intro.html @@ -1387,7 +1387,7 @@ A hyperslab specifies a regular pattern of elements in a dataset. It is also po hsize_t dim2[] = {MSPACE2_DIM}; /* Dimension size of the second dataset (in memory) */ int values[] = {53, 59, 61, 67}; /* New values to be written */ -hssize_t coord[NPOINTS][FSPACE_RANK]; /* Array to store selected points +hsize_t coord[NPOINTS][FSPACE_RANK]; /* Array to store selected points from the file dataspace */ /* @@ -1404,7 +1404,7 @@ coord[2][0] = 3; coord[2][1] = 5; coord[3][0] = 5; coord[3][1] = 6; ret = H5Sselect_elements(fid, H5S_SELECT_SET, NPOINTS, - (const hssize_t **)coord); + (const hsize_t **)coord); /* * Write new selection of points to the dataset. diff --git a/doc/html/Intro/IntroExamples.html b/doc/html/Intro/IntroExamples.html index 9d1c833..dd4022a 100644 --- a/doc/html/Intro/IntroExamples.html +++ b/doc/html/Intro/IntroExamples.html @@ -246,9 +246,9 @@ main (void) int data_out[NX][NY][NZ ]; /* output buffer */ hsize_t count[2]; /* size of the hyperslab in the file */ - hssize_t offset[2]; /* hyperslab offset in the file */ + hsize_t offset[2]; /* hyperslab offset in the file */ hsize_t count_out[3]; /* size of the hyperslab in memory */ - hssize_t offset_out[3]; /* hyperslab offset in memory */ + hsize_t offset_out[3]; /* hyperslab offset in memory */ int i, j, k, status_n, rank; for (j = 0; j < NX; j++) { @@ -404,12 +404,12 @@ int main (void) hsize_t fdim[] = {FSPACE_DIM1, FSPACE_DIM2}; /* Dimension sizes of the dataset (on disk) */ - hssize_t start[2]; /* Start of hyperslab */ + hsize_t start[2]; /* Start of hyperslab */ hsize_t stride[2]; /* Stride of hyperslab */ hsize_t count[2]; /* Block count */ hsize_t block[2]; /* Block sizes */ - hssize_t coord[NPOINTS][FSPACE_RANK]; /* Array to store selected points + hsize_t coord[NPOINTS][FSPACE_RANK]; /* Array to store selected points from the file dataspace */ herr_t ret; uint i,j; @@ -504,7 +504,7 @@ int main (void) coord[3][0] = 5; coord[3][1] = 6; ret = H5Sselect_elements(fid, H5S_SELECT_SET, NPOINTS, - (const hssize_t **)coord); + (const hsize_t **)coord); /* * Write new selection of points to the dataset. @@ -779,7 +779,7 @@ main (void) hsize_t maxdims[2] = {H5S_UNLIMITED, H5S_UNLIMITED}; hsize_t chunk_dims[2] ={2, 5}; hsize_t size[2]; - hssize_t offset[2]; + hsize_t offset[2]; herr_t status; @@ -956,7 +956,7 @@ main (void) hsize_t chunk_dims[2]; hsize_t col_dims[1]; hsize_t count[2]; - hssize_t offset[2]; + hsize_t offset[2]; herr_t status, status_n; @@ -1117,7 +1117,7 @@ main (void) H5Fclose(file); return 0; -) +} </pre> @@ -1851,18 +1851,18 @@ and then written to the dataset in the file. int main(void) { - hid_t fid1; /* HDF5 File IDs */ - hid_t dset1, /* Dataset ID */ + hid_t fid1; /* HDF5 File IDs */ + hid_t dset1, /* Dataset ID */ dset2; /* Dereferenced dataset ID */ - hid_t sid1, /* Dataspace ID #1 */ + hid_t sid1, /* Dataspace ID #1 */ sid2; /* Dataspace ID #2 */ - hsize_t dims1[] = {SPACE1_DIM1}, + hsize_t dims1[] = {SPACE1_DIM1}, dims2[] = {SPACE2_DIM1, SPACE2_DIM2}; - hssize_t start[SPACE2_RANK]; /* Starting location of hyperslab */ - hsize_t stride[SPACE2_RANK]; /* Stride of hyperslab */ - hsize_t count[SPACE2_RANK]; /* Element count of hyperslab */ - hsize_t block[SPACE2_RANK]; /* Block size of hyperslab */ - hssize_t coord1[POINT1_NPOINTS][SPACE2_RANK]; + hsize_t start[SPACE2_RANK]; /* Starting location of hyperslab */ + hsize_t stride[SPACE2_RANK]; /* Stride of hyperslab */ + hsize_t count[SPACE2_RANK]; /* Element count of hyperslab */ + hsize_t block[SPACE2_RANK]; /* Block size of hyperslab */ + hsize_t coord1[POINT1_NPOINTS][SPACE2_RANK]; /* Coordinates for point selection */ hdset_reg_ref_t *wbuf; /* buffer to write to disk */ int *dwbuf; /* Buffer for writing numeric data to disk */ @@ -1921,7 +1921,7 @@ main(void) coord1[7][0]=9; coord1[7][1]=0; coord1[8][0]=7; coord1[8][1]=1; coord1[9][0]=3; coord1[9][1]=3; - ret = H5Sselect_elements(sid2,H5S_SELECT_SET,POINT1_NPOINTS,(const hssize_t **)coord1); + ret = H5Sselect_elements(sid2,H5S_SELECT_SET,POINT1_NPOINTS,(const hsize_t **)coord1); /* Store second dataset region */ ret = H5Rcreate(&wbuf[1],fid1,"/Dataset2",H5R_DATASET_REGION,sid2); @@ -1988,8 +1988,8 @@ main(void) hid_t sid1, /* Dataspace ID #1 */ sid2; /* Dataspace ID #2 */ hsize_t * coords; /* Coordinate buffer */ - hssize_t low[SPACE2_RANK]; /* Selection bounds */ - hssize_t high[SPACE2_RANK]; /* Selection bounds */ + hsize_t low[SPACE2_RANK]; /* Selection bounds */ + hsize_t high[SPACE2_RANK]; /* Selection bounds */ hdset_reg_ref_t *rbuf; /* buffer to to read disk */ int *drbuf; /* Buffer for reading numeric data from disk */ int i, j; /* counting variables */ diff --git a/doc/html/RM_H5.html b/doc/html/RM_H5.html index 08eadf5..37fe74d 100644 --- a/doc/html/RM_H5.html +++ b/doc/html/RM_H5.html @@ -234,14 +234,17 @@ as the corresponding C function. the 1 is the release number, <code>relnum</code>. --> <dt><strong>Parameters:</strong> - <dl> - <dt><em>unsigned </em><code>majnum</code> - <dd>IN: The major version of the library. - <dt><em>unsigned </em><code>minnum</code> - <dd>IN: The minor version of the library. - <dt><em>unsigned </em><code>relnum</code> - <dd>IN: The release number of the library. - </dl> + <ul><table> + <tr> + <td valign="top"><em>unsigned </em><code>majnum</code></td> + <td valign="top">IN: The major version of the library.</td></tr> + <tr> + <td valign="top"><em>unsigned </em><code>minnum </code></td> + <td valign="top">IN: The minor version of the library.</td></tr> + <tr> + <td valign="top"><em>unsigned </em><code>relnum</code></td> + <td valign="top">IN: The release number of the library.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Upon failure, this function causes the application to abort. @@ -423,14 +426,17 @@ END SUBROUTINE h5garbage_collect_f numbers of the version of the HDF library which is linked to the application. <dt><strong>Parameters:</strong> - <dl> - <dt><em>unsigned *</em><code>majnum</code> - <dd>OUT: The major version of the library. - <dt><em>unsigned *</em><code>minnum</code> - <dd>OUT: The minor version of the library. - <dt><em>unsigned *</em><code>relnum</code> - <dd>OUT: The release number of the library. - </dl> + <ul><table> + <tr> + <td valign="top"><em>unsigned *</em><code>majnum</code></td> + <td valign="top">OUT: The major version of the library.</td></tr> + <tr> + <td valign="top"><em>unsigned *</em><code>minnum </code></td> + <td valign="top">OUT: The minor version of the library.</td></tr> + <tr> + <td valign="top"><em>unsigned *</em><code>relnum</code></td> + <td valign="top">OUT: The release number of the library.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -553,20 +559,26 @@ END SUBROUTINE h5open_f Using a value of <code>-1</code> for a limit means that no limit is set for the specified type of free list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>int</em> <code>reg_global_lim</code> - <dd>IN: The limit on all regular free list memory used - <dt><em>int</em> <code>reg_list_lim</code> - <dd>IN: The limit on memory used in each regular free list - <dt><em>int</em> <code>arr_global_lim</code> - <dd>IN: The limit on all array free list memory used - <dt><em>int</em> <code>arr_list_lim</code> - <dd>IN: The limit on memory used in each array free list - <dt><em>int</em> <code>blk_global_lim</code> - <dd>IN: The limit on all block free list memory used - <dt><em>int</em> <code>blk_list_lim</code> - <dd>IN: The limit on memory used in each block free list - </dl> + <ul><table> + <tr> + <td valign="top"><em>int</em> <code>reg_global_lim </code></td> + <td valign="top">IN: The limit on all regular free list memory used</td></tr> + <tr> + <td valign="top"><em>int</em> <code>reg_list_lim</code></td> + <td valign="top">IN: The limit on memory used in each regular free list</td></tr> + <tr> + <td valign="top"><em>int</em> <code>arr_global_lim</code></td> + <td valign="top">IN: The limit on all array free list memory used</td></tr> + <tr> + <td valign="top"><em>int</em> <code>arr_list_lim</code></td> + <td valign="top">IN: The limit on memory used in each array free list</td></tr> + <tr> + <td valign="top"><em>int</em> <code>blk_global_lim</code></td> + <td valign="top">IN: The limit on all block free list memory used</td></tr> + <tr> + <td valign="top"><em>int</em> <code>blk_list_lim</code></td> + <td valign="top">IN: The limit on memory used in each block free list</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. diff --git a/doc/html/RM_H5A.html b/doc/html/RM_H5A.html index 82a3e61..334219a 100644 --- a/doc/html/RM_H5A.html +++ b/doc/html/RM_H5A.html @@ -208,10 +208,11 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the Further use of a released attribute identifier is illegal; a function using such an identifier will fail. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>attr_id</code> - <dd>IN: Attribute to release access to. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>attr_id</code></td> + <td>IN: Attribute to release access to.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -240,11 +241,11 @@ END SUBROUTINE h5aclose_f <dl> <dt><strong>Name:</strong> <a name="Annot-Create">H5Acreate</a> <dt><strong>Signature:</strong> - <dd><font size="-1"><em>hid_t</em> <code>H5Acreate</code>(<em>hid_t</em> <code>loc_id</code>, + <dd><em>hid_t</em> <code>H5Acreate</code>(<em>hid_t</em> <code>loc_id</code>, <em>const char *</em><code>name</code>, <em>hid_t</em> <code>type_id</code>, <em>hid_t</em> <code>space_id</code>, - <em>hid_t</em> <code>create_plist</code></font> + <em>hid_t</em> <code>create_plist</code> ) <dt><strong>Purpose:</strong> <dd>Creates a dataset as an attribute of another group, dataset, @@ -275,19 +276,24 @@ END SUBROUTINE h5aclose_f The attribute identifier returned from this function must be released with <code>H5Aclose</code> or resource leaks will develop. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code></dt> - <dd>IN: Object (dataset, group, or named datatype) to be attached to.</dd> - <dt><em>const char *</em><code>name</code></dt> - <dd>IN: Name of attribute to create.</dd> - <dt><em>hid_t</em> <code>type_id</code></dt> - <dd>IN: Identifier of datatype for attribute.</dd> - <dt><em>hid_t</em> <code>space_id</code></dt> - <dd>IN: Identifier of dataspace for attribute.</dd> - <dt><em>hid_t</em> <code>create_plist</code></dt> - <dd>IN: Identifier of creation property list. (Currently unused; - the only accepted value is <code>H5P_DEFAULT</code>.)</dd> - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: Object (dataset, group, or named datatype) to be attached to.</td></tr> + <tr> + <td valign="top"><em>const char *</em><code>name</code></td> + <td valign="top">IN: Name of attribute to create.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">IN: Identifier of datatype for attribute.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id</code></td> + <td valign="top">IN: Identifier of dataspace for attribute.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>create_plist </code></td> + <td valign="top">IN: Identifier of creation property list. (Currently unused; + the only accepted value is <code>H5P_DEFAULT</code>.)</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns an attribute identifier if successful; otherwise returns a negative value. @@ -338,13 +344,15 @@ END SUBROUTINE h5acreate_f of the attributes to change and future writes to the open attributes to produce incorrect results. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Identifier of the dataset, group, or named datatype - to have the attribute deleted from. - <dt><em>const char *</em><code>name</code> - <dd>IN: Name of the attribute to delete. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: Identifier of the dataset, group, or named datatype + to have the attribute deleted from.</td></tr> + <tr> + <td valign="top"><em>const char *</em><code>name </code></td> + <td valign="top">IN: Name of the attribute to delete.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -389,14 +397,17 @@ END SUBROUTINE h5adelete_f <code>(buf_size -1)</code>, the string terminator is stored in the last position of the buffer to properly terminate the string. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>attr_id</code> - <dd>IN: Identifier of the attribute. - <dt><em>size_t</em> <code>buf_size</code> - <dd>IN: The size of the buffer to store the name in. - <dt><em>char *</em><code>buf</code> - <dd>IN: Buffer to store name in. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>attr_id</code></td> + <td valign="top">IN: Identifier of the attribute.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>buf_size </code></td> + <td valign="top">IN: The size of the buffer to store the name in.</td></tr> + <tr> + <td valign="top"><em>char *</em><code>buf</code></td> + <td valign="top">IN: Buffer to store name in.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the length of the attribute's name, which may be longer than <code>buf_size</code>, if successful. @@ -437,10 +448,11 @@ END SUBROUTINE h5aget_name_f <code>loc_id</code>. The object can be a group, dataset, or named datatype. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Identifier of a group, dataset, or named datatype. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id </code></td> + <td valign="top">IN: Identifier of a group, dataset, or named datatype.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the number of attributes if successful; otherwise returns a negative value. @@ -479,10 +491,11 @@ END SUBROUTINE h5aget_num_attrs_f this function must be released with <code>H5Sclose</code> or resource leaks will develop. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>attr_id</code> - <dd>IN: Identifier of an attribute. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>attr_id </code></td> + <td valign="top">IN: Identifier of an attribute.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns attribute dataspace identifier if successful; otherwise returns a negative value. @@ -527,10 +540,11 @@ END SUBROUTINE h5aget_space_f The datatype identifier returned from this function must be released with <code>H5Tclose</code> or resource leaks will develop. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>attr_id</code> - <dd>IN: Identifier of an attribute. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>attr_id </code></td> + <td valign="top">IN: Identifier of an attribute.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a datatype identifier if successful; otherwise returns a negative value. @@ -603,16 +617,20 @@ END SUBROUTINE h5aget_type_f attribute. </ul> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Identifier of a group, dataset or named datatype. - <dt><em>unsigned *</em> <code>idx</code> - <dd>IN/OUT: Starting (IN) and ending (OUT) attribute index. - <dt><em>H5A_operator_t</em> <code>op</code> - <dd>IN: User's function to pass each attribute to - <dt><em>void *</em><code>op_data</code> - <dd>IN/OUT: User's data to pass through to iterator operator function - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: Identifier of a group, dataset or named datatype.</td></tr> + <tr> + <td valign="top"><em>unsigned *</em> <code>idx</code></td> + <td valign="top">IN/OUT: Starting (IN) and ending (OUT) attribute index.</td></tr> + <tr> + <td valign="top"><em>H5A_operator_t</em> <code>op </code></td> + <td valign="top">IN: User's function to pass each attribute to</td></tr> + <tr> + <td valign="top"><em>void *</em><code>op_data</code></td> + <td valign="top">IN/OUT: User's data to pass through to iterator operator function</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>If successful, returns the return value of the last operator if it was non-zero, or zero if all attributes were processed. @@ -655,13 +673,15 @@ SUBROUTINE The attribute identifier returned from this function must be released with <code>H5Aclose</code> or resource leaks will develop. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Identifier of the group, dataset, or named datatype - attribute to be attached to. - <dt><em>unsigned int</em> <code>idx</code> - <dd>IN: Index of the attribute to open. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: Identifier of the group, dataset, or named datatype + attribute to be attached to.</td></tr> + <tr> + <td valign="top"><em>unsigned int</em> <code>idx </code></td> + <td valign="top">IN: Index of the attribute to open.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns attribute identifier if successful; otherwise returns a negative value. @@ -707,13 +727,15 @@ END SUBROUTINE h5aopen_idx_f be released with <code>H5Aclose</code> or resource leaks will develop. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Identifier of a group, dataset, or named datatype - atttribute to be attached to. - <dt><em>const char *</em><code>name</code> - <dd>IN: Attribute name. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: Identifier of a group, dataset, or named datatype + atttribute to be attached to.</td></tr> + <tr> + <td valign="top"><em>const char *</em><code>name </code></td> + <td valign="top">IN: Attribute name.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns attribute identifier if successful; otherwise returns a negative value. @@ -764,14 +786,17 @@ END SUBROUTINE h5aopen_name_f data conversion, including the range of conversions currently supported by the HDF5 libraries. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>attr_id</code> - <dd>IN: Identifier of an attribute to read. - <dt><em>hid_t</em> <code>mem_type_id</code> - <dd>IN: Identifier of the attribute datatype (in memory). - <dt><em>void *</em><code>buf</code> - <dd>OUT: Buffer for data to be read. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>attr_id</code></td> + <td valign="top">IN: Identifier of an attribute to read.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>mem_type_id </code></td> + <td valign="top">IN: Identifier of the attribute datatype (in memory).</td></tr> + <tr> + <td valign="top"><em>void *</em><code>buf</code></td> + <td valign="top">OUT: Buffer for data to be read.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -831,14 +856,17 @@ END SUBROUTINE h5aread_f data conversion, including the range of conversions currently supported by the HDF5 libraries. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>attr_id</code> - <dd>IN: Identifier of an attribute to write. - <dt><em>hid_t</em> <code>mem_type_id</code> - <dd>IN: Identifier of the attribute datatype (in memory). - <dt><em>const void *</em><code>buf</code> - <dd>IN: Data to be written. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>attr_id</code></td> + <td valign="top">IN: Identifier of an attribute to write.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>mem_type_id </code></td> + <td valign="top">IN: Identifier of the attribute datatype (in memory).</td></tr> + <tr> + <td valign="top"><em>const void *</em><code>buf</code></td> + <td valign="top">IN: Data to be written.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. diff --git a/doc/html/RM_H5D.html b/doc/html/RM_H5D.html index c185245..3c72863 100644 --- a/doc/html/RM_H5D.html +++ b/doc/html/RM_H5D.html @@ -210,10 +210,11 @@ as the corresponding C function. Further use of the dataset identifier is illegal in calls to the dataset API. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dataset_id</code> - <dd>IN: Identifier of the dataset to close access to. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dataset_id </code></td> + <td valign="top">IN: Identifier of the dataset to close access to.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -297,15 +298,15 @@ END SUBROUTINE h5dclose_f <table width=80% border="0"> <tr valign="top" align="left"><td width=10%> </td><td width=45%> - <a href="#Dataset-Fill">H5Dfill</a><br> - <a href="RM_H5P.html#Property-SetFillValue">H5Pset_fill_value</a><br> - <a href="RM_H5P.html#Property-GetFillValue">H5Pget_fill_value</a><br> - <a href="RM_H5P.html#Property-FillValueDefined">H5Pfill_value_defined</a> + <a href="#Dataset-Fill"><code>H5Dfill</code></a><br> + <a href="RM_H5P.html#Property-SetFillValue"><code>H5Pset_fill_value</code></a><br> + <a href="RM_H5P.html#Property-GetFillValue"><code>H5Pget_fill_value</code></a><br> + <a href="RM_H5P.html#Property-FillValueDefined"><code>H5Pfill_value_defined</code></a> </td><td width=45%> - <a href="RM_H5P.html#Property-SetFillTime">H5Pset_fill_time</a><br> - <a href="RM_H5P.html#Property-GetFillTime">H5Pget_fill_time</a><br> - <a href="RM_H5P.html#Property-SetAllocTime">H5Pset_alloc_time</a><br> - <a href="RM_H5P.html#Property-GetAllocTime">H5Pget_alloc_time</a> + <a href="RM_H5P.html#Property-SetFillTime"><code>H5Pset_fill_time</code></a><br> + <a href="RM_H5P.html#Property-GetFillTime"><code>H5Pget_fill_time</code></a><br> + <a href="RM_H5P.html#Property-SetAllocTime"><code>H5Pset_alloc_time</code></a><br> + <a href="RM_H5P.html#Property-GetAllocTime"><code>H5Pget_alloc_time</code></a> </td></tr> </table> This information is also included in the @@ -336,21 +337,27 @@ END SUBROUTINE h5dclose_f Other known similar problems can occur with . . . --> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Identifier of the file or group - within which to create the dataset. - <dt><em>const char *</em> <code>name</code> - <dd>IN: The name of the dataset to create. - <dt><em>hid_t</em> <code>type_id</code> - <dd>IN: Identifier of the datatype to use - when creating the dataset. - <dt><em>hid_t</em> <code>space_id</code> - <dd>IN: Identifier of the dataspace to use - when creating the dataset. - <dt><em>hid_t</em> <code>create_plist_id</code> - <dd>IN: Identifier of the set creation property list. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: Identifier of the file or group + within which to create the dataset.</td></tr> + <tr> + <td valign="top"><em>const char *</em> <code>name</code></td> + <td valign="top">IN: The name of the dataset to create.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">IN: Identifier of the datatype to use + when creating the dataset.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id</code></td> + <td valign="top">IN: Identifier of the dataspace to use + when creating the dataset.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>create_plist_id </code></td> + <td valign="top">IN: Identifier of the set creation property list.</td></tr> + </table></ul> +<!-- NEW PAGE --> <dt><strong>Returns:</strong> <dd>Returns a dataset identifier if successful; otherwise returns a negative value. @@ -412,12 +419,14 @@ END SUBROUTINE h5dcreate_f <a href="RM_H5P.html#Property-SetAllocTime">H5Pset_alloc_time</a>.) <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dataset_id</code> - <dd>IN: Identifier of the dataset. - <dt><em>const hsize_t *</em> <code>size</code> - <dd>IN: Array containing the new magnitude of each dimension. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dataset_id</code></td> + <td valign="top">IN: Identifier of the dataset.</td></tr> + <tr> + <td valign="top"><em>const hsize_t *</em> <code>size </code></td> + <td valign="top">IN: Array containing the new magnitude of each dimension.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -491,20 +500,25 @@ END SUBROUTINE h5dextend_f and <a href="#Dataset-Create">H5Dcreate</a>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>const void *</em><code>fill</code> - <dd>IN: Pointer to the fill value to be used. - <dt><em>hid_t </em><code>fill_type_id</code> - <dd>IN: Fill value datatype identifier. - <dt><em>void *</em><code>buf</code> - <dd>IN/OUT: Pointer to the memory buffer containing the - selection to be filled. - <dt><em>hid_t </em><code>buf_type_id</code> - <dd>IN: Datatype of dataspace elements to be filled. - <dt><em>hid_t </em><code>space_id</code> - <dd>IN: Dataspace describing memory buffer and - containing the selection to be filled. - </dl> + <ul><table> + <tr> + <td valign="top"><em>const void *</em><code>fill</code></td> + <td valign="top">IN: Pointer to the fill value to be used.</td></tr> + <tr> + <td valign="top"><em>hid_t </em><code>fill_type_id </code></td> + <td valign="top">IN: Fill value datatype identifier.</td></tr> + <tr> + <td valign="top"><em>void *</em><code>buf</code></td> + <td valign="top">IN/OUT: Pointer to the memory buffer containing the + selection to be filled.</td></tr> + <tr> + <td valign="top"><em>hid_t </em><code>buf_type_id</code></td> + <td valign="top">IN: Datatype of dataspace elements to be filled.</td></tr> + <tr> + <td valign="top"><em>hid_t </em><code>space_id</code></td> + <td valign="top">IN: Dataspace describing memory buffer and + containing the selection to be filled.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -550,10 +564,11 @@ END SUBROUTINE h5dfill_f The creation property list identifier should be released with the <code>H5Pclose</code> function. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dataset_id</code> - <dd>IN: Identifier of the dataset to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dataset_id </code></td> + <td valign="top">IN: Identifier of the dataset to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a dataset creation property list identifier if successful; otherwise returns a negative value. @@ -594,10 +609,11 @@ END SUBROUTINE h5dget_create_plist_f That address is expressed as the offset in bytes from the beginning of the file. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t </em><code>dset_id</code> - <dd>Dataset identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t </em><code>dset_id </code></td> + <td valign="top">Dataset identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the offset in bytes; otherwise returns <code>HADDR_UNDEF</code>, a negative value. @@ -633,10 +649,11 @@ SUBROUTINE The dataspace identifier should be released with the <code>H5Sclose</code> function. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dataset_id</code> - <dd>IN: Identifier of the dataset to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dataset_id </code></td> + <td valign="top">IN: Identifier of the dataset to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a dataspace identifier if successful; otherwise returns a negative value. @@ -679,15 +696,15 @@ END SUBROUTINE h5dget_space_f <center> <table border="0"> <tr valign="top"><td rowspan="3"> </td><td> - H5D_SPACE_STATUS_NOT_ALLOCATED + <code>H5D_SPACE_STATUS_NOT_ALLOCATED</code> </td><td> Space has not been allocated for this dataset. </td></tr><tr valign="top"><td> - H5D_SPACE_STATUS_ALLOCATED + <code>H5D_SPACE_STATUS_ALLOCATED</code> </td><td> Space has been allocated for this dataset. </td></tr><tr valign="top"><td> - H5D_SPACE_STATUS_PART_ALLOCATED + <code>H5D_SPACE_STATUS_PART_ALLOCATED</code> </td><td> Space has been partially allocated for this dataset. (Used only for datasets with chunked storage.) @@ -695,12 +712,14 @@ END SUBROUTINE h5dget_space_f </table> </center> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dset_id</code> - <dd>IN: Identifier of the dataset to query. - <dt><em>H5D_space_status_t *</em><code>status</code> - <dd>OUT: Space allocation status. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dset_id</code></td> + <td valign="top">IN: Identifier of the dataset to query.</td></tr> + <tr> + <td valign="top"><em>H5D_space_status_t *</em><code>status </code></td> + <td valign="top">OUT: Space allocation status.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -745,10 +764,11 @@ END SUBROUTINE h5dget_space_status_f the chunk size. The return value may be zero if no data has been stored. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dataset_id</code> - <dd>IN: Identifier of the dataset to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dataset_id </code></td> + <td valign="top">IN: Identifier of the dataset to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the amount of storage space allocated for the dataset, not counting meta data; @@ -794,10 +814,11 @@ END SUBROUTINE h5dget_storage_size_f Otherwise, the returned datatype is read-only. If atomization of the datatype fails, then the datatype is closed. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dataset_id</code> - <dd>IN: Identifier of the dataset to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dataset_id </code></td> + <td valign="top">IN: Identifier of the dataset to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a datatype identifier if successful; otherwise returns a negative value. @@ -848,23 +869,28 @@ END SUBROUTINE h5dget_type_f the iteration may then be re-started by the user where it left off. <dt><strong>Parameters:</strong> - <dl> - <dt><em>void *</em><code>buf</code> - <dd>IN/OUT: Pointer to the buffer in memory containing the - elements to iterate over. - <dt><em>hid_t </em><code>type_id</code> - <dd>IN: Datatype identifier for the elements stored in - <code>buf</code>. - <dt><em>hid_t </em><code>space_id</code> - <dd>IN: Dataspace identifier for <code>buf</code>. - Also contains the selection to iterate over. - <dt><em>H5D_operator_t </em><code>operator</code> - <dd>IN: Function pointer to the routine to be called - for each element in <code>buf</code> iterated over. - <dt><em>void *</em><code>operator_data</code> - <dd>IN/OUT: Pointer to any user-defined data associated - with the operation. - </dl> + <ul><table> + <tr> + <td valign="top"><em>void *</em><code>buf</code></td> + <td valign="top">IN/OUT: Pointer to the buffer in memory containing the + elements to iterate over.</td></tr> + <tr> + <td valign="top"><em>hid_t </em><code>type_id</code></td> + <td valign="top">IN: Datatype identifier for the elements stored in + <code>buf</code>.</td></tr> + <tr> + <td valign="top"><em>hid_t </em><code>space_id</code></td> + <td valign="top">IN: Dataspace identifier for <code>buf</code>. + Also contains the selection to iterate over.</td></tr> + <tr> + <td valign="top"><em>H5D_operator_t </em><code>operator </code></td> + <td valign="top">IN: Function pointer to the routine to be called + for each element in <code>buf</code> iterated over.</td></tr> + <tr> + <td valign="top"><em>void *</em><code>operator_data</code></td> + <td valign="top">IN/OUT: Pointer to any user-defined data associated + with the operation.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the return value of the last operator if it was non-zero, or zero if all elements have been processed. @@ -901,13 +927,15 @@ SUBROUTINE or group specified in <code>loc_id</code>. <code>name</code> is a dataset name and is used to identify the dataset in the file. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Identifier of the file or group - within which the dataset to be accessed will be found. - <dt><em>const char *</em> <code>name</code> - <dd>IN: The name of the dataset to access. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: Identifier of the file or group + within which the dataset to be accessed will be found.</td></tr> + <tr> + <td valign="top"><em>const char *</em> <code>name </code></td> + <td valign="top">IN: The name of the dataset to access.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a dataset identifier if successful; otherwise returns a negative value. @@ -1075,21 +1103,27 @@ END SUBROUTINE h5dopen_f data conversion, including the range of conversions currently supported by the HDF5 libraries. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dataset_id</code> - <dd>IN: Identifier of the dataset read from. - <dt><em>hid_t</em> <code>mem_type_id</code> - <dd>IN: Identifier of the memory datatype. - <dt><em>hid_t</em> <code>mem_space_id</code> - <dd>IN: Identifier of the memory dataspace. - <dt><em>hid_t</em> <code>file_space_id</code> - <dd>IN: Identifier of the dataset's dataspace in the file. - <dt><em>hid_t</em> <code>xfer_plist_id</code> - <dd>IN: Identifier of a transfer property list - for this I/O operation. - <dt><em>void *</em> <code>buf</code> - <dd>OUT: Buffer to receive data read from file. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dataset_id</code></td> + <td valign="top">IN: Identifier of the dataset read from.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>mem_type_id</code></td> + <td valign="top">IN: Identifier of the memory datatype.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>mem_space_id</code></td> + <td valign="top">IN: Identifier of the memory dataspace.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>file_space_id </code></td> + <td valign="top">IN: Identifier of the dataset's dataspace in the file.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>xfer_plist_id </code></td> + <td valign="top">IN: Identifier of a transfer property list + for this I/O operation.</td></tr> + <tr> + <td valign="top"><em>void *</em> <code>buf</code></td> + <td valign="top">OUT: Buffer to receive data read from file.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1101,33 +1135,32 @@ SUBROUTINE h5dread_f(dset_id, mem_type_id, buf, dims, hdferr, & mem_space_id, file_space_id, xfer_prp) IMPLICIT NONE - INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier - INTEGER(HID_T), INTENT(IN) :: mem_type_id ! Memory datatype identifier - TYPE, INTENT(INOUT) :: buf ! Data buffer; may be a scalar - ! or an array + INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier + INTEGER(HID_T), INTENT(IN) :: mem_type_id ! Memory datatype identifier + TYPE, INTENT(INOUT) :: buf ! Data buffer; may be a scalar + ! or an array DIMENSION(*), INTEGER(HSIZE_T), INTENT(IN) :: dims - ! Array to hold corresponding - ! dimension sizes of data - ! buffer buf - ! dim(k) has value of the k-th - ! dimension of buffer buf - ! Values are ignored if buf is - ! a scalar - INTEGER, INTENT(OUT) :: hdferr ! Error code - ! 0 on success and -1 on failure + ! Array to hold corresponding + ! dimension sizes of data + ! buffer buf + ! dim(k) has value of the k-th + ! dimension of buffer buf + ! Values are ignored if buf is + ! a scalar + INTEGER, INTENT(OUT) :: hdferr ! Error code + ! 0 on success and -1 on failure INTEGER(HID_T), OPTIONAL, INTENT(IN) :: mem_space_id - ! Memory dataspace identfier - ! Default value is H5S_ALL_F + ! Memory dataspace identfier + ! Default value is H5S_ALL_F INTEGER(HID_T), OPTIONAL, INTENT(IN) :: file_space_id - ! File dataspace identfier - ! Default value is H5S_ALL_F + ! File dataspace identfier + ! Default value is H5S_ALL_F INTEGER(HID_T), OPTIONAL, INTENT(IN) :: xfer_prp - ! Transfer property list identifier - ! Default value is H5P_DEFAULT_F + ! Transfer property list identifier + ! Default value is H5P_DEFAULT_F END SUBROUTINE h5dread_f </pre> - <!--<dt><strong>Non-C API(s):</strong> <dd> @@ -1159,16 +1192,21 @@ END SUBROUTINE h5dread_f <code>*size</code> is returned with the number of bytes required to store the VL data in memory. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dataset_id</code> - <dd>IN: Identifier of the dataset to query. - <dt><em>hid_t</em> <code>type_id</code> - <dd>IN: Datatype identifier. - <dt><em>hid_t</em> <code>space_id</code> - <dd>IN: Dataspace identifier. - <dt><em>hsize_t</em> *<code>size</code> - <dd>OUT: The size in bytes of the memory buffer required to store the VL data. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dataset_id </code></td> + <td valign="top">IN: Identifier of the dataset to query.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">IN: Datatype identifier.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id</code></td> + <td valign="top">IN: Dataspace identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> *<code>size</code></td> + <td valign="top">OUT: The size in bytes of the memory + buffer required to store the VL data.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns non-negative value if successful; otherwise returns a negative value. @@ -1228,16 +1266,20 @@ END SUBROUTINE h5dvlen_get_max_len_f this routine frees them <em>from the bottom up</em>, releasing all the memory without creating memory leaks. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>IN: Identifier of the datatype. - <dt><em>hid_t</em> <code>space_id</code> - <dd>IN: Identifier of the dataspace. - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Identifier of the property list used to create the buffer. - <dt><em>void</em> *<code>buf</code> - <dd>IN: Pointer to the buffer to be reclaimed. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">IN: Identifier of the datatype.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">IN: Identifier of the dataspace.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Identifier of the property list used to create the buffer.</td></tr> + <tr> + <td valign="top"><em>void</em> *<code>buf</code></td> + <td valign="top">IN: Pointer to the buffer to be reclaimed.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns non-negative value if successful; otherwise returns a negative value. @@ -1418,21 +1460,27 @@ SUBROUTINE write identical data to the dataset from all processes. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dataset_id</code> - <dd>IN: Identifier of the dataset to write to. - <dt><em>hid_t</em> <code>mem_type_id</code> - <dd>IN: Identifier of the memory datatype. - <dt><em>hid_t</em> <code>mem_space_id</code> - <dd>IN: Identifier of the memory dataspace. - <dt><em>hid_t</em> <code>file_space_id</code> - <dd>IN: Identifier of the dataset's dataspace in the file. - <dt><em>hid_t</em> <code>xfer_plist_id</code> - <dd>IN: Identifier of a transfer property list - for this I/O operation. - <dt><em>const void *</em> <code>buf</code> - <dd>IN: Buffer with data to be written to the file. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dataset_id</code></td> + <td valign="top">IN: Identifier of the dataset to write to.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>mem_type_id</code></td> + <td valign="top">IN: Identifier of the memory datatype.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>mem_space_id</code></td> + <td valign="top">IN: Identifier of the memory dataspace.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>file_space_id </code></td> + <td valign="top">IN: Identifier of the dataset's dataspace in the file.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>xfer_plist_id</code></td> + <td valign="top">IN: Identifier of a transfer property list + for this I/O operation.</td></tr> + <tr> + <td valign="top"><em>const void *</em> <code>buf</code></td> + <td valign="top">IN: Buffer with data to be written to the file.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1447,7 +1495,9 @@ SUBROUTINE h5dwrite_f(dset_id, mem_type_id, buf, dims, hdferr, & INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier INTEGER(HID_T), INTENT(IN) :: mem_type_id ! Memory datatype identifier TYPE, INTENT(IN) :: buf ! Data buffer; may be a scalar - ! or an array + ! or an array</pre> +<!-- NEW PAGE --> +<pre> DIMENSION(*), INTEGER(HSIZE_T), INTENT(IN) :: dims ! Array to hold corresponding ! dimension sizes of data @@ -1455,10 +1505,8 @@ SUBROUTINE h5dwrite_f(dset_id, mem_type_id, buf, dims, hdferr, & ! of the k-th dimension of ! buffer buf; values are ! ignored if buf is a scalar - INTEGER, INTENT(OUT) :: hdferr ! Error code - ! 0 on success and -1 on failure</pre> -<!-- NEW PAGE --> -<pre> + INTEGER, INTENT(OUT) :: hdferr ! Error code + ! 0 on success and -1 on failure INTEGER(HID_T), OPTIONAL, INTENT(IN) :: mem_space_id ! Memory dataspace identfier ! Default value is H5S_ALL_F diff --git a/doc/html/RM_H5E.html b/doc/html/RM_H5E.html index 284bb38..c1d5cfd 100644 --- a/doc/html/RM_H5E.html +++ b/doc/html/RM_H5E.html @@ -206,9 +206,9 @@ errors within the H5E package. <code>H5Eclear</code> can fail if there are problems initializing the library. <dt><strong>Parameters:</strong> - <dl> - <dt>None - </dl> + <ul><table> + <tr><td valign="top">None</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -248,13 +248,15 @@ END SUBROUTINE h5eclear_f 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> - <dl> - <dt><em>H5E_auto_t *</em> <code>func</code> - <dd>OUT: Current setting for the function to be called upon an - error condition. - <dt><em>void **</em><code>client_data</code> - <dd>OUT: Current setting for the data passed to the error function. - </dl> + <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 **</em><code>client_data </code></td> + <td valign="top">OUT: Current setting for the data passed to the error function.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -289,10 +291,11 @@ SUBROUTINE <dd>Given a major error number, <code>H5Eget_major</code> returns a constant character string that describes the error. <dt><strong>Parameters:</strong> - <dl> - <dt><em>H5E_major_t</em> <code>n</code> - <dd>IN: Major error number. - </dl> + <ul><table> + <tr> + <td valign="top"><em>H5E_major_t</em> <code>n </code></td> + <td valign="top">IN: Major error number.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd> Returns a character string describing the error if successful. Otherwise returns "Invalid major error number." @@ -329,10 +332,11 @@ END SUBROUTINE h5eget_major_f <dd>Given a minor error number, <code>H5Eget_minor</code> returns a constant character string that describes the error. <dt><strong>Parameters:</strong> - <dl> - <dt><em>H5E_minor_t</em> <code>n</code> - <dd>IN: Minor error number. - </dl> + <ul><table> + <tr> + <td valign="top"><em>H5E_minor_t</em> <code>n </code></td> + <td valign="top">IN: Minor error number.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd> Returns a character string describing the error if successful. Otherwise returns "Invalid minor error number." @@ -375,10 +379,11 @@ END SUBROUTINE h5eget_minor_f <code>H5Ewalk</code> with a function that prints error messages. Users are encouraged to write their own more specific error handlers. <dt><strong>Parameters:</strong> - <dl> - <dt><em>FILE *</em> <code>stream</code> - <dd>IN: File pointer, or stderr if NULL. - </dl> + <ul><table> + <tr> + <td valign="top"><em>FILE *</em> <code>stream </code></td> + <td valign="top">IN: File pointer, or stderr if NULL.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -430,20 +435,26 @@ END SUBROUTINE h5eprint_f The function name, file name, and error description strings must be statically allocated. <dt><strong>Parameters:</strong> - <dl> - <dt><em>const char *</em><code>file</code>, - <dd>IN: Name of the file in which the error was detected. - <dt><em>const char *</em><code>func</code>, - <dd>IN: Name of the function in which the error was detected. - <dt><em>unsigned</em> <code>line</code>, - <dd>IN: Line within the file at which the error was detected. - <dt><em>H5E_major_t</em> <code>maj_num</code>, - <dd>IN: Major error number. - <dt><em>H5E_minor_t</em> <code>min_num</code>, - <dd>IN: Minor error number. - <dt><em>const char *</em><code>str</code> - <dd>IN: Error description string. - </dl> + <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> <code>maj_num, </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> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -490,12 +501,14 @@ SUBROUTINE Automatic stack traversal is always in the <code>H5E_WALK_DOWNWARD</code> direction. <dt><strong>Parameters:</strong> - <dl> - <dt><em>H5E_auto_t</em> <code>func</code> - <dd>IN: Function to be called upon an error condition. - <dt><em>void *</em><code>client_data</code> - <dd>IN: Data passed to the error function. - </dl> + <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 *</em><code>client_data </code></td> + <td valign="top">IN: Data passed to the error function.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -579,14 +592,17 @@ END SUBROUTINE h5eset_auto_f <code>H5Ewalk</code> can fail if there are problems initializing the library. <dt><strong>Parameters:</strong> - <dl> - <dt><em>H5E_direction_t</em> <code>direction</code> - <dd>IN: Direction in which the error stack is to be walked. - <dt><em>H5E_walk_t</em> <code>func</code> - <dd>IN: Function to be called for each error encountered. - <dt><em>void *</em> <code>client_data</code> - <dd>IN: Data to be passed with <code>func</code>. - </dl> + <ul><table> + <tr> + <td valign="top"><em>H5E_direction_t</em> <code>direction </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> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -642,15 +658,18 @@ SUBROUTINE <code>client_data</code> argument of <code>H5Ewalk</code>. It is expected to be a file pointer (or stderr if NULL). <dt><strong>Parameters:</strong> - <dl> - <dt><em>int</em> <code>n</code> - <dd>IN/OUT: Number of times this function has been called - for this traversal of the stack. - <dt><em>H5E_error_t *</em><code>err_desc</code> - <dd>OUT: Error description. - <dt><em>void</em> <code>*client_data</code> - <dd>IN: A file pointer, or stderr if NULL. - </dl> + <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 *</em><code>err_desc </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> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. diff --git a/doc/html/RM_H5F.html b/doc/html/RM_H5F.html index 8e974b8..b77873d 100644 --- a/doc/html/RM_H5F.html +++ b/doc/html/RM_H5F.html @@ -41,7 +41,8 @@ HDF5/H5F API Specification </td> <td valign=top align=right> And in this document, the -<a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> @@ -49,7 +50,8 @@ And in this document, the <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> -<a href="RM_H5P.html">H5P</a> <br> +<a href="RM_H5P.html">H5P</a> +<br> <a href="RM_H5R.html">H5R</a> <a href="RM_H5S.html">H5S</a> <a href="RM_H5T.html">H5T</a> @@ -57,14 +59,9 @@ And in this document, the <a href="Tools.html">Tools</a> <a href="PredefDTypes.html">Datatypes</a> </td></tr> -<tr><td colspan="2" align="right"> -<i><small>(<a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/PSandPDF/">PDF</a> -of complete manual formatted as print volume) </small></i> -</td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><center> +<hr><!-- #EndLibraryItem --><center> <h1>H5F: File Interface</h1> </center> @@ -171,6 +168,7 @@ as the corresponding C function. <li><a href="#File-Unmount">h5funmount_f</a> <li><a href="#File-GetVfdHandle">h5fget_vfd_handle_f</a> <li><a href="#File-GetFilesize">h5fget_filesize_f</a> + <li><a href="#File-GetFreespace">h5fget_freespace_f</a> </ul> </td><td> </td><td valign=top> <ul> @@ -179,7 +177,6 @@ as the corresponding C function. <li><a href="#File-GetName">h5fget_name_f</a> <li><a href="#File-GetObjCount">h5fget_obj_count_f</a> <li><a href="#File-GetObjIDs">h5fget_obj_ids_f</a> - <li><a href="#File-GetObjIDs">h5fget_freespace_f</a> </ul> </td></tr> </table> @@ -235,10 +232,11 @@ as the corresponding C function. in a file before calling <code>H5Fclose</code>. It is generally recommended to do so in all cases. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>file_id</code> - <dd>IN: Identifier of a file to terminate access to. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>file_id </code></td> + <td valign="top">IN: Identifier of a file to terminate access to.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -328,11 +326,13 @@ END SUBROUTINE h5fclose_f with an already opened file. <dt><strong>Parameters:</strong> - <dl> - <dt><em>const char *</em><code>name</code> - <dd>IN: Name of the file to access. - <dt><em>uintn</em> <code>flags</code> - <dd>IN: File access flags. Allowable values are: + <ul><table> + <tr> + <td valign="top"><em>const char *</em><code>name </code></td> + <td valign="top">IN: Name of the file to access.</td></tr> + <tr> + <td valign="top"><em>uintn</em> <code>flags</code></td> + <td valign="top">IN: File access flags. Allowable values are: <ul><dl> <dt><code>H5F_ACC_TRUNC</code> <dd>Truncate file, if it already exists, @@ -345,18 +345,20 @@ END SUBROUTINE h5fclose_f <li>An additional flag, <code>H5F_ACC_DEBUG</code>, prints debug information. This flag is used only by HDF5 library developers; <i>it is neither tested nor supported</i> - for use in applications. - <dt><em>hid_t</em> <code>create_id</code> - <dd>IN: File creation property list identifier, used when modifying + for use in applications.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>create_id </code></td> + <td valign="top">IN: File creation property list identifier, used when modifying default file meta-data. - Use <code>H5P_DEFAULT</code> for default file creation properties. - <dt><em>hid_t</em> <code>access_id</code> - <dd>IN: File access property list identifier. + Use <code>H5P_DEFAULT</code> for default file creation properties.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>access_id</code></td> + <td valign="top">IN: File access property list identifier. If parallel file access is desired, this is a collective call according to the communicator stored in the <code>access_id</code>. - Use <code>H5P_DEFAULT</code> for default file access properties. - </dl> + Use <code>H5P_DEFAULT</code> for default file access properties.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a file identifier if successful; otherwise returns a negative value. @@ -422,12 +424,12 @@ END SUBROUTINE h5fcreate_f action is global or local. Valid values are <center> <table border=0> - <tr><td align=left valign=bottom><code>H5F_SCOPE_GLOBAL</code></td> + <tr><td align=left valign=top><code>H5F_SCOPE_GLOBAL</code></td> <td> </td> - <td align=left valign=bottom>Flushes the entire virtual file.</td></tr> - <tr><td align=left valign=bottom><code>H5F_SCOPE_LOCAL</code></td> + <td align=left valign=top>Flushes the entire virtual file.</td></tr> + <tr><td align=left valign=top><code>H5F_SCOPE_LOCAL</code></td> <td></td> - <td align=left valign=bottom>Flushes only the specified file.</td></tr> + <td align=left valign=top>Flushes only the specified file.</td></tr> </table> </center> <dt><strong>Note:</strong> @@ -437,12 +439,14 @@ END SUBROUTINE h5fcreate_f open files. After that, the OS is responsible for ensuring that the data is actually flushed to disk. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t </em><code>object_id</code> - <dd>IN: Identifier of object used to identify the file. - <dt><em>H5F_scope_t</em> <code>scope</code> - <dd>IN: Specifies the scope of the flushing action. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t </em><code>object_id</code></td> + <td valign="top">IN: Identifier of object used to identify the file.</td></tr> + <tr> + <td valign="top"><em>H5F_scope_t</em> <code>scope </code></td> + <td valign="top">IN: Specifies the scope of the flushing action.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -489,10 +493,11 @@ END SUBROUTINE h5fflush_f <cite>HDF5 User's Guide</cite> for additional information and related functions. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>file_id</code> - <dd>IN: Identifier of file to get access property list of - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>file_id </code></td> + <td valign="top">IN: Identifier of file to get access property list of</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a file access property list identifier if successful; otherwise returns a negative value. @@ -517,7 +522,6 @@ END SUBROUTINE h5fget_access_plist_f --> </dl> - <!-- NEW PAGE --> <!-- HEADER RIGHT "H5Fget_create_plist" --> <hr> @@ -542,10 +546,11 @@ END SUBROUTINE h5fget_access_plist_f <cite>HDF5 User's Guide</cite> for additional information and related functions. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>file_id</code> - <dd>IN: Identifier of the file to get creation property list of - </dl> + <ul><table> + <dt> + <td valign="top"><em>hid_t</em> <code>file_id </code></td> + <td valign="top">IN: Identifier of the file to get creation property list of</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a file creation property list identifier if successful; otherwise returns a negative value. @@ -629,7 +634,7 @@ END SUBROUTINE h5fget_filesize_f <!-- HEADER RIGHT "H5Fget_freespace" --> <hr> <dl> -<dt><strong>Name:</strong> <a name="File-GetFreespace">H5Fget_freespace</a> +<dt><strong>Name:</strong> <a name="File-GetFreeSpace">H5Fget_freespace</a> <dt><strong>Signature:</strong> <dd><em>hssize_t </em><code>H5Fget_freespace</code>(<em>hid_t</em> <code>file_id</code>) <dt><strong>Purpose:</strong> @@ -644,10 +649,11 @@ END SUBROUTINE h5fget_filesize_f only report the free space that has been created during that interval. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>file_id</code> - <dd>IN: Identifier of a currently-open HDF5 file - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>file_id </code></td> + <td valign="top">IN: Identifier of a currently-open HDF5 file</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a the amount of free space in the file if successful; otherwise returns a negative value. @@ -811,13 +817,15 @@ END SUBROUTINE h5fget_name_f For example, the expression <code>(H5F_OBJ_DATASET|H5F_OBJ_GROUP)</code> would call for datasets and groups. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>file_id</code> - <dd>IN: Identifier of a currently-open HDF5 file or - <code>H5F_OBJ_ALL</code> for all currently-open HDF5 files. - <dt><em>unsigned int</em> <code>types</code> - <dd>IN: Type of object for which identifiers are to be returned. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>file_id</code></td> + <td valign="top">IN: Identifier of a currently-open HDF5 file or + <code>H5F_OBJ_ALL</code> for all currently-open HDF5 files.</td></tr> + <tr> + <td valign="top"><em>unsigned int</em> <code>types </code></td> + <td valign="top">IN: Type of object for which identifiers are to be returned.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a the number of open objects if successful; otherwise returns a negative value. @@ -878,17 +886,22 @@ END SUBROUTINE h5fget_obj_count_f To retrieve identifiers for all open objects, pass a negative value for the <code>max_objs</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>file_id</code> - <dd>IN: Identifier of a currently-open HDF5 file or - <code>H5F_OBJ_ALL</code> for all currently-open HDF5 files. - <dt><em>unsigned int</em> <code>types</code> - <dd>IN: Type of object for which identifiers are to be returned. - <dt><em>int</em> <code>max_objs</code> - <dd>IN: Maximum number of object identifiers to place into <code>obj_id_list</code>. - <dt><em>hid_t *</em><code>obj_id_list</code> - <dd>OUT: Pointer to the returned list of open object identifiers. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>file_id</code></td> + <td valign="top">IN: Identifier of a currently-open HDF5 file or + <code>H5F_OBJ_ALL</code> for all currently-open HDF5 files.</td></tr> + <tr> + <td valign="top"><em>unsigned int</em> <code>types</code></td> + <td valign="top">IN: Type of object for which identifiers are to be returned.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>max_objs</code></td> + <td valign="top">IN: Maximum number of object identifiers to place into + <code>obj_id_list</code>.</td></tr> + <tr> + <td valign="top"><em>hid_t *</em><code>obj_id_list </code></td> + <td valign="top">OUT: Pointer to the returned list of open object identifiers.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns number of objects placed into <code>obj_id_list</code> if successful; otherwise returns a negative value. @@ -948,22 +961,25 @@ END SUBROUTINE h5fget_obj_ids_f open; it will be invalid if the file is closed and reopened or opened during a subsequent session. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>file_id</code> - <dd>IN: Identifier of the file to be queried. - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>file_id</code></td> + <td valign="top">IN: Identifier of the file to be queried.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier. For most drivers, the value will be <code>H5P_DEFAULT</code>. - For the <code>FAMILY</code> or <code>MULTI</code> drivers, - this value should be defined through the property list - functions: - <code>H5Pset_family_offset</code> for the <code>FAMILY</code> - driver and <code>H5Pset_multi_type</code> for the - <code>MULTI</code> driver. - <dt><em>void *</em><code>file_handle</code> - <dd>OUT: Pointer to the file handle being used by - the low-level virtual file driver. - </dl> + For the <code>FAMILY</code> or <code>MULTI</code> drivers, + this value should be defined through the property list + functions: + <code>H5Pset_family_offset</code> for the <code>FAMILY</code> + driver and <code>H5Pset_multi_type</code> for the + <code>MULTI</code> driver.</td></tr> + <tr> + <td valign="top"><em>void *</em><code>file_handle </code></td> + <td valign="top">OUT: Pointer to the file handle being used by + the low-level virtual file driver.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -998,10 +1014,11 @@ SUBROUTINE <dd><code>H5Fis_hdf5</code> determines whether a file is in the HDF5 format. <dt><strong>Parameters:</strong> - <dl> - <dt><em>const char *</em><code>name</code> - <dd>IN: File name to check format. - </dl> + <ul><table> + <tr> + <td valign="top"><em>const char *</em><code>name </code></td> + <td valign="top">IN: File name to check format.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>When successful, returns a positive value, for <code>TRUE</code>, or <code>0</code> (zero), for <code>FALSE</code>. @@ -1050,19 +1067,23 @@ END SUBROUTINE h5fis_hdf5_f Note that <code>loc_id</code> is either a file or group identifier and <code>name</code> is relative to <code>loc_id</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Identifier for of file or group in - which <code>name</code> is defined. - <dt><em>const char *</em><code>name</code> - <dd>IN: Name of the group onto which the + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: Identifier for of file or group in + which <code>name</code> is defined.</td> + <tr> + <td valign="top"><em>const char *</em><code>name </code></td> + <td valign="top">IN: Name of the group onto which the file specified by <code>child_id</code> - is to be mounted. - <dt><em>hid_t</em> <code>child_id</code> - <dd>IN: Identifier of the file to be mounted. - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Identifier of the property list to be used. - </dl> + is to be mounted.</td> + <tr> + <td valign="top"><em>hid_t</em> <code>child_id</code></td> + <td valign="top">IN: Identifier of the file to be mounted.</td> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Identifier of the property list to be used.</td> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1150,11 +1171,13 @@ END SUBROUTINE h5fmount_f multiple opens of the same file. <dt><strong>Parameters:</strong> - <dl> - <dt><em>const char *</em><code>name</code> - <dd>IN: Name of the file to access. - <dt><em>unsigned</em> <code>flags</code> - <dd>IN: File access flags. Allowable values are: + <ul><table> + <tr> + <td valign="top"><em>const char *</em><code>name </code></td> + <td valign="top">IN: Name of the file to access.</td></tr> + <tr> + <td valign="top"><em>unsigned</em> <code>flags</code></td> + <td valign="top">IN: File access flags. Allowable values are: <ul><dl> <dt><code>H5F_ACC_RDWR</code> <dd>Allow read and write access to file. @@ -1167,15 +1190,16 @@ END SUBROUTINE h5fmount_f debug information. This flag is used only by HDF5 library developers; it is neither tested nor supported for use in applications. - </ul> + </ul></td></tr> <!-- NEW PAGE --> - <dt><em>hid_t</em> <code>access_id</code> - <dd>IN: Identifier for the file access properties list. + <tr> + <td valign="top"><em>hid_t</em> <code>access_id </code></td> + <td valign="top">IN: Identifier for the file access properties list. If parallel file access is desired, this is a collective call according to the communicator stored in the <code>access_id</code>. - Use <code>H5P_DEFAULT</code> for default file access properties. - </dl> + Use <code>H5P_DEFAULT</code> for default file access properties.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a file identifier if successful; otherwise returns a negative value. @@ -1235,11 +1259,12 @@ END SUBROUTINE h5fopen_f The new file identifier should be closed by calling <code>H5Fclose</code> when it is no longer needed. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>file_id</code> - <dd>IN: Identifier of a file for which an additional identifier - is required. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>file_id </code></td> + <td valign="top">IN: Identifier of a file for which an additional identifier + is required.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a new file identifier if successful; otherwise returns a negative value. @@ -1290,13 +1315,15 @@ END SUBROUTINE h5freopen_f Note that <code>loc_id</code> is either a file or group identifier and <code>name</code> is relative to <code>loc_id</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: File or group identifier for the location at which - the specified file is to be unmounted. - <dt><em>const char *</em><code>name</code> - <dd>IN: Name of the mount point. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: File or group identifier for the location at which + the specified file is to be unmounted.</td></tr> + <tr> + <td valign="top"><em>const char *</em><code>name </code></td> + <td valign="top">IN: Name of the mount point.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1336,7 +1363,8 @@ END SUBROUTINE h5funmount_f </td> <td valign=top align=right> And in this document, the -<a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> @@ -1344,7 +1372,8 @@ And in this document, the <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> -<a href="RM_H5P.html">H5P</a> <br> +<a href="RM_H5P.html">H5P</a> +<br> <a href="RM_H5R.html">H5R</a> <a href="RM_H5S.html">H5S</a> <a href="RM_H5T.html">H5T</a> @@ -1352,17 +1381,12 @@ And in this document, the <a href="Tools.html">Tools</a> <a href="PredefDTypes.html">Datatypes</a> </td></tr> -<tr><td colspan="2" align="right"> -<i><small>(<a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/PSandPDF/">PDF</a> -of complete manual formatted as print volume) </small></i> -</td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> +<hr><!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Describes HDF5 Release 1.6.3, September 2004 +Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0 </address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT"> <!-- document.writeln("Last modified: 24 August 2004"); diff --git a/doc/html/RM_H5G.html b/doc/html/RM_H5G.html index b7c4386..9400068 100644 --- a/doc/html/RM_H5G.html +++ b/doc/html/RM_H5G.html @@ -224,10 +224,11 @@ create or access function. <p> Failure to release a group with this call will result in resource leaks. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>group_id</code> - <dd>IN: Group identifier to release. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>group_id </code></td> + <td valign="top">IN: Group identifier to release.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -282,20 +283,23 @@ END SUBROUTINE h5gclose_f This group identifier should be closed by calling <code>H5Gclose</code> when it is no longer needed. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: File or group identifier. - <dt><em>const char *</em><code>name</code> - <dd>IN: Absolute or relative name of the new group. - <dt><em>size_t</em> <code>size_hint</code> - <dd>IN: Optional parameter indicating the number of bytes - to reserve for the names that will appear in the group. - A conservative estimate could result in multiple - system-level I/O requests to read the group name heap; - a liberal estimate could result in a single large - I/O request even when the group has just a few names. - HDF5 stores each name with a null terminator. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: File or group identifier.</td></tr> + <tr> + <td valign="top"><em>const char *</em><code>name</code></td> + <td valign="top">IN: Absolute or relative name of the new group.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>size_hint </code></td> + <td valign="top">IN: Optional parameter indicating the number of bytes + to reserve for the names that will appear in the group. + A conservative estimate could result in multiple + system-level I/O requests to read the group name heap; + a liberal estimate could result in a single large + I/O request even when the group has just a few names. + HDF5 stores each name with a null terminator.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a valid group identifier for the open group if successful; otherwise returns a negative value. @@ -352,12 +356,15 @@ END SUBROUTINE h5gcreate_f If an object does not have a comment, the empty string is returned. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Identifier of a file, group, dataset, or named datatype. - <dt><em>const char *</em><code>name</code> - <dd>IN: Name of the object in <code>loc_id</code> whose comment - is to be retreived. + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: Identifier of the file, group, dataset, or + named datatype.</td></tr> + <tr> + <td valign="top"><em>const char *</em><code>name </code></td> + <td valign="top">IN: Name of the object in <code>loc_id</code> whose + comment is to be retrieved. <br> <code>name</code> can be '.' (dot) if <code>loc_id</code> fully specifies the object for which the associated comment @@ -365,12 +372,15 @@ END SUBROUTINE h5gcreate_f <br> <code>name</code> is ignored if <code>loc_id</code> is a dataset or named datatype. - <dt><em>size_t</em> <code>bufsize</code> - <dd>IN: Anticipated required size of the - <code>comment</code> buffer. - <dt><em>char *</em><code>comment</code> - <dd>OUT: The comment. - </dl> + </td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>bufsize</code></td> + <td valign="top">IN: Anticipated required size of the + <code>comment</code> buffer.</td></tr> + <tr> + <td valign="top"><em>char *</em><code>comment</code></td> + <td valign="top">OUT: The comment.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the number of characters in the comment, counting the null terminator, if successful; the value @@ -378,19 +388,19 @@ END SUBROUTINE h5gcreate_f Otherwise returns a negative value. <dt><strong>Fortran90 Interface:</strong> h5gget_comment_f <dd> - <pre> + <pre> SUBROUTINE h5gget_comment_f(loc_id, name, size, buffer, hdferr) IMPLICIT NONE - INTEGER(HID_T), INTENT(IN) :: loc_id ! File, group, dataset, or + INTEGER(HID_T), INTENT(IN) :: loc_id ! File, group, dataset, or ! named datatype identifier CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the object link CHARACTER(LEN=size), INTENT(OUT) :: buffer ! Buffer to hold the comment INTEGER, INTENT(OUT) :: hdferr ! Error code ! 0 on success and -1 on failure END SUBROUTINE h5gget_comment_f - </pre> - - <!--<dt><strong>Non-C API(s):</strong> + </pre> + + <!--<dt><strong>Non-C API(s):</strong> <dd> <img src="Graphics/Java.gif"> @@ -430,17 +440,21 @@ END SUBROUTINE h5gget_comment_f This function should be used only after <code>H5Gget_objinfo</code> has been called to verify that <code>name</code> is a symbolic link. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Identifier of the file or group. - <dt><em>const char *</em><code>name</code> - <dd>IN: Symbolic link to the object whose name is to be returned. - <dt><em>size_t</em> <code>size</code> - <dd>IN: Maximum number of characters of <code>value</code> - to be returned. - <dt><em>char *</em><code>value</code> - <dd>OUT: A buffer to hold the name of the object being sought. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: Identifier of the file or group.</td></tr> + <tr> + <td valign="top"><em>const char *</em><code>name </code></td> + <td valign="top">IN: Symbolic link to the object whose name is to be returned.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>size</code></td> + <td valign="top">IN: Maximum number of characters of <code>value</code> + to be returned.</td></tr> + <tr> + <td valign="top"><em>char *</em><code>value</code></td> + <td valign="top">OUT: A buffer to hold the name of the object being sought.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value, with the link value in <code>value</code>, if successful. @@ -484,12 +498,14 @@ END SUBROUTINE h5gget_linkval_f If a file identifier is passed in, then the number of objects in the root group is returned. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Identifier of the group or the file - <dt><em>hsize_t*</em> <code>num_obj</code> - <dd>OUT: Number of objects in the group. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: Identifier of the group or the file</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em><code>num_obj </code></td> + <td valign="top">OUT: Number of objects in the group.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns positive value if successful; otherwise returns a negative value. @@ -616,16 +632,20 @@ SUBROUTINE unable to retrieve the correct time; such systems (e.g., Irix64) will report an <code>mtime</code> value of 0 (zero). <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: File or group identifier. - <dt><em>const char</em> <code>*name</code> - <dd>IN: Name of the object for which status is being sought. - <dt><em>hbool_t</em> <code>follow_link</code> - <dd>IN: Link flag. - <dt><em>H5G_stat_t</em> <code>*statbuf</code> - <dd>OUT: Buffer in which to return information about the object. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: File or group identifier.</td></tr> + <tr> + <td valign="top"><em>const char</em> <code>*name</code></td> + <td valign="top">IN: Name of the object for which status is being sought.</td></tr> + <tr> + <td valign="top"><em>hbool_t</em> <code>follow_link</code></td> + <td valign="top">IN: Link flag.</td></tr> + <tr> + <td valign="top"><em>H5G_stat_t</em> <code>*statbuf </code></td> + <td valign="top">OUT: Buffer in which to return information about the object.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd> Returns a non-negative value if successful, with the fields of <code>statbuf</code> (if non-null) initialized. @@ -687,16 +707,20 @@ SUBROUTINE A second call to <code>H5Gget_objname_by_idx</code> can then be used to retrieve the actual name. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Group or file identifier. - <dt><em>hsize_t</em> <code>idx</code> - <dd>IN: Transient index identifying object. - <dt><em>char *</em><code>name</code> - <dd>IN/OUT: Pointer to user-provided buffer the object name. - <dt><em>size_t</em> <code>size</code> - <dd>IN: Name length. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id </code></td> + <td valign="top">IN: Group or file identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>idx</code></td> + <td valign="top">IN: Transient index identifying object.</td></tr> + <tr> + <td valign="top"><em>char *</em><code>name</code></td> + <td valign="top">IN/OUT: Pointer to user-provided buffer the object name.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>size</code></td> + <td valign="top">IN: Name length.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the size of the object name if successful, or <code>0</code> if no name is associated with the group identifier. @@ -790,12 +814,14 @@ SUBROUTINE </table> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Group or file identifier. - <dt><em>hsize_t</em> <code>idx</code> - <dd>IN: Transient index identifying object. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id </code></td> + <td valign="top">IN: Group or file identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>idx</code></td> + <td valign="top">IN: Transient index identifying object.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the type of the object if successful. Otherwise returns a negative value. @@ -846,12 +872,15 @@ SUBROUTINE non-zero. <p> The prototype for <code>H5G_iterate_t</code> is: - <ul><dl> - <dd><code>typedef</code> <em>herr_t </em>(*<code>H5G_iterate_t</code>)(<em>hid_t</em> <code>group_id</code>, - <em>const char *</em><code>member_name</code>, - <em>void *</em><code>operator_data</code>); - </dl></ul> - <dd>The operation receives the group identifier for the group being + <table> + <tr> + <td valign="top"> </td> + <td valign="top"><code>typedef</code> <em>herr_t </em>(*<code>H5G_iterate_t</code>) + (<em>hid_t</em> <code>group_id</code>, <em>const char *</em> + <code>member_name</code>, <em>void *</em><code>operator_data</code>);</td></tr> + </table> + + <p>The operation receives the group identifier for the group being iterated over, <code>group_id</code>, the name of the current object within the group, <code>member_name</code>, and the pointer to the operator data passed in to <code>H5Giterate</code>, @@ -874,23 +903,29 @@ SUBROUTINE iteration. If the membership changes during the iteration, the function's behavior is undefined. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: File or group identifier. - <dt><em>const char</em> <code>*name</code> - <dd>IN: Group over which the iteration is performed. - <dt><em>int</em> <code>*idx</code> - <dd>IN/OUT: Location at which to begin the iteration. - <dt><em>H5G_iterate_t</em> <code>operator</code> - <dd>IN: Operation to be performed on an object at each step of - the iteration. - <dt><em>void</em> <code>*operator_data</code> - <dd>IN/OUT: Data associated with the operation. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: File or group identifier.</td></tr> + <tr> + <td valign="top"><em>const char</em> <code>*name</code></td> + <td valign="top">IN: Group over which the iteration is performed.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>*idx</code></td> + <td valign="top">IN/OUT: Location at which to begin the iteration.</td></tr> + <tr> + <td valign="top"><em>H5G_iterate_t</em> <code>operator </code></td> + <td valign="top">IN: Operation to be performed on an object at each step of + the iteration.</td></tr> + <tr> + <td valign="top"><em>void</em> <code>*operator_data</code></td> + <td valign="top">IN/OUT: Data associated with the operation.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the return value of the last operator if it was non-zero, or zero if all group members were processed. Otherwise returns a negative value. +<!-- NEW PAGE --> <dt><strong>Fortran90 Interface:</strong> <dd>There is no direct FORTRAN couterpart for the C function <code>H5Giterate</code>. @@ -908,8 +943,8 @@ SUBROUTINE Returns the number of group members. </tr> <tr valign=top align=left> - <td> - <code>h5gget_obj_info_idx_f</code> + <td> + <code>h5gget_obj_info_idx_f</code> </td><td> </td><td> <strong>Purpose:</strong> Returns name and type of the group member identified by its index. @@ -921,12 +956,11 @@ SUBROUTINE <pre> SUBROUTINE h5gn_members_f(loc_id, name, nmembers, hdferr) IMPLICIT NONE - INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier - CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the group - INTEGER, INTENT(OUT) :: nmembers ! Number of members in the - ! group - INTEGER, INTENT(OUT) :: hdferr ! Error code - ! 0 on success and -1 on failure + INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier + CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the group + INTEGER, INTENT(OUT) :: nmembers ! Number of members in the group + INTEGER, INTENT(OUT) :: hdferr ! Error code + ! 0 on success and -1 on failure END SUBROUTINE h5gn_members_f </pre> @@ -934,17 +968,17 @@ END SUBROUTINE h5gn_members_f SUBROUTINE h5gget_obj_info_idx_f(loc_id, name, idx, & obj_name, obj_type, hdferr) IMPLICIT NONE - INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier - CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the group - INTEGER, INTENT(IN) :: idx ! Index of member object + INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier + CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the group + INTEGER, INTENT(IN) :: idx ! Index of member object CHARACTER(LEN=*), INTENT(OUT) :: obj_name ! Name of the object - INTEGER, INTENT(OUT) :: obj_type ! Object type : - ! H5G_LINK_F - ! H5G_GROUP_F - ! H5G_DATASET_F - ! H5G_TYPE_F - INTEGER, INTENT(OUT) :: hdferr ! Error code - ! 0 on success and -1 on failure + INTEGER, INTENT(OUT) :: obj_type ! Object type : + ! H5G_LINK_F + ! H5G_GROUP_F + ! H5G_DATASET_F + ! H5G_TYPE_F + INTEGER, INTENT(OUT) :: hdferr ! Error code + ! 0 on success and -1 on failure END SUBROUTINE h5gget_obj_info_idx_f </pre> </dl> @@ -982,19 +1016,23 @@ END SUBROUTINE h5gget_obj_info_idx_f is made for <code>./x/y/bar</code>, then the actual object looked up is <code>./x/y/./foo</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: File or group identifier. - <dt><em>H5G_link_t</em> <code>link_type</code> - <dd>IN: Link type. + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: File or group identifier.</td></tr> + <tr> + <td valign="top"><em>H5G_link_t</em> <code>link_type</code></td> + <td valign="top">IN: Link type. Possible values are <code>H5G_LINK_HARD</code> and - <code>H5G_LINK_SOFT</code>. - <dt><em>const char *</em> <code>current_name</code> - <dd>IN: Name of the existing object if link is a hard link. - Can be anything for the soft link. - <dt><em>const char *</em> <code>new_name</code> - <dd>IN: New name for the object. - </dl> + <code>H5G_LINK_SOFT</code>.</td></tr> + <tr> + <td valign="top"><em>const char *</em> <code>current_name </code></td> + <td valign="top">IN: Name of the existing object if link is a hard link. + Can be anything for the soft link.</td></tr> + <tr> + <td valign="top"><em>const char *</em> <code>new_name</code></td> + <td valign="top">IN: New name for the object.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1058,21 +1096,25 @@ END SUBROUTINE h5glink_f is made for <code>./x/y/bar</code>, then the actual object looked up is <code>./x/y/./foo</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>curr_loc_id</code> - <dd>IN: The file or group identifier for the original object. - <dt><em>const char *</em> <code>current_name</code> - <dd>IN: Name of the existing object if link is a hard link. - Can be anything for the soft link. - <dt><em>H5G_link_t</em> <code>link_type</code> - <dd>IN: Link type. + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>curr_loc_id</code></td> + <td valign="top">IN: The file or group identifier for the original object.</td></tr> + <tr> + <td valign="top"><em>const char *</em> <code>current_name </code></td> + <td valign="top">IN: Name of the existing object if link is a hard link. + Can be anything for the soft link.</td></tr> + <tr> + <td valign="top"><em>H5G_link_t</em> <code>link_type</code></td> + <td valign="top">IN: Link type. Possible values are <code>H5G_LINK_HARD</code> and - <code>H5G_LINK_SOFT</code>. - <dt><em>hid_t</em> <code>new_loc_id</code> - <dd>IN: The file or group identifier for the new link. - <dt><em>const char *</em> <code>new_name</code> - <dd>IN: New name for the object. - </dl> + <code>H5G_LINK_SOFT</code>.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>new_loc_id</code></td> + <td valign="top">IN: The file or group identifier for the new link.</td></tr> + <td valign="top"><em>const char *</em> <code>new_name</code></td> + <td valign="top">IN: New name for the object.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1128,14 +1170,17 @@ END SUBROUTINE h5glink2_f See <a href="Groups.html#H5GUnlinkToCorrupt">The Group Interface</a> in the <cite>HDF5 User's Guide</cite>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: File or group identifier. - <dt><em>const char</em> <code>*src_name</code> - <dd>IN: Object's original name. - <dt><em>const char</em> <code>*dst_name</code> - <dd>IN: Object's new name. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: File or group identifier.</td></tr> + <tr> + <td valign="top"><em>const char</em> <code>*src_name </code></td> + <td valign="top">IN: Object's original name.</td></tr> + <tr> + <td valign="top"><em>const char</em> <code>*dst_name</code></td> + <td valign="top">IN: Object's new name.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1184,16 +1229,20 @@ END SUBROUTINE h5gmove_f inaccessible with <code>H5Gmove</code>. See <a href="Groups.html#H5GUnlinkToCorrupt">The Group Interface</a> in the <cite>HDF5 User's Guide</cite>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>src_loc_id</code> - <dd>IN: Original file or group identifier. - <dt><em>const char</em> <code>*src_name</code> - <dd>IN: Object's original name. - <dt><em>hid_t</em> <code>dst_loc_id</code> - <dd>IN: Destination file or group identifier. - <dt><em>const char</em> <code>*dst_name</code> - <dd>IN: Object's new name. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>src_loc_id</code></td> + <td valign="top">IN: Original file or group identifier.</td></tr> + <tr> + <td valign="top"><em>const char</em> <code>*src_name </code></td> + <td valign="top">IN: Object's original name.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>dst_loc_id</code></td> + <td valign="top">IN: Destination file or group identifier.</td></tr> + <tr> + <td valign="top"><em>const char</em> <code>*dst_name</code></td> + <td valign="top">IN: Object's new name.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1243,12 +1292,14 @@ END SUBROUTINE h5gmove2_f that was opened. This group identifier should be released by calling <code>H5Gclose</code> when it is no longer needed. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: File or group identifier within which group is to be open. - <dt><em>const char *</em> <code>name</code> - <dd>IN: Name of group to open. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: File or group identifier within which group is to be open.</td></tr> + <tr> + <td valign="top"><em>const char *</em> <code>name </code></td> + <td valign="top">IN: Name of group to open.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a valid group identifier if successful; otherwise returns a negative value. @@ -1286,7 +1337,7 @@ END SUBROUTINE h5gopen_f <dt><strong>Purpose:</strong> <dd>Sets comment for specified object. <dt><strong>Description:</strong> - <dd><code>H5Gset_comment</code> sets the comment for the + <dd><code>H5Gset_comment</code> sets the comment for the object specified by <code>loc_id</code> and <code>name</code> to <code>comment</code>. Any previously existing comment is overwritten. @@ -1301,20 +1352,26 @@ END SUBROUTINE h5gopen_f e.g., datasets, groups, named datatypes, and dataspaces, but not symbolic links. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Identifier of the file, group, dataset, or named datatype. - <dt><em>const char *</em><code>name</code> - <dd>IN: Name of the object whose comment is to be set or reset. + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: Identifier of the file, group, dataset, + or named datatype.</td></tr> + <tr> + <td valign="top"><em>const char *</em><code>name</code></td> + <td valign="top">IN: Name of the object whose comment is to be + set or reset. <br> <code>name</code> can be '.' (dot) if <code>loc_id</code> fully specifies the object for which the comment is to be set. <br> <code>name</code> is ignored if <code>loc_id</code> is a dataset or named datatype. - <dt><em>const char *</em><code>comment</code> - <dd>IN: The new comment. - </dl> + </td></tr> + <tr> + <td valign="top"><em>const char *</em><code>comment </code></td> + <td valign="top">IN: The new comment.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1379,12 +1436,14 @@ END SUBROUTINE h5gset_comment_f See <a href="Groups.html#H5GUnlinkToCorrupt">The Group Interface</a> in the <cite>HDF5 User's Guide</cite>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Identifier of the file or group containing the object. - <dt><em>const char *</em> <code>name</code> - <dd>IN: Name of the object to unlink. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: Identifier of the file or group containing the object.</td></tr> + <tr> + <td valign="top"><em>const char *</em> <code>name </code></td> + <td valign="top">IN: Name of the object to unlink.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. diff --git a/doc/html/RM_H5I.html b/doc/html/RM_H5I.html index 1dd7078..472133a 100644 --- a/doc/html/RM_H5I.html +++ b/doc/html/RM_H5I.html @@ -202,10 +202,11 @@ as the corresponding C function. decremented and the HDF5 object will be closed when the reference count for that that object drops to zero. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>obj_id</code> - <dd>IN: Object identifier whose reference count will be modified. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>obj_id </code></td> + <td valign="top">IN: Object identifier whose reference count will be modified.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative reference count of the object ID after decrementing it if successful; otherwise a negative value is returned. @@ -326,16 +327,18 @@ END SUBROUTINE h5iget_file_id_f varying according to the path through the HDF5 group hierarchy used to reach that object. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>obj_id</code> - <dd>IN: Identifier of the object. - This identifier can refer to a group, dataset, or - named datatype. - <dt><em>char *</em><code>name</code> - <dd>OUT: A name associated with the identifier. - <dt><em>size_t size</em> - <dd>IN: The size of the <code>name</code> buffer. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>obj_id </code></td> + <td valign="top">IN: Identifier of the object. + This identifier can refer to a group, dataset, or named datatype.</td></tr> + <tr> + <td valign="top"><em>char *</em><code>name</code></td> + <td valign="top">OUT: A name associated with the identifier.</td></tr> + <tr> + <td valign="top"><em>size_t size</em></td> + <td valign="top">IN: The size of the <code>name</code> buffer.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the length of the name if successful, returning <code>0</code> (zero) if no name is associated with the identifier. @@ -385,10 +388,11 @@ END SUBROUTINE h5iget_name_f A non-negative return value from this function indicates that the ID is still valid. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>obj_id</code> - <dd>IN: Object identifier whose reference count will be retrieved. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>obj_id </code></td> + <td valign="top">IN: Object identifier whose reference count will be retrieved.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative current reference count of the object ID if successful; otherwise a negative value is returned. @@ -452,10 +456,11 @@ END SUBROUTINE h5iget_ref_f <code>H5Gclose</code>, etc.) to call after a call to <code>H5Rdereference</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>obj_id</code> - <dd>IN: Object identifier whose type is to be determined. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>obj_id </code></td> + <td valign="top">IN: Object identifier whose type is to be determined.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the object type if successful; otherwise <code>H5I_BADID</code>. @@ -533,10 +538,11 @@ END SUBROUTINE h5iget_type_f decremented and the HDF5 object will be closed when the reference count for that that object drops to zero. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>obj_id</code> - <dd>IN: Object identifier whose reference count will be modified. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>obj_id </code></td> + <td valign="top">IN: Object identifier whose reference count will be modified.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative reference count of the object ID after incrementing it if successful; otherwise a negative value is returned. diff --git a/doc/html/RM_H5P.html b/doc/html/RM_H5P.html index 16e6b5f..3358cc7 100644 --- a/doc/html/RM_H5P.html +++ b/doc/html/RM_H5P.html @@ -825,10 +825,11 @@ as the corresponding C function. set in the dataset creation property list <code>dcpl_id</code> are currently available. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dcpl_id</code> - <dd>IN: Dataset creation property list identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dcpl_id </code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns <code>TRUE</code> if all filters are available and <code>FALSE</code> if one or more is not currently available.<br> @@ -865,10 +866,11 @@ SUBROUTINE finished accessing them. This frees resources used by the property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of the property list to terminate access to. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier of the property list to terminate access to.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -915,7 +917,7 @@ END SUBROUTINE h5pclose_f <dt><strong>Parameters:</strong> <ul><table> <tr> - <td><em>hid_t</em> <code>class</code></td> + <td><em>hid_t</em> <code>class </code></td> <td>IN: Property list class to close</td></tr> </table></ul> @@ -970,7 +972,7 @@ END SUBROUTINE h5pclose_class_f <dt><strong>Parameters:</strong> <ul><table> <tr> - <td><em>hid_t</em> <code>plist</code><td> + <td><em>hid_t</em> <code>plist </code><td> <td>IN: Property list to close</td></tr> </table></ul> @@ -1013,10 +1015,11 @@ END SUBROUTINE h5pclose_list_f The new property list has the same properties and values as the original property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of property list to duplicate. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier of property list to duplicate.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a property list identifier if successful; otherwise returns a negative value. @@ -1092,7 +1095,7 @@ END SUBROUTINE h5pcopy_f <td><em>hid_t</em> <code>src_id</code></td> <td>IN: Identifier of the source property list or class</td></tr> <tr> - <td><em>const char *</em><code>name</code></td> + <td><em>const char *</em><code>name </code></td> <td>IN: Name of the property to copy</td></tr> </table></ul> @@ -1168,10 +1171,11 @@ END SUBROUTINE h5pcopy_prop_f <code>H5Pclose</code>; otherwise, errors are likely to occur. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>cls_id</code> - <dd>IN: The class of the property list to create. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>cls_id </code></td> + <td valign="top">IN: The class of the property list to create.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a property list identifier (<code>plist</code>) if successful; otherwise Fail (-1). @@ -1314,7 +1318,7 @@ END SUBROUTINE h5pcreate_f <td><em>const char *</em><code>name</code></td> <td>IN: Name of property list class to register</td></tr> <tr> - <td><em>H5P_cls_create_func_t</em> <code>create</code></td> + <td><em>H5P_cls_create_func_t</em> <code>create </code></td> <td>IN: Callback routine called when a property list is created</td></tr> <tr> <td><em>H5P_cls_copy_func_t</em> <code>copy</code></td> @@ -1329,6 +1333,7 @@ END SUBROUTINE h5pcreate_f <dd>Success: a valid property list class identifier <dd>Failure: a negative value +<!-- NEW PAGE --> <dt><strong>Fortran90 Interface:</strong> h5pcreate_class_f <dd> <pre> @@ -1383,7 +1388,7 @@ END SUBROUTINE h5pcreate_class_f <dt><strong>Parameter:</strong> <ul><table> <tr> - <td><em>hid_t</em> <code>class</code>;</td> + <td><em>hid_t</em> <code>class; </code></td> <td>IN: Class of property list to create.</td></tr> </table></ul> @@ -1408,6 +1413,105 @@ SUBROUTINE </dl> <!-- NEW PAGE --> +<!-- HEADER RIGHT "H5Premove_filter" --> +<hr> +<dl> + <dt><strong>Name:</strong> <a name="Property-RemoveFilter">H5Premove_filter</a> + <dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Premove_filter</code>(<em>hid_t</em> <code>plist</code>, + <em>H5Z_filter_t</em> <code>filter</code> + ) + <dt><strong>Purpose:</strong> + <dd>Delete one or more filters in the filter pipeline. + <dt><strong>Description:</strong> + <dd><code>H5Premove_filter</code> removes the specified + <code>filter</code> from the filter pipeline in the + dataset creation property list <code>plist</code>. + <p> + The <code>filter</code> parameter specifies the filter to be removed. + Valid values for use in <code>filter</code> are as follows: + + <center> + <table width=75%> + <tr valign=top align=left><td> + <code>H5Z_FILTER_ALL</code> + </td><td> + Removes all filters from the permanent filter pipeline. + </td></tr> + <tr valign=top align=left><td> + <code>H5Z_FILTER_DEFLATE</code> + </td><td> + Data compression filter, employing the gzip algorithm + </td></tr> + <tr valign=top align=left><td> + <code>H5Z_FILTER_SHUFFLE</code> + </td><td> + Data shuffling filter + </td></tr> + <tr valign=top align=left><td> + <code>H5Z_FILTER_FLETCHER32 </code> + </td><td> + Error detection filter, employing the Fletcher32 checksum algorithm + </td></tr> + <tr valign=top align=left><td> + <code>H5Z_FILTER_SZIP</code> + </td><td> + Data compression filter, employing the SZIP algorithm + </td></tr> + </table> + </center> + <p> + Additionally, user-defined filters can be removed with this routine + by passing the filter identifier with which they were registered + with the HDF5 Library. + <p> + Attempting to remove a filter that is not in the permanent filter + pipeline is an error. + <dt><strong>Note:</strong> + <dd>This function currently supports only the permanent filter + pipeline; <code>plist</code> must be a dataset creation + property list. + <dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>plist_id</code> + <dd>IN: Dataset creation property list identifier. + <dt><em>H5Z_filter_t</em> <code>filter</code> + <dd>IN: Filter to be deleted. + </dl> + <dt><strong>Returns:</strong> + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. + + <dt><strong>Fortran90 Interface:</strong> h5premove_filter_f + <dd> + <pre> +SUBROUTINE h5premove_filter_f(prp_id, filter, hdferr) + + IMPLICIT NONE + INTEGER(HID_T), INTENT(IN) :: prp_id ! Dataset creation property + ! list identifier + INTEGER, INTENT(IN) :: filter ! Filter to be removed + ! Valid values are: + ! H5Z_FILTER_ALL_F + ! H5Z_FILTER_DEFLATE_F + ! H5Z_FILTER_SHUFFLE_F + ! H5Z_FILTER_FLETCHER32_F + ! H5Z_FILTER_SZIP_F + ! + INTEGER, INTENT(OUT) :: hdferr ! Error code + ! 0 on success, -1 on failure +END SUBROUTINE h5premove_filter_f + </pre> + + <!--<dt><strong>Non-C API(s):</strong> + <dd> + + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + +<!-- NEW PAGE --> <!-- HEADER RIGHT "H5Pequal" --> <hr> <dl> @@ -1434,7 +1538,7 @@ SUBROUTINE <dt><strong>Parameters:</strong> <ul><table> <tr> - <td><em>hid_t</em> <code>id1</code></td> + <td><em>hid_t</em> <code>id1 </code></td> <td>IN: First property object to be compared</td></tr> <tr> <td><em>hid_t</em> <code>id2</code></td> @@ -1494,7 +1598,7 @@ END SUBROUTINE h5pequal_f <td><em>hid_t</em> <code>id</code></td> <td>IN: Identifier for the property to query</td></tr> <tr> - <td><em>const char *</em><code>name</code></td> + <td><em>const char *</em><code>name </code></td> <td>IN: Name of property to check for</td></tr> </table></ul> @@ -1564,12 +1668,14 @@ END SUBROUTINE h5pexist_f See <a href="RM_H5D.html#Dataset-Create">H5Dcreate</a> for further cross-references. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Dataset creation property list identifier. - <dt><em>H5D_fill_value_t *</em><code>status</code> - <dd>OUT: Status of fill value in property list. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5D_fill_value_t *</em><code>status </code></td> + <td valign="top">OUT: Status of fill value in property list.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1631,7 +1737,7 @@ SUBROUTINE <td><em>hid_t</em> <code>plid</ecodem></td> <td>IN: Identifier of the property list to query</td></tr> <tr> - <td><em>const char *</em><code>name</code></td> + <td><em>const char *</em><code>name </code></td> <td>IN: Name of property to query</td></tr> <tr> <td><em>void *</em><code>value</code></td> @@ -1688,14 +1794,17 @@ END SUBROUTINE h5pget_f The <code>threshold</code> and/or <code>alignment</code> pointers may be null pointers (NULL). <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of a file access property list. - <dt><em>hsize_t</em> <code>*threshold</code> - <dd>OUT: Pointer to location of return threshold value. - <dt><em>hsize_t</em> <code>*alignment</code> - <dd>OUT: Pointer to location of return alignment value. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier of a file access property list.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>*threshold </code></td> + <td valign="top">OUT: Pointer to location of return threshold value.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>*alignment</code></td> + <td valign="top">OUT: Pointer to location of return alignment value.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1766,12 +1875,14 @@ END SUBROUTINE h5pget_alignment_f set with the functions <code>H5Pget_fill_value</code> and <code>H5Pget_fill_time</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Dataset creation property list identifier. - <dt><em>H5D_alloc_time_t *</em><code>alloc_time</code> - <dd>IN: When to allocate dataset storage space. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5D_alloc_time_t *</em><code>alloc_time </code></td> + <td valign="top">IN: When to allocate dataset storage space.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1823,16 +1934,20 @@ END SUBROUTINE h5pget_alloc_time_f arguments <code>left</code>, <code>middle</code>, and <code>right</code>, as set by the <a href="#Property-SetBTreeRatios">H5Pset_btree_ratios</a> function. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: The dataset transfer property list identifier. - <dt><em>double</em> <code>left</code> - <dd>OUT: The B-tree split ratio for left-most nodes. - <dt><em>double</em> <code>right</code> - <dd>OUT: The B-tree split ratio for right-most nodes and lone nodes. - <dt><em>double</em> <code>middle</code> - <dd>OUT: The B-tree split ratio for all other nodes. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: The dataset transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>double</em> <code>left</code></td> + <td valign="top">OUT: The B-tree split ratio for left-most nodes.</td></tr> + <tr> + <td valign="top"><em>double</em> <code>right</code></td> + <td valign="top">OUT: The B-tree split ratio for right-most nodes and lone nodes.</td></tr> + <tr> + <td valign="top"><em>double</em> <code>middle </code></td> + <td valign="top">OUT: The B-tree split ratio for all other nodes.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1876,16 +1991,19 @@ END SUBROUTINE h5pget_btree_ratios_f <dd><code>H5Pget_buffer</code> reads values previously set with H5Pset_buffer. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for the dataset transfer property list. - <dt><em>void</em> <code>**tconv</code> - <dd>OUT: Address of the pointer to application-allocated - type conversion buffer. - <dt><em>void</em> <code>**bkg</code> - <dd>OUT: Address of the pointer to application-allocated - background buffer. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier for the dataset transfer property list.</td></tr> + <tr> + <td valign="top"><em>void</em> <code>**tconv </code></td> + <td valign="top">OUT: Address of the pointer to application-allocated + type conversion buffer.</td></tr> + <tr> + <td valign="top"><em>void</em> <code>**bkg</code></td> + <td valign="top">OUT: Address of the pointer to application-allocated + background buffer.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns buffer size, in bytes, if successful; otherwise 0 on failure. @@ -1933,25 +2051,30 @@ END SUBROUTINE h5pget_buffer_f Any (or all) arguments may be null pointers, in which case the corresponding datum is not returned. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Identifier of the file access property list. - <dt><em>int</em> <code>*mdc_nelmts</code> - <dd>IN/OUT: Number of elements (objects) in the meta data cache. - <dt><em>int</em> <code>*rdcc_nelmts</code> - <dd>IN/OUT: Number of elements (objects) in the raw data chunk cache. - <dt><em>size_t</em> <code>*rdcc_nbytes</code> - <dd>IN/OUT: Total size of the raw data chunk cache, in bytes. - <dt><em>double</em> <code>*rdcc_w0</code> - <dd>IN/OUT: Preemption policy. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Identifier of the file access property list.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>*mdc_nelmts</code></td> + <td valign="top">IN/OUT: Number of elements (objects) in the meta data cache.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>*rdcc_nelmts</code></td> + <td valign="top">IN/OUT: Number of elements (objects) in the raw data chunk cache.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>*rdcc_nbytes </code></td> + <td valign="top">IN/OUT: Total size of the raw data chunk cache, in bytes.</td></tr> + <tr> + <td valign="top"><em>double</em> <code>*rdcc_w0</code></td> + <td valign="top">IN/OUT: Preemption policy.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. <dt><strong>Fortran90 Interface:</strong> h5pget_cache_f <dd> <pre> -SUBROUTINE h5pget_cache_f(prp_id, mdc_nelmts, rdcc_nelmts, rdcc_nbytes, & +SUBROUTINE h5pget_cache_f(prp_id, mdc_nelmts, rdcc_nelmts, rdcc_nbytes, rdcc_w0, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier @@ -1995,14 +2118,17 @@ END SUBROUTINE h5pget_cache_f At most, <code>max_ndims</code> elements of <code>dims</code> will be initialized. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of property list to query. - <dt><em>int</em> <code>max_ndims</code> - <dd>IN: Size of the <code>dims</code> array. - <dt><em>hsize_t *</em> <code>dims</code> - <dd>OUT: Array to store the chunk dimensions. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier of property list to query.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>max_ndims </code></td> + <td valign="top">IN: Size of the <code>dims</code> array.</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em> <code>dims</code></td> + <td valign="top">OUT: Array to store the chunk dimensions.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns chunk dimensionality successful; otherwise returns a negative value. @@ -2047,10 +2173,11 @@ END SUBROUTINE h5pget_chunk_f Valid property list classes are defined in the description of <code>H5Pcreate</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of property list to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier of property list to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a property list class if successful. Otherwise returns H5P_NO_CLASS (-1). @@ -2104,7 +2231,7 @@ END SUBROUTINE h5pget_class_f <dt><strong>Parameters:</strong> <ul><table> <tr> - <td><em>hid_t</em> <code>pcid</code></td> + <td><em>hid_t</em> <code>pcid </code></td> <td>IN: Identifier of the property class to query</td></tr> </table></ul> @@ -2160,7 +2287,7 @@ END SUBROUTINE h5pget_class_name_f <dt><strong>Parameters:</strong> <ul><table> <tr> - <td><em>hid_t</em> <code>pcid</code></td> + <td><em>hid_t</em> <code>pcid </code></td> <td>IN: Identifier of the property class to query</td></tr> </table></ul> @@ -2224,10 +2351,11 @@ END SUBROUTINE h5pget_class_parent_f The returned driver identifier is only valid as long as the file driver remains registered. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: File access or data transfer property list identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id </code></td> + <td valign="top">IN: File access or data transfer property list identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a valid low-level driver identifier if successful. Otherwise returns a negative value. @@ -2319,12 +2447,14 @@ END SUBROUTINE h5pget_driver_f <p> <code>H5Pget_dxpl_mpio</code> is not a collective function. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dxpl_id</code> - <dd>IN: Data transfer property list identifier. - <dt><em>H5FD_mpio_xfer_t *</em><code>xfer_mode</code> - <dd>OUT: Data transfer mode. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dxpl_id</code></td> + <td valign="top">IN: Data transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5FD_mpio_xfer_t *</em><code>xfer_mode </code></td> + <td valign="top">OUT: Data transfer mode.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -2369,12 +2499,14 @@ END SUBROUTINE h5pget_dxpl_mpio_f <dd><code>H5Pget_dxpl_multi</code> returns the data transfer property list information for the multi-file driver. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dxpl_id</code>, - <dd>IN: Data transfer property list identifier. - <dt><em>const hid_t *</em><code>memb_dxpl</code> - <dd>OUT: Array of data access property lists. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dxpl_id</code>,</td> + <td valign="top">IN: Data transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>const hid_t *</em><code>memb_dxpl </code></td> + <td valign="top">OUT: Array of data access property lists.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -2408,10 +2540,11 @@ SUBROUTINE list <code>plist</code> to determine whether error detection is enabled for data read operations. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Dataset transfer property list identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Dataset transfer property list identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns <code>H5Z_ENABLE_EDC</code> or <code>H5Z_DISABLE_EDC</code> if successful; @@ -2446,7 +2579,7 @@ END SUBROUTINE h5pget_edc_check_f <dt><strong>Name:</strong> <a name="Property-GetExternal">H5Pget_external</a> <dt><strong>Signature:</strong> <dd><em>herr_t</em> <code>H5Pget_external</code>(<em>hid_t</em> <code>plist</code>, - <em>int</em> <code>idx</code>, + <em>unsigned</em> <code>idx</code>, <em>size_t</em> <code>name_size</code>, <em>char</em> <code>*name</code>, <em>off_t</em> <code>*offset</code>, @@ -2469,21 +2602,27 @@ END SUBROUTINE h5pget_edc_check_f If <code>offset</code> or <code>size</code> are null pointers then the corresponding information is not returned. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of a dataset creation property list. - <dt><em>int</em> <code>idx</code> - <dd>IN: External file index. - <dt><em>size_t</em> <code>name_size</code> - <dd>IN: Maximum length of <code>name</code> array. - <dt><em>char</em> <code>*name</code> - <dd>OUT: Name of the external file. - <dt><em>off_t</em> <code>*offset</code> - <dd>OUT: Pointer to a location to return an offset value. - <dt><em>hsize_t</em> <code>*size</code> - <dd>OUT: Pointer to a location to return the size of the - external file data. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier of a dataset creation property list.</td></tr> + <tr> + <td valign="top"><em>unsigned</em> <code>idx</code></td> + <td valign="top">IN: External file index.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>name_size </code></td> + <td valign="top">IN: Maximum length of <code>name</code> array.</td></tr> + <tr> + <td valign="top"><em>char</em> <code>*name</code></td> + <td valign="top">OUT: Name of the external file.</td></tr> + <tr> + <td valign="top"><em>off_t</em> <code>*offset</code></td> + <td valign="top">OUT: Pointer to a location to return an offset value.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>*size</code></td> + <td valign="top">OUT: Pointer to a location to return the size of the + external file data.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -2529,10 +2668,11 @@ END SUBROUTINE h5pget_external_f <dd><code>H5Pget_external_count</code> returns the number of external files for the specified dataset. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of a dataset creation property list. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier of a dataset creation property list.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the number of external files if successful; otherwise returns a negative value. @@ -2587,12 +2727,14 @@ END SUBROUTINE h5pget_external_count_f Use of this function is only appropriate for an HDF5 file written as a family of files with the <code>FAMILY</code> file driver. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>hsize_t *</em><code>offset</code> - <dd>IN: Offset in bytes within the HDF5 file. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em><code>offset </code></td> + <td valign="top">IN: Offset in bytes within the HDF5 file.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -2629,15 +2771,18 @@ SUBROUTINE <dd><code>H5Pget_fapl_core</code> queries the <code>H5FD_CORE</code> driver properties as set by <code>H5Pset_fapl_core</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>size_t</em> *<code>increment</code> - <dd>OUT: Size, in bytes, of memory increments. - <dt><em>hbool_t</em> *<code>backing_store</code> - <dd>OUT: Boolean flag indicating whether to write the file - contents to disk when the file is closed. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>size_t</em> *<code>increment</code></td> + <td valign="top">OUT: Size, in bytes, of memory increments.</td></tr> + <tr> + <td valign="top"><em>hbool_t</em> *<code>backing_store </code></td> + <td valign="top">OUT: Boolean flag indicating whether to write the file + contents to disk when the file is closed.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -2683,15 +2828,18 @@ END SUBROUTINE h5pget_fapl_core_f for use with the family driver. This information is returned through the output parameters. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em> hsize_t *</em><code>memb_size</code> - <dd>OUT: Size in bytes of each file member. - <dt><em>hid_t *</em><code>memb_fapl_id</code> - <dd>OUT: Identifier of file access property list for each - family member. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em> hsize_t *</em><code>memb_size</code></td> + <td valign="top">OUT: Size in bytes of each file member.</td></tr> + <tr> + <td valign="top"><em>hid_t *</em><code>memb_fapl_id </code></td> + <td valign="top">OUT: Identifier of file access property list for each + family member.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -2746,12 +2894,14 @@ END SUBROUTINE h5pget_fapl_family_f For further information, see <a href="http://www.globus.org/">http//www.globus.org/</a>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code>, - <dd>IN: File access property list identifier. - <dt><em>GASS_Info *</em><code>info</code> - <dd>OUT: Pointer to the GASS information structure. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code>,</td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>GASS_Info *</em><code>info </code></td> + <td valign="top">OUT: Pointer to the GASS information structure.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -2794,14 +2944,17 @@ SUBROUTINE so they are valid only until the file access property list is either modified or closed. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>MPI_Comm *</em><code>comm</code> - <dd>OUT: MPI-2 communicator. - <dt><em>MPI_Info *</em><code>info</code> - <dd>OUT: MPI-2 info object. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>MPI_Comm *</em><code>comm </code></td> + <td valign="top">OUT: MPI-2 communicator.</td></tr> + <tr> + <td valign="top"><em>MPI_Info *</em><code>info</code></td> + <td valign="top">OUT: MPI-2 info object.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -2848,12 +3001,14 @@ END SUBROUTINE h5pget_fapl_mpio_f <code>comm</code> is not copied, so it is valid only until the file access property list is either modified or closed. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>MPI_Comm *</em><code>comm</code> - <dd>OUT: MPI-2 communicator. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>MPI_Comm *</em><code>comm </code></td> + <td valign="top">OUT: MPI-2 communicator.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -2897,28 +3052,34 @@ END SUBROUTINE h5pget_fapl_mpiposix_f <dd><code>H5Pget_fapl_multi</code> returns information about the multi-file access property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>const H5FD_mem_t *</em><code>memb_map</code> - <dd>OUT: Maps memory usage types to other memory usage types. - <dt><em>const hid_t *</em><code>memb_fapl</code> - <dd>OUT: Property list for each memory usage type. - <dt><em>const char **</em><code>memb_name</code> - <dd>OUT: Name generator for names of member files. - <dt><em>const haddr_t *</em><code>memb_addr</code> - <dd>OUT: - <dt><em>hbool_t *</em><code>relax</code> - <dd>OUT: Allows read-only access to incomplete file sets - when <code>TRUE</code>. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>const H5FD_mem_t *</em><code>memb_map </code></td> + <td valign="top">OUT: Maps memory usage types to other memory usage types.</td></tr> + <tr> + <td valign="top"><em>const hid_t *</em><code>memb_fapl</code></td> + <td valign="top">OUT: Property list for each memory usage type.</td></tr> + <tr> + <td valign="top"><em>const char **</em><code>memb_name</code></td> + <td valign="top">OUT: Name generator for names of member files.</td></tr> + <tr> + <td valign="top"><em>const haddr_t *</em><code>memb_addr</code></td> + <td valign="top">OUT:</td></tr> + <tr> + <td valign="top"><em>hbool_t *</em><code>relax</code></td> + <td valign="top">OUT: Allows read-only access to incomplete file sets + when <code>TRUE</code>.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. <dt><strong>Fortran90 Interface:</strong> h5pget_fapl_multi_f <dd> <pre> -SUBROUTINE h5pget_fapl_multi_f(prp_id, memb_map, memb_fapl, memb_name, & +SUBROUTINE h5pget_fapl_multi_f(prp_id, memb_map, memb_fapl, memb_name, memb_addr, relax, hdferr) IMPLICIT NONE INTEGER(HID_T),INTENT(IN) :: prp_id ! Property list identifier @@ -2970,12 +3131,14 @@ END SUBROUTINE h5pget_fapl_multi_f Storage Resource Broker (SRB). For further information, see <a href="http://www.npaci.edu/Research/DI/srb/">http//www.npaci.edu/Research/DI/srb/</a>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>SRB_Info *</em><code>info</code> - <dd>OUT: Pointer to the SRB information structure. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>SRB_Info *</em><code>info </code></td> + <td valign="top">OUT: Pointer to the SRB information structure.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -3013,12 +3176,14 @@ SUBROUTINE <code>H5Pset_fapl_stream</code> and <code>H5Pget_fapl_stream</code> are not intended for use in a parallel environment. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>H5FD_stream_fapl_t *</em><code>fapl</code> - <dd>OUT: The streaming I/O file access property list. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5FD_stream_fapl_t *</em><code>fapl </code></td> + <td valign="top">OUT: The streaming I/O file access property list.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -3056,13 +3221,15 @@ SUBROUTINE is called to close that file. <code>fc_degree</code> can have any one of four valid values as described above in <a href="#Property-SetFcloseDegree"><code>H5Pset_fclose_degree</code></a>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>H5F_close_degree_t *</em><code>fc_degree</code> - <dd>OUT: Pointer to a location to which to return the file close degree - property, the value of <code>fc_degree</code>. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5F_close_degree_t *</em><code>fc_degree </code></td> + <td valign="top">OUT: Pointer to a location to which to return the file close degree + property, the value of <code>fc_degree</code>.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -3131,12 +3298,14 @@ END SUBROUTINE h5pget_fclose_degree_f dataset storage allocation time properties, retrieved with the functions <code>H5Pget_fill_value</code> and <code>H5Pget_alloc_time</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Dataset creation property list identifier. - <dt><em>H5D_fill_time_t *</em><code>fill_time</code> - <dd>OUT: Setting for the timing of writing fill values to the dataset. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5D_fill_time_t *</em><code>fill_time </code></td> + <td valign="top">OUT: Setting for the timing of writing fill values to the dataset.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3206,15 +3375,17 @@ END SUBROUTINE h5pget_fill_time_f and <code>H5Pget_fill_time</code>, respectively. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Dataset creation property list identifier. - <dt><em>hid_t</em> <code>type_id</code>, - <dd>IN: Datatype identifier for the value passed - via <code>value</code>. - <dt><em>void *</em><code>value</code> - <dd>OUT: Pointer to buffer to contain the returned fill value. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id </code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code>,</td> + <td valign="top">IN: Datatype identifier for the value passed + via <code>value</code>.</td></tr> + <tr><td valign="top"><em>void *</em><code>value</code></td> + <td valign="top">OUT: Pointer to buffer to contain the returned fill value.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3253,7 +3424,7 @@ END SUBROUTINE h5pget_fill_value_f <em>size_t *</em><code>cd_nelmts</code>, <em>unsigned int *</em><code>cd_values</code>, <em>size_t</em> <code>namelen</code>, - <em>char</em> <code>name[]</code> + <em>char</em> <code>name[]</code> ) <dt><strong>Purpose:</strong> <dd>Returns information about a filter in a pipeline. @@ -3292,24 +3463,32 @@ END SUBROUTINE h5pget_fill_value_f pipeline; <code>plist</code> must be a dataset creation property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Property list identifier. - <dt><em>int</em> <code>filter_number</code> - <dd>IN: Sequence number within the filter pipeline of - the filter for which information is sought. - <dt><em>unsigned int *</em><code>flags</code> - <dd>OUT: Bit vector specifying certain general properties - of the filter. - <dt><em>size_t *</em><code>cd_nelmts</code> - <dd>IN/OUT: Number of elements in <code>cd_values</code>. - <dt><em>unsigned int *</em><code>cd_values</code> - <dd>OUT: Auxiliary data for the filter. - <dt><em>size_t</em> <code>namelen</code> - <dd>IN: Anticipated number of characters in <code>name</code>. - <dt><em>char</em> <code>name[]</code> - <dd>OUT: Name of the filter. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Property list identifier.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>filter_number</code></td> + <td valign="top">IN: Sequence number within the filter pipeline of + the filter for which information is sought.</td></tr> + <tr> + <td valign="top"><em>unsigned int *</em><code>flags</code></td> + <td valign="top">OUT: Bit vector specifying certain general properties + of the filter.</td></tr> + <tr> + <td valign="top"><em>size_t *</em><code>cd_nelmts</code></td> + <td valign="top">IN/OUT: Number of elements in <code>cd_values</code>.</td></tr> + <tr> + <td valign="top"><em>unsigned int *</em><code>cd_values </code></td> + <td valign="top">OUT: Auxiliary data for the filter.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>namelen</code></td> + <td valign="top">IN: Anticipated number of characters in <code>name</code>.</td></tr> + <tr> + <td valign="top"><em>char</em> <code>name[]</code></td> + <td valign="top">OUT: Name of the filter.</td></tr> + </table></ul> +<!-- NEW PAGE --> <dt><strong>Returns:</strong> <dd>Returns the filter identifier if successful: <center> @@ -3418,24 +3597,31 @@ END SUBROUTINE h5pget_filter_f set for the property list, an error will be returned and <code>H5Pget_filter_by_id</code> will fail. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Property list identifier. - <dt><em>H5Z_filter_t</em> <code>filter</code> - <dd>IN: Filter identifier. - <dt><em>unsigned int</em> <code>flags</code> - <dd>OUT: Bit vector specifying certain general properties - of the filter. - <dt><em>size_t</em> <code>cd_nelmts</code> - <dd>IN/OUT: Number of elements in <code>cd_values</code>. - <dt><em>const unsigned int</em> <code>cd_values[]</code> - <dd>OUT: Auxiliary data for the filter. - <dt><em>size_t</em> <code>namelen</code> - <dd>IN/OUT: Length of filter name and - number of elements in <code>name[]</code>. - <dt><em>char *</em><code>name[]</code> - <dd>OUT: Name of filter. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5Z_filter_t</em> <code>filter</code></td> + <td valign="top">IN: Filter identifier.</td></tr> + <tr> + <td valign="top"><em>unsigned int</em> <code>flags</code></td> + <td valign="top">OUT: Bit vector specifying certain general properties + of the filter.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>cd_nelmts</code></td> + <td valign="top">IN/OUT: Number of elements in <code>cd_values</code>.</td></tr> + <tr> + <td valign="top"><em>const unsigned int</em> <code>cd_values[] </code></td> + <td valign="top">OUT: Auxiliary data for the filter.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>namelen</code></td> + <td valign="top">IN/OUT: Length of filter name and + number of elements in <code>name[]</code>.</td></tr> + <tr> + <td valign="top"><em>char *</em><code>name[]</code></td> + <td valign="top">OUT: Name of filter.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3443,7 +3629,7 @@ END SUBROUTINE h5pget_filter_f <dt><strong>Fortran90 Interface:</strong> h5pget_filter_by_id_f <dd> <pre> -SUBROUTINE h5pget_filter_by_id_f(prp_id, filter_id, flags, cd_nelmts, & +SUBROUTINE h5pget_filter_by_id_f(prp_id, filter_id, flags, cd_nelmts, cd_values, namelen, name, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier @@ -3488,15 +3674,17 @@ END SUBROUTINE h5pget_filter_by_id_f The garbage collection references property is set by <a href="#Property-SetGCReferences">H5Pset_gc_references</a>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: File access property list identifier. - <dt><em>unsigned</em> <code>gc_ref</code> - <dd>OUT: Flag returning the state of reference garbage collection. + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>unsigned</em> <code>gc_ref </code></td> + <td valign="top">OUT: Flag returning the state of reference garbage collection. A returned value of <code>1</code> indicates that garbage collection is on while - <code>0</code> indicates that garbage collection is off. - </dl> + <code>0</code> indicates that garbage collection is off.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3608,12 +3796,14 @@ END SUBROUTINE h5pget_hyper_cache_f was previously set with a call to <a href="#Property-SetHyperVectorSize">H5Pset_hyper_vector_size</a>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dxpl_id</code> - <dd>IN: Dataset transfer property list identifier. - <dt><em>size_t *</em><code>vector_size</code> - <dd>OUT: Number of I/O vectors to accumulate in memory for I/O operations. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dxpl_id</code></td> + <td valign="top">IN: Dataset transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>size_t *</em><code>vector_size </code></td> + <td valign="top">OUT: Number of I/O vectors to accumulate in memory for I/O operations.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3645,7 +3835,7 @@ END SUBROUTINE h5pget_hyper_vector_size_f <dt><strong>Name:</strong> <a name="Property-GetIstoreK">H5Pget_istore_k</a> <dt><strong>Signature:</strong> <dd><em>herr_t </em><code>H5Pget_istore_k</code>(<em>hid_t</em> <code>plist</code>, - <em>int *</em> <code>ik</code> + <em>unsigned *</em> <code>ik</code> ) <dt><strong>Purpose:</strong> <dd>Queries the 1/2 rank of an indexed storage B-tree. @@ -3657,12 +3847,14 @@ END SUBROUTINE h5pget_hyper_vector_size_f <p> See <a href="#Property-SetIstoreK">H5Pset_istore_k</a> for details. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of property list to query. - <dt><em>int *</em> <code>ik</code> - <dd>OUT: Pointer to location to return the chunked storage B-tree 1/2 rank. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier of property list to query.</td></tr> + <tr> + <td valign="top"><em>unsigned *</em> <code>ik</code></td> + <td valign="top">OUT: Pointer to location to return the chunked storage B-tree 1/2 rank.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3706,10 +3898,11 @@ END SUBROUTINE h5pget_istore_k_f documentation for details. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for property list to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier for property list to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the layout type (a non-negative value) of a dataset creation property list if successful. @@ -3773,12 +3966,14 @@ END SUBROUTINE h5pget_layout_f and is retrieved from the file access property list <code>fapl_id</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>hsize_t *</em><code>size</code> - <dd>OUT: Minimum size, in bytes, of metadata block allocations. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id </code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em><code>size</code></td> + <td valign="top">OUT: Minimum size, in bytes, of metadata block allocations.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -3836,12 +4031,14 @@ END SUBROUTINE h5pget_meta_block_size_f Use of this function is only appropriate for an HDF5 file written as a set of files with the <code>MULTI</code> file driver. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list or data transfer property list identifier. - <dt><em>H5FD_mem_t *</em><code>type</code> - <dd>OUT: Type of data. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list or data transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5FD_mem_t *</em><code>type </code></td> + <td valign="top">OUT: Type of data.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3889,10 +4086,11 @@ SUBROUTINE pipeline; <code>plist_id</code> must be a dataset creation property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Property list identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Property list identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the number of filters in the pipeline if successful; otherwise returns a negative value. @@ -3947,7 +4145,7 @@ END SUBROUTINE h5pget_nfilters_f <td><em>hid_t</em> <code>id</code></td> <td>IN: Identifier of property object to query</td></tr> <tr> - <td><em>size_t *</em><code>nprops</code></td> + <td><em>size_t *</em><code>nprops </code></td> <td>OUT: Number of properties in object</td></tr> </table></ul> @@ -3988,10 +4186,11 @@ END SUBROUTINE h5pget_nprops_f <dd><code>H5Pget_preserve</code> checks the status of the dataset transfer property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for the dataset transfer property list. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier for the dataset transfer property list.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns TRUE or FALSE if successful; otherwise returns a negative value. @@ -4027,8 +4226,6 @@ END SUBROUTINE h5pget_preserve_f <em>hid_t</em> <code>fapl_id</code>, <em>hsize_t *</em><code>size</code> ) -<br> -<br> <dt><strong>Purpose:</strong> <dd> Returns maximum data sieve buffer size. <dt><strong>Description:</strong> @@ -4040,12 +4237,14 @@ END SUBROUTINE h5pget_preserve_f and is retrieved from the file access property list <code>fapl_id</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>hsize_t *</em><code>size</code> - <dd>IN: Maximum size, in bytes, of data sieve buffer. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id </code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em><code>size</code></td> + <td valign="top">IN: Maximum size, in bytes, of data sieve buffer.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -4101,7 +4300,7 @@ END SUBROUTINE h5pget_sieve_buf_size_f <td><em>hid_t</em> <code>id</code></td> <td>IN: Identifier of property object to query</td></tr> <tr> - <td><em>const char *</em><code>name</code></td> + <td><em>const char *</em><code>name </code></td> <td>IN: Name of property to query</td></tr> <tr> <td><em>size_t *</em><code>size</code></td> @@ -4150,14 +4349,17 @@ END SUBROUTINE h5pget_size_f and lengths used in an HDF5 file. This function is only valid for file creation property lists. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of property list to query. - <dt><em>size_t *</em> <code>size</code> - <dd>OUT: Pointer to location to return offset size in bytes. - <dt><em>size_t *</em> <code>size</code> - <dd>OUT: Pointer to location to return length size in bytes. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier of property list to query.</td></tr> + <tr> + <td valign="top"><em>size_t *</em> <code>size </code></td> + <td valign="top">OUT: Pointer to location to return offset size in bytes.</td></tr> + <tr> + <td valign="top"><em>size_t *</em> <code>size</code></td> + <td valign="top">OUT: Pointer to location to return length size in bytes.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -4202,12 +4404,14 @@ END SUBROUTINE h5pget_sizes_f If the returned value is zero (<code>0</code>), the small data block mechanism has been disabled for the file. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier . - <dt><em>hsize_t *</em><code>size</code> - <dd>OUT: Maximum size, in bytes, of the small data block. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id </code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em><code>size</code></td> + <td valign="top">OUT: Maximum size, in bytes, of the small data block.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise a negative value. @@ -4239,8 +4443,8 @@ END SUBROUTINE h5pget_small_data_block_size_f <dt><strong>Name:</strong> <a name="Property-GetSymK">H5Pget_sym_k</a> <dt><strong>Signature:</strong> <dd><em>herr_t </em><code>H5Pget_sym_k</code>(<em>hid_t</em> <code>plist</code>, - <em>int *</em> <code>ik</code>, - <em>int *</em> <code>lk</code> + <em>unsigned *</em> <code>ik</code>, + <em>unsigned *</em> <code>lk</code> ) <dt><strong>Purpose:</strong> <dd>Retrieves the size of the symbol table B-tree 1/2 rank @@ -4254,14 +4458,17 @@ END SUBROUTINE h5pget_small_data_block_size_f <a href="#Property-SetSymK">H5Pset_sym_k</a> for more information. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Property list to query. - <dt><em>int *</em> <code>ik</code> - <dd>OUT: Pointer to location to return the symbol table's B-tree 1/2 rank. - <dt><em>int *</em> <code>size</code> - <dd>OUT: Pointer to location to return the symbol table's leaf node 1/2 size. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Property list to query.</td></tr> + <tr> + <td valign="top"><em>unsigned *</em> <code>ik</code></td> + <td valign="top">OUT: Pointer to location to return the symbol table's B-tree 1/2 rank.</td></tr> + <tr> + <td valign="top"><em>unsigned *</em> <code>size</code></td> + <td valign="top">OUT: Pointer to location to return the symbol table's leaf node 1/2 size.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -4301,12 +4508,14 @@ END SUBROUTINE h5pget_sym_k_f <dd><code>H5Pget_userblock</code> retrieves the size of a user block in a file creation property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for property list to query. - <dt><em>hsize_t *</em> <code>size</code> - <dd>OUT: Pointer to location to return user-block size. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier for property list to query.</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em> <code>size </code></td> + <td valign="top">OUT: Pointer to location to return user-block size.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -4338,10 +4547,10 @@ END SUBROUTINE h5pget_userblock_f <dt><strong>Name:</strong> <a name="Property-GetVersion">H5Pget_version</a> <dt><strong>Signature:</strong> <dd><em>herr_t </em><code>H5Pget_version</code>(<em>hid_t</em> <code>plist</code>, - <em>int *</em> <code>super</code>, - <em>int *</em> <code>freelist</code>, - <em>int *</em> <code>stab</code>, - <em>int *</em> <code>shhdr</code> + <em>unsigned *</em> <code>super</code>, + <em>unsigned *</em> <code>freelist</code>, + <em>unsigned *</em> <code>stab</code>, + <em>unsigned *</em> <code>shhdr</code> ) <dt><strong>Purpose:</strong> <dd>Retrieves the version information of various objects for @@ -4351,18 +4560,23 @@ END SUBROUTINE h5pget_userblock_f for a file creation property list. Any pointer parameters which are passed as NULL are not queried. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of the file creation property list. - <dt><em>int *</em> <code>super</code> - <dd>OUT: Pointer to location to return super block version number. - <dt><em>int *</em> <code>freelist</code> - <dd>OUT: Pointer to location to return global freelist version number. - <dt><em>int *</em> <code>stab</code> - <dd>OUT: Pointer to location to return symbol table version number. - <dt><em>int *</em> <code>shhdr</code> - <dd>OUT: Pointer to location to return shared object header version number. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier of the file creation property list.</td></tr> + <tr> + <td valign="top"><em>unsigned *</em> <code>super</code></td> + <td valign="top">OUT: Pointer to location to return super block version number.</td></tr> + <tr> + <td valign="top"><em>unsigned *</em> <code>freelist </code></td> + <td valign="top">OUT: Pointer to location to return global freelist version number.</td></tr> + <tr> + <td valign="top"><em>unsigned *</em> <code>stab</code></td> + <td valign="top">OUT: Pointer to location to return symbol table version number.</td></tr> + <tr> + <td valign="top"><em>unsigned *</em> <code>shhdr</code></td> + <td valign="top">OUT: Pointer to location to return shared object header version number.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -4415,26 +4629,31 @@ END SUBROUTINE h5pget_version_f <code>H5Pset_vlen_mem_manager</code>, returning the parameters set by that function. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for the dataset transfer property list. - <dt><em>H5MM_allocate_t</em> <code>alloc</code> - <dd>OUT: User's allocate routine, or <code> NULL</code> - for system <code> malloc</code>. - <dt><em>void</em> *<code>alloc_info</code> - <dd>OUT: Extra parameter for user's allocation routine. + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier for the dataset transfer property list.</td></tr> + <tr> + <td valign="top"><em>H5MM_allocate_t</em> <code>alloc </code></td> + <td valign="top">OUT: User's allocate routine, or <code> NULL</code> + for system <code> malloc</code>.</td></tr> + <tr> + <td valign="top"><em>void</em> *<code>alloc_info</code></td> + <td valign="top">OUT: Extra parameter for user's allocation routine. <br> Contents are ignored if preceding parameter is - <code> NULL</code>. - <dt><em>H5MM_free_t</em> <code>free</code> - <dd>OUT: User's free routine, or <code> NULL</code> for - system <code>free</code>. - <dt><em>void</em> *<code>free_info</code> - <dd>OUT: Extra parameter for user's free routine. + <code> NULL</code>.</td></tr> + <tr> + <td valign="top"><em>H5MM_free_t</em> <code>free</code></td> + <td valign="top">OUT: User's free routine, or <code> NULL</code> for + system <code>free</code>.</td></tr> + <tr> + <td valign="top"><em>void</em> *<code>free_info</code></td> + <td valign="top">OUT: Extra parameter for user's free routine. <br> Contents are ignored if preceding parameter is - <code> NULL</code>. - </dl> + <code> NULL</code>.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -4576,6 +4795,7 @@ SUBROUTINE routine returns an error value. </p> + <P> The <code>delete</code> routine is called when a property is being deleted from a property list. The <code>H5P_prp_delete_func_t</code> callback function is defined @@ -4609,6 +4829,7 @@ SUBROUTINE error value but the property is still deleted. </P> + <P> The <code>copy</code> routine is called when a new property list with this property is being created through a copy operation. The <code>H5P_prp_copy_func_t</code> callback function is defined @@ -4673,6 +4894,7 @@ SUBROUTINE list objects; the initial value is assumed to have any necessary setup already performed on it. +<!-- NEW PAGE --> <dt><strong>Parameters:</strong> <ul><table> <tr> @@ -4697,7 +4919,7 @@ SUBROUTINE <td>IN: Callback routine called when a property value is retrieved from the property</td></tr> <tr> - <td><em>H5P_prp_delete_func_t</em> <code>delete</code></td> + <td><em>H5P_prp_delete_func_t</em> <code>delete </code></td> <td>IN: Callback routine called when a property is deleted from a property list</td></tr> <tr> @@ -4766,7 +4988,7 @@ END SUBROUTINE h5pinsert_f <td><em>hid_t</em> <code>plist</code></td> <td>IN: Identifier of the property list</td></tr> <tr> - <td><code>hid_t</code> <em>pclass</em></td> + <td><code>hid_t</code> <em>pclass </em></td> <td>IN: Identifier of the property class</td></tr> </table></ul> @@ -4888,7 +5110,7 @@ END SUBROUTINE h5pisa_class_f <td><em>int *</em> <code>idx</code></td> <td>IN/OUT: Index of the property to begin with</td></tr> <tr> - <td><em>H5P_iterate_t</em> <code>iter_func</code></td> + <td><em>H5P_iterate_t</em> <code>iter_func </code></td> <td>IN: Function pointer to function to be called with each property iterated over</td></tr> <tr> @@ -4948,19 +5170,24 @@ SUBROUTINE pipeline; <code>plist_id</code> must be a dataset creation property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Property list identifier. - <dt><em>H5Z_filter_t</em> <code>filter</code> - <dd>IN: Filter to be modified. - <dt><em>unsigned int</em> <code>flags</code> - <dd>IN: Bit vector specifying certain general properties - of the filter. - <dt><em>size_t</em> <code>cd_nelmts</code> - <dd>IN: Number of elements in <code>cd_values</code>. - <dt><em>const unsigned int</em> <code>cd_values[]</code> - <dd>IN: Auxiliary data for the filter. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5Z_filter_t</em> <code>filter</code></td> + <td valign="top">IN: Filter to be modified.</td></tr> + <tr> + <td valign="top"><em>unsigned int</em> <code>flags</code></td> + <td valign="top">IN: Bit vector specifying certain general properties + of the filter.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>cd_nelmts</code></td> + <td valign="top">IN: Number of elements in <code>cd_values</code>.</td></tr> + <tr> + <td valign="top"><em>const unsigned int</em> <code>cd_values[] </code></td> + <td valign="top">IN: Auxiliary data for the filter.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -5035,6 +5262,7 @@ END SUBROUTINE h5pmodify_filter_f <code>get</code> callbacks are never called. </P> + <P> The <code>create</code> routine is called when a new property list with this property is being created. The <code>H5P_prp_create_func_t</code> callback function is defined @@ -5064,6 +5292,7 @@ END SUBROUTINE h5pmodify_filter_f create routine returns an error value. </P> + <P> The <code>set</code> routine is called before a new value is copied into the property. The <code>H5P_prp_set_func_t</code> callback function is defined @@ -5143,6 +5372,7 @@ END SUBROUTINE h5pmodify_filter_f routine returns an error value. </P> + <P> The <code>delete</code> routine is called when a property is being deleted from a property list. The <code>H5P_prp_delete_func_t</code> callback function is defined @@ -5176,6 +5406,7 @@ END SUBROUTINE h5pmodify_filter_f an error value but the property is still deleted. </P> + <P> The <code>copy</code> routine is called when a new property list with this property is being created through a copy operation. The <code>H5P_prp_copy_func_t</code> callback function is defined @@ -5236,38 +5467,49 @@ END SUBROUTINE h5pmodify_filter_f If the <code>close</code> routine returns a negative value, the property list close routine returns an error value but the property list is still closed. + </P> <dt><strong>Parameters:</strong> - <ul><dl> - <dt><code>hid_t</code> <em>class</em> - <dd>IN: Property list class to register permanent property - within - <dt><code>const char *</code> <em>name</em> - <dd>IN: Name of property to register - <dt><code>size_t</code> <em>size</em> - <dd>IN: Size of property in bytes - <dt><code>void *</code> <em>default</em> - <dd>IN: Default value for property in newly created property - lists - <dt><code>H5P_prp_create_func_t</code> <em>create</em> - <dd>IN: Callback routine called when a property list is being - created and the property value will be initialized - <dt><code>H5P_prp_set_func_t</code> <em>set</em> - <dd>IN: Callback routine called before a new value is copied - into the property's value - <dt><code>H5P_prp_get_func_t</code> <em>get</em> - <dd>IN: Callback routine called when a property value is - retrieved from the property - <dt><code>H5P_prp_delete_func_t</code> <em>delete</em> - <dd>IN: Callback routine called when a property is deleted from - a property list - <dt><code>H5P_prp_copy_func_t</code> <em>copy</em> - <dd>IN: Callback routine called when a property is copied from - a property list - <dt><code>H5P_prp_close_func_t</code> <em>close</em> - <dd>IN: Callback routine called when a property list is being - closed and the property value will be disposed of - </dl></ul> + <ul><table> + <tr> + <td valign="top"><code>hid_t</code> <em>class</em></td> + <td valign="top">IN: Property list class to register permanent property + within</td></tr> + <tr> + <td valign="top"><code>const char *</code> <em>name</em></td> + <td valign="top">IN: Name of property to register</td></tr> + <tr> + <td valign="top"><code>size_t</code> <em>size</em></td> + <td valign="top">IN: Size of property in bytes</td></tr> + <tr> + <td valign="top"><code>void *</code> <em>default</em></td> + <td valign="top">IN: Default value for property in newly created property + lists</td></tr> + <tr> + <td valign="top"><code>H5P_prp_create_func_t</code> <em>create </em></td> + <td valign="top">IN: Callback routine called when a property list is being + created and the property value will be initialized</td></tr> + <tr> + <td valign="top"><code>H5P_prp_set_func_t</code> <em>set</em></td> + <td valign="top">IN: Callback routine called before a new value is copied + into the property's value</td></tr> + <tr> + <td valign="top"><code>H5P_prp_get_func_t</code> <em>get</em></td> + <td valign="top">IN: Callback routine called when a property value is + retrieved from the property</td></tr> + <tr> + <td valign="top"><code>H5P_prp_delete_func_t</code> <em>delete</em></td> + <td valign="top">IN: Callback routine called when a property is deleted from + a property list</td></tr> + <tr> + <td valign="top"><code>H5P_prp_copy_func_t</code> <em>copy</em></td> + <td valign="top">IN: Callback routine called when a property is copied from + a property list</td></tr> + <tr> + <td valign="top"><code>H5P_prp_close_func_t</code> <em>close</em></td> + <td valign="top">IN: Callback routine called when a property list is being + closed and the property value will be disposed of</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Success: a non-negative value @@ -5337,7 +5579,7 @@ END SUBROUTINE h5pregister_f <td><em>hid_t</em> <code>plid</code></td> <td>IN: Identifier of the property list to modify</td></tr> <tr> - <td><em>const char *</em><code>name</code></td> + <td><em>const char *</em><code>name </code></td> <td>IN: Name of property to remove</td></tr> </table></ul> @@ -5367,108 +5609,6 @@ END SUBROUTINE h5premove_f <!-- NEW PAGE --> -<!-- HEADER RIGHT "H5Premove_filter" --> -<hr> -<dl> - <dt><strong>Name:</strong> <a name="Property-RemoveFilter">H5Premove_filter</a> - <dt><strong>Signature:</strong> - <dd><em>herr_t</em> <code>H5Premove_filter</code>(<em>hid_t</em> <code>plist</code>, - <em>H5Z_filter_t</em> <code>filter</code> - ) - <dt><strong>Purpose:</strong> - <dd>Delete one or more filters in the filter pipeline. - <dt><strong>Description:</strong> - <dd><code>H5Premove_filter</code> removes the specified - <code>filter</code> from the filter pipeline in the - dataset creation property list <code>plist</code>. - <p> - The <code>filter</code> parameter specifies the filter to be removed. - Valid values for use in <code>filter</code> are as follows: - - <center> - <table width=75%> - <tr valign=top align=left><td> - <code>H5Z_FILTER_ALL</code> - </td><td> - Removes all filters from the permanent filter pipeline. - </td></tr> - <tr valign=top align=left><td> - <code>H5Z_FILTER_DEFLATE</code> - </td><td> - Data compression filter, employing the gzip algorithm - </td></tr> - <tr valign=top align=left><td> - <code>H5Z_FILTER_SHUFFLE</code> - </td><td> - Data shuffling filter - </td></tr> - <tr valign=top align=left><td> - <code>H5Z_FILTER_FLETCHER32 </code> - </td><td> - Error detection filter, employing the Fletcher32 checksum algorithm - </td></tr> - <tr valign=top align=left><td> - <code>H5Z_FILTER_SZIP</code> - </td><td> - Data compression filter, employing the SZIP algorithm - </td></tr> - </table> - </center> - <p> - Additionally, user-defined filters can be removed with this routine - by passing the filter identifier with which they were registered - with the HDF5 Library. - <p> - Attempting to remove a filter that is not in the permanent filter - pipeline is an error. - <dt><strong>Note:</strong> - <dd>This function currently supports only the permanent filter - pipeline; <code>plist</code> must be a dataset creation - property list. - <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Dataset creation property list identifier. - <dt><em>H5Z_filter_t</em> <code>filter</code> - <dd>IN: Filter to be deleted. - </dl> - <dt><strong>Returns:</strong> - <dd>Returns a non-negative value if successful; - otherwise returns a negative value. - - <dt><strong>Fortran90 Interface:</strong> h5premove_filter_f - <dd> - <pre> -SUBROUTINE h5premove_filter_f(prp_id, filter, hdferr) - - IMPLICIT NONE - INTEGER(HID_T), INTENT(IN) :: prp_id ! Dataset creation property - ! list identifier - INTEGER, INTENT(IN) :: filter ! Filter to be removed - ! Valid values are: - ! H5Z_FILTER_ALL_F - ! H5Z_FILTER_DEFLATE_F - ! H5Z_FILTER_SHUFFLE_F - ! H5Z_FILTER_FLETCHER32_F - ! H5Z_FILTER_SZIP_F - !</pre> -<!-- NEW PAGE --> -<pre> - INTEGER, INTENT(OUT) :: hdferr ! Error code - ! 0 on success, -1 on failure -END SUBROUTINE h5premove_filter_f - </pre> - - <!--<dt><strong>Non-C API(s):</strong> - <dd> - - <img src="Graphics/Java.gif"> - <img src="Graphics/C++.gif"> - --> -</dl> - - -<!-- NEW PAGE --> <!-- HEADER RIGHT "H5Pset" --> <hr> <dl> @@ -5512,7 +5652,7 @@ END SUBROUTINE h5premove_filter_f <td><em>hid_t</em> <code>plid</code>; <td>IN: Property list identifier to modify</td></tr> <tr> - <td><em>const char *</em><code>name</code>; + <td><em>const char *</em><code>name; </code> <td>IN: Name of property to modify</td></tr> <tr> <td><em>void *</em><code>value</code>; @@ -5579,19 +5719,20 @@ END SUBROUTINE h5pset_f For MPI-IO and other parallel systems, choose an alignment which is a multiple of the disk block size. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for a file access property list. - <dt><em>hsize_t</em> <code>threshold</code> - <dd>IN: Threshold value. - Must be non-negative. + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier for a file access property list.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>threshold </code></td> + <td valign="top">IN: Threshold value. Note that setting the threshold value to 0 (zero) has the effect of a special case, forcing everything - to be aligned. - <dt><em>hsize_t</em> <code>alignment</code> - <dd>IN: Alignment value. - Must be a positive value. - </dl> + to be aligned.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>alignment</code></td> + <td valign="top">IN: Alignment value.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -5676,12 +5817,14 @@ END SUBROUTINE h5pset_alignment_f See <a href="RM_H5D.html#Dataset-Create">H5Dcreate</a> for further cross-references. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Dataset creation property list identifier. - <dt><em>H5D_alloc_time_t</em> <code>alloc_time</code> - <dd>IN: When to allocate dataset storage space. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5D_alloc_time_t</em> <code>alloc_time </code></td> + <td valign="top">IN: When to allocate dataset storage space.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -5743,16 +5886,20 @@ END SUBROUTINE h5pset_alloc_time_f <p> All ratios are real numbers between 0 and 1, inclusive. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: The dataset transfer property list identifier. - <dt><em>double</em> <code>left</code> - <dd>IN: The B-tree split ratio for left-most nodes. - <dt><em>double</em> <code>right</code> - <dd>IN: The B-tree split ratio for right-most nodes and lone nodes. - <dt><em>double</em> <code>middle</code> - <dd>IN: The B-tree split ratio for all other nodes. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: The dataset transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>double</em> <code>left</code></td> + <td valign="top">IN: The B-tree split ratio for left-most nodes.</td></tr> + <tr> + <td valign="top"><em>double</em> <code>right</code></td> + <td valign="top">IN: The B-tree split ratio for right-most nodes and lone nodes.</td></tr> + <tr> + <td valign="top"><em>double</em> <code>middle </code></td> + <td valign="top">IN: The B-tree split ratio for all other nodes.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -5818,16 +5965,20 @@ END SUBROUTINE h5pset_btree_ratios_f <p> The default value for the maximum buffer is 1 Mb. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for the dataset transfer property list. - <dt><em>hsize_t</em> <code>size</code> - <dd>IN: Size, in bytes, of the type conversion and background buffers. - <dt><em>void</em> <code>tconv</code> - <dd>IN: Pointer to application-allocated type conversion buffer. - <dt><em>void</em> <code>bkg</code> - <dd>IN: Pointer to application-allocated background buffer. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier for the dataset transfer property list.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>size </code></td> + <td valign="top">IN: Size, in bytes, of the type conversion and background buffers.</td></tr> + <tr> + <td valign="top"><em>void</em> <code>tconv</code></td> + <td valign="top">IN: Pointer to application-allocated type conversion buffer.</td></tr> + <tr> + <td valign="top"><em>void</em> <code>bkg</code></td> + <td valign="top">IN: Pointer to application-allocated background buffer.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -5889,18 +6040,23 @@ END SUBROUTINE h5pset_buffer_f preemption is strictly LRU) while a value of one means fully read chunks are always preempted before other chunks. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Identifier of the file access property list. - <dt><em>int</em> <code>mdc_nelmts</code> - <dd>IN: Number of elements (objects) in the meta data cache. - <dt><em>int</em> <code>rdcc_nelmts</code> - <dd>IN: Number of elements (objects) in the raw data chunk cache. - <dt><em>size_t</em> <code>rdcc_nbytes</code> - <dd>IN: Total size of the raw data chunk cache, in bytes. - <dt><em>double</em> <code>rdcc_w0</code> - <dd>IN: Preemption policy. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Identifier of the file access property list.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>mdc_nelmts</code></td> + <td valign="top">IN: Number of elements (objects) in the meta data cache.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>rdcc_nelmts</code></td> + <td valign="top">IN: Number of elements (objects) in the raw data chunk cache.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>rdcc_nbytes </code></td> + <td valign="top">IN: Total size of the raw data chunk cache, in bytes.</td></tr> + <tr> + <td valign="top"><em>double</em> <code>rdcc_w0</code></td> + <td valign="top">IN: Preemption policy.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -5955,19 +6111,22 @@ END SUBROUTINE h5pset_cache_f The unit of measure for <code>dim</code> values is <em>dataset elements</em>. <p> - As a side-effect of this function, the layout of the dataset - is changed to <code>H5D_CHUNKED</code>, if it is not already so set. + As a side-effect of this function, the layout of the dataset is + changed to <code>H5D_CHUNKED</code>, if it is not already so set. (See <a href="#Property-SetLayout"><code>H5Pset_layout</code></a>.) <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for property list to query. - <dt><em>int</em> <code>ndims</code> - <dd>IN: The number of dimensions of each chunk. - <dt><em>const hsize_t *</em> <code>dim</code> - <dd>IN: An array defining the size, in dataset elements, - of each chunk. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier for property list to query.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>ndims</code></td> + <td valign="top">IN: The number of dimensions of each chunk.</td></tr> + <tr> + <td valign="top"><em>const hsize_t *</em> <code>dim </code></td> + <td valign="top">IN: An array defining the size, in dataset elements, + of each chunk.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -6013,12 +6172,14 @@ END SUBROUTINE h5pset_chunk_f Lower compression levels are faster but result in less compression. This is the same algorithm as used by the GNU gzip program. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for the dataset creation property list. - <dt><em>int</em> <code>level</code> - <dd>IN: Compression level. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier for the dataset creation property list.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>level</code></td> + <td valign="top">IN: Compression level.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -6117,12 +6278,14 @@ END SUBROUTINE h5pset_deflate_f </dl> </dir></p> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dxpl_id</code> - <dd>IN: Data transfer property list identifier. - <dt><em>H5FD_mpio_xfer_t</em> <code>xfer_mode</code> - <dd>IN: Transfer mode. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dxpl_id</code></td> + <td valign="top">IN: Data transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5FD_mpio_xfer_t</em> <code>xfer_mode </code></td> + <td valign="top">IN: Transfer mode.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -6169,12 +6332,14 @@ END SUBROUTINE h5pset_dxpl_mpio_f <code>H5Pset_dxpl_multi</code> can only be used after the member map has been set with <code>H5Pset_fapl_multi</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dxpl_id</code>, - <dd>IN: Data transfer property list identifier. - <dt><em>const hid_t *</em><code>memb_dxpl</code> - <dd>IN: Array of data access property lists. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dxpl_id</code>,</td> + <td valign="top">IN: Data transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>const hid_t *</em><code>memb_dxpl </code></td> + <td valign="top">IN: Array of data access property lists.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -6229,13 +6394,15 @@ SUBROUTINE <dd>The initial error detection implementation, Fletcher32 checksum, supports error detection for chunked datasets only. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Dataset transfer property list identifier. - <dt><em>H5Z_EDC_t</em> <code>check</code> - <dd>IN: Specifies whether error checking is enabled or disabled - for dataset read operations. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Dataset transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5Z_EDC_t</em> <code>check </code></td> + <td valign="top">IN: Specifies whether error checking is enabled or disabled + for dataset read operations.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -6296,8 +6463,8 @@ END SUBROUTINE h5pset_edc_check_f The <code>size</code> argument specifies the number of bytes reserved for data in the external file. If <code>size</code> is set to <code>H5F_UNLIMITED</code>, the - external file can be of unlimited size and no more files can be added to - the external files list. + external file can be of unlimited size and no more files can be added + to the external files list. <p> All of the external files for a given dataset must be specified with <code>H5Pset_external</code> @@ -6307,17 +6474,21 @@ END SUBROUTINE h5pset_edc_check_f <code>H5Dwrite</code> is called to write data to it, the library will create the file. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of a dataset creation property list. - <dt><em>const char</em> <code>*name</code> - <dd>IN: Name of an external file. - <dt><em>off_t</em> <code>offset</code> - <dd>IN: Offset, in bytes, from the beginning of the file - to the location in the file where the data starts. - <dt><em>hsize_t</em> <code>size</code> - <dd>IN: Number of bytes reserved in the file for the data. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier of a dataset creation property list.</td></tr> + <tr> + <td valign="top"><em>const char</em> <code>*name </code></td> + <td valign="top">IN: Name of an external file.</td></tr> + <tr> + <td valign="top"><em>off_t</em> <code>offset</code></td> + <td valign="top">IN: Offset, in bytes, from the beginning of the file + to the location in the file where the data starts.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>size</code></td> + <td valign="top">IN: Number of bytes reserved in the file for the data.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -6378,12 +6549,14 @@ END SUBROUTINE h5pset_external_f Use of this function is only appropriate for an HDF5 file written as a family of files with the <code>FAMILY</code> file driver. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>hsize_t</em> <code>offset</code> - <dd>IN: Offset in bytes within the HDF5 file. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>offset </code></td> + <td valign="top">IN: Offset in bytes within the HDF5 file.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -6443,15 +6616,18 @@ END SUBROUTINE h5pset_family_offset_f <dd>There is currently no means for reading a file from disk then using the <code>H5FD_CORE</code> driver to manipulate the file. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>size_t</em> <code>increment</code> - <dd>IN: Size, in bytes, of memory increments. - <dt><em>hbool_t</em> <code>backing_store</code> - <dd>IN: Boolean flag indicating whether to write the file - contents to disk when the file is closed. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>increment</code></td> + <td valign="top">IN: Size, in bytes, of memory increments.</td></tr> + <tr> + <td valign="top"><em>hbool_t</em> <code>backing_store </code></td> + <td valign="top">IN: Boolean flag indicating whether to write the file + contents to disk when the file is closed.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -6502,15 +6678,18 @@ END SUBROUTINE h5pset_fapl_core_f <code>memb_fapl_id</code> is the identifier of the file access property list to be used for each family member. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em> hsize_t</em> <code>memb_size</code> - <dd>IN: Size in bytes of each file member. - <dt><em>hid_t</em> <code>memb_fapl_id</code> - <dd>IN: Identifier of file access property list for each - family member. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em> hsize_t</em> <code>memb_size</code></td> + <td valign="top">IN: Size in bytes of each file member.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>memb_fapl_id </code></td> + <td valign="top">IN: Identifier of file access property list for each + family member.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -6570,12 +6749,14 @@ END SUBROUTINE h5pset_fapl_family_f For further information, see <a href="http://www.globus.org/">http//www.globus.org/</a>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code>, - <dd>IN: File access property list identifier. - <dt><em>GASS_Info</em> <code>info</code> - <dd>IN: Pointer to the GASS information structure. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code>,</td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>GASS_Info</em> <code>info </code></td> + <td valign="top">IN: Pointer to the GASS information structure.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -6740,6 +6921,7 @@ SUBROUTINE <code>(H5FD_LOG_NUM_READ | H5FD_LOG_NUM_WRITE | H5FD_LOG_NUM_SEEK)</code> </td></tr> +<!-- NEW PAGE --> <tr valign=top align=left><td> <hr> <code>H5FD_LOG_TIME_OPEN</code> @@ -6839,16 +7021,20 @@ SUBROUTINE which must be at least the size in bytes of the file to be logged. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>char *</em><code>logfile</code> - <dd>IN: Name of the log file. - <dt><em>unsigned int</em> <code>flags</code> - <dd>IN: Flags specifying the types of logging activity. - <dt><em>size_t</em> <code>buf_size</code> - <dd>IN: The size of the logging buffer. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>char *</em><code>logfile</code></td> + <td valign="top">IN: Name of the log file.</td></tr> + <tr> + <td valign="top"><em>unsigned int</em> <code>flags </code></td> + <td valign="top">IN: Flags specifying the types of logging activity.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>buf_size</code></td> + <td valign="top">IN: The size of the logging buffer.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns non-negative if successful. Otherwise returns negative. @@ -6907,14 +7093,17 @@ SUBROUTINE Users should not modify the info while it is defined in a property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>MPI_Comm</em> <code>comm</code> - <dd>IN: MPI-2 communicator. - <dt><em>MPI_Info</em> <code>info</code> - <dd>IN: MPI-2 info object. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>MPI_Comm</em> <code>comm </code></td> + <td valign="top">IN: MPI-2 communicator.</td></tr> + <tr> + <td valign="top"><em>MPI_Info</em> <code>info</code></td> + <td valign="top">IN: MPI-2 info object.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -6973,12 +7162,14 @@ END SUBROUTINE h5pset_fapl_mpio_f Users should not modify the communicator while it is defined in a property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>MPI_Comm</em> <code>comm</code> - <dd>IN: MPI-2 communicator. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>MPI_Comm</em> <code>comm </code></td> + <td valign="top">IN: MPI-2 communicator.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -7087,30 +7278,36 @@ END SUBROUTINE h5pset_fapl_mpiposix_f <code>l</code> for <code>H5FD_MEM_LHEAP</code> <br> <code>o</code> for <code>H5FD_MEM_OHDR</code> - </dir> + </dir></dd></dt> <!-- NEW PAGE --> <dt><code>memb_addr</code> <dd>The default value is <code>HADDR_UNDEF</code> for each element. </dl> </dir> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>const H5FD_mem_t *</em><code>memb_map</code> - <dd>IN: Maps memory usage types to other memory usage types. - <dt><em>const hid_t *</em><code>memb_fapl</code> - <dd>IN: Property list for each memory usage type. - <dt><em>const char * const *</em><code>memb_name</code> - <dd>IN: Name generator for names of member files. - <dt><em>const haddr_t *</em><code>memb_addr</code> - <dd>IN: The offsets within the virtual address space, + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>const H5FD_mem_t *</em><code>memb_map </code></td> + <td valign="top">IN: Maps memory usage types to other memory usage types.</td></tr> + <tr> + <td valign="top"><em>const hid_t *</em><code>memb_fapl</code></td> + <td valign="top">IN: Property list for each memory usage type.</td></tr> + <tr> + <td valign="top"><em>const char * const *</em><code>memb_name</code></td> + <td valign="top">IN: Name generator for names of member files.</td></tr> + <tr> + <td valign="top"><em>const haddr_t *</em><code>memb_addr</code></td> + <td valign="top">IN: The offsets within the virtual address space, from <code>0</code> (zero) to <code>HADDR_MAX</code>, - at which each type of data storage begins. - <dt><em>hbool_t</em> <code>relax</code> - <dd>IN: Allows read-only access to incomplete file sets - when <code>TRUE</code>. - </dl> + at which each type of data storage begins.</td></tr> + <tr> + <td valign="top"><em>hbool_t</em> <code>relax</code></td> + <td valign="top">IN: Allows read-only access to incomplete file sets + when <code>TRUE</code>.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -7147,7 +7344,7 @@ END SUBROUTINE h5pset_fapl_mpiposix_f <dt><strong>Fortran90 Interface:</strong> h5pset_fapl_multi_f <dd> <pre> -SUBROUTINE h5pset_fapl_multi_f(prp_id, memb_map, memb_fapl, memb_name, & +SUBROUTINE h5pset_fapl_multi_f(prp_id, memb_map, memb_fapl, memb_name, memb_addr, relax, hdferr) IMPLICIT NONE INTEGER(HID_T),INTENT(IN) :: prp_id ! Property list identifier @@ -7188,10 +7385,11 @@ END SUBROUTINE h5pset_fapl_multi_f <dd><code>H5Pset_fapl_sec2</code> modifies the file access property list to use the <code>H5FD_SEC2</code> driver. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id </code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -7265,19 +7463,23 @@ END SUBROUTINE h5pset_fapl_sec2_f HDF5 provides no mechanism to determine whether it was called as the special case invoked by <code>H5Pset_fapl_split</code>. <dt><strong>Parameters:</strong> - <dl> - <dt> - <dt><em>hid_t</em> <code>fapl_id</code>, - <dd>IN: File access property list identifier. - <dt><em>const char *</em><code>meta_ext</code>, - <dd>IN: Metadata filename extension. - <dt><em>hid_t</em> <code>meta_plist_id</code>, - <dd>IN: File access property list identifier for the metadata file. - <dt><em>const char *</em><code>raw_ext</code>, - <dd>IN: Raw data filename extension. - <dt><em>hid_t</em> <code>raw_plist_id</code> - <dd>IN: File access property list identifier for the raw data file. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code>,</td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>const char *</em><code>meta_ext, </code></td> + <td valign="top">IN: Metadata filename extension.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>meta_plist_id</code>,</td> + <td valign="top">IN: File access property list identifier for the metadata file.</td></tr> + <tr> + <td valign="top"><em>const char *</em><code>raw_ext</code>,</td> + <td valign="top">IN: Raw data filename extension.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>raw_plist_id</code></td> + <td valign="top">IN: File access property list identifier for the raw data file.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -7356,12 +7558,14 @@ END SUBROUTINE h5pset_fapl_split_f Storage Resource Broker (SRB). For further information, see <a href="http://www.npaci.edu/Research/DI/srb/">http//www.npaci.edu/Research/DI/srb/</a>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>SRB_Info</em> <code>info</code> - <dd>IN: Pointer to the SRB information structure. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id </code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>SRB_Info</em> <code>info</code></td> + <td valign="top">IN: Pointer to the SRB information structure.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -7396,10 +7600,11 @@ SUBROUTINE <dd><code>H5Pset_fapl_stdio</code> modifies the file access property list to use the standard I/O driver, <code>H5FD_STDIO</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id </code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -7484,12 +7689,14 @@ END SUBROUTINE h5pset_fapl_stdio_f <code>H5Pset_fapl_stream</code> and <code>H5Pget_fapl_stream</code> are not intended for use in a parallel environment. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>H5FD_stream_fapl_t *</em><code>fapl</code> - <dd>IN: The streaming I/O file access property list. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5FD_stream_fapl_t *</em><code>fapl </code></td> + <td valign="top">IN: The streaming I/O file access property list.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -7562,13 +7769,15 @@ SUBROUTINE </table> </div> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>H5F_close_degree_t</em> <code>fc_degree</code> - <dd>IN: Pointer to a location containing the file close degree property, - the value of <code>fc_degree</code>. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5F_close_degree_t</em> <code>fc_degree </code></td> + <td valign="top">IN: Pointer to a location containing the file close degree property, + the value of <code>fc_degree</code>.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -7639,12 +7848,14 @@ END SUBROUTINE h5pset_fclose_degree_f See <a href="RM_H5D.html#Dataset-Create">H5Dcreate</a> for further cross-references. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Dataset creation property list identifier. - <dt><em>H5D_fill_time_t</em> <code>fill_time</code> - <dd>IN: When to write fill values to a dataset. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5D_fill_time_t</em> <code>fill_time </code></td> + <td valign="top">IN: When to write fill values to a dataset.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -7730,14 +7941,17 @@ END SUBROUTINE h5pset_fill_time_f See <a href="RM_H5D.html#Dataset-Create">H5Dcreate</a> for further cross-references. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Dataset creation property list identifier. - <dt><em>hid_t</em> <code>type_id</code>, - <dd>IN: Datatype of <code>value</code>. - <dt><em>const void *</em><code>value</code> - <dd>IN: Pointer to buffer containing value to use as fill value. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code>,</td> + <td valign="top">IN: Datatype of <code>value</code>.</td></tr> + <tr> + <td valign="top"><em>const void *</em><code>value </code></td> + <td valign="top">IN: Pointer to buffer containing value to use as fill value.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -7857,20 +8071,25 @@ END SUBROUTINE h5pset_fill_value_f If multiple filters are set for a property list, they will be applied to each chunk in the order in which they were set. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Property list identifier. - <dt><em>H5Z_filter_t</em> <code>filter</code> - <dd>IN: Filter identifier - for the filter to be added to the pipeline. - <dt><em>unsigned int</em> <code>flags</code> - <dd>IN: Bit vector specifying certain general properties - of the filter. - <dt><em>size_t</em> <code>cd_nelmts</code> - <dd>IN: Number of elements in <code>cd_values</code>. - <dt><em>const unsigned int</em> <code>cd_values[]</code> - <dd>IN: Auxiliary data for the filter. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5Z_filter_t</em> <code>filter</code></td> + <td valign="top">IN: Filter identifier for the filter + to be added to the pipeline.</td></tr> + <tr> + <td valign="top"><em>unsigned int</em> <code>flags</code></td> + <td valign="top">IN: Bit vector specifying certain general properties + of the filter.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>cd_nelmts</code></td> + <td valign="top">IN: Number of elements in <code>cd_values</code>.</td></tr> + <tr> + <td valign="top"><em>const unsigned int</em> <code>cd_values[] </code></td> + <td valign="top">IN: Auxiliary data for the filter.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -7940,14 +8159,17 @@ END SUBROUTINE h5pset_filter_f Valid callback function return values are <code>H5Z_CB_FAIL</code> and <code>H5Z_CB_CONT</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Dataset transfer property list identifier. - <dt><em>H5Z_filter_func_t</em> <code>func</code> - <dd>IN: User-defined filter callback function. - <dt><em>void *</em><code>op_data</code> - <dd>IN: User-defined input data for the callback function. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Dataset transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5Z_filter_func_t</em> <code>func </code></td> + <td valign="top">IN: User-defined filter callback function.</td></tr> + <tr> + <td valign="top"><em>void *</em><code>op_data</code></td> + <td valign="top">IN: User-defined input data for the callback function.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -7983,10 +8205,11 @@ SUBROUTINE <dd>The initial error detection implementation supports error detection for chunked datasets only. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Dataset creation property list identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -8037,13 +8260,15 @@ END SUBROUTINE h5pset_fletcher32_f <p> The default value for garbage collecting references is off. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: File access property list identifier. - <dt><em>unsigned</em> <code>gc_ref</code> - <dd>IN: Flag setting reference garbage collection to - on (<code>1</code>) or off (<code>0</code>). - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>unsigned</em> <code>gc_ref </code></td> + <td valign="top">IN: Flag setting reference garbage collection to + on (<code>1</code>) or off (<code>0</code>).</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -8180,14 +8405,15 @@ END SUBROUTINE h5pset_hyper_cache_f but the library will use more memory during hyperslab I/O. The default value of <code>vector_size</code> is <code>1024</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dxpl_id</code> - <dd>IN: Dataset transfer property list identifier. - <dt><em>size_t</em> <code>vector_size</code> - <dd>IN: Number of I/O vectors to accumulate in memory for I/O operations. - Must be greater than <code>1</code> (one). - Default value: <code>1024</code>. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dxpl_id</code></td> + <td valign="top">IN: Dataset transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>vector_size </code></td> + <td valign="top">IN: Number of I/O vectors to accumulate in memory for I/O operations. + Must be greater than <code>1</code> (one). Default value: <code>1024</code>.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -8219,7 +8445,7 @@ END SUBROUTINE h5pset_hyper_vector_size_f <dt><strong>Name:</strong> <a name="Property-SetIstoreK">H5Pset_istore_k</a> <dt><strong>Signature:</strong> <dd><em>herr_t </em><code>H5Pset_istore_k</code>(<em>hid_t</em> <code>plist</code>, - <em>int</em> <code>ik</code> + <em>unsigned</em> <code>ik</code> ) <dt><strong>Purpose:</strong> <dd>Sets the size of the parameter used to control the @@ -8234,12 +8460,14 @@ END SUBROUTINE h5pset_hyper_vector_size_f or have an average rank of 1.5 times the value of <code>ik</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of property list to query. - <dt><em>int</em> <code>ik</code> - <dd>IN: 1/2 rank of chunked storage B-tree. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier of property list to query.</td></tr> + <tr> + <td valign="top"><em>unsigned</em> <code>ik</code></td> + <td valign="top">IN: 1/2 rank of chunked storage B-tree.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -8299,12 +8527,14 @@ END SUBROUTINE h5pset_istore_k_f <a href="RM_H5D.html#Dataset-Write">H5Dwrite</a> documentation for details. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of property list to query. - <dt><em>H5D_layout_t</em> <code>layout</code> - <dd>IN: Type of storage layout for raw data. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier of property list to query.</td></tr> + <tr> + <td valign="top"><em>H5D_layout_t</em> <code>layout </code></td> + <td valign="top">IN: Type of storage layout for raw data.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -8366,12 +8596,14 @@ END SUBROUTINE h5pset_layout_f potentially significantly improving library and application performance. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>hsize_t</em> <code>size</code> - <dd>IN: Minimum size, in bytes, of metadata block allocations. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id </code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>size</code></td> + <td valign="top">IN: Minimum size, in bytes, of metadata block allocations.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -8463,12 +8695,14 @@ END SUBROUTINE h5pset_meta_block_size_f Use of this function is only appropriate for an HDF5 file written as a set of files with the <code>MULTI</code> file driver. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list or data transfer property list identifier. - <dt><em>H5FD_mem_t</em> <code>type</code> - <dd>OUT: Type of data. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list or data transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5FD_mem_t</em> <code>type </code></td> + <td valign="top">OUT: Type of data.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -8509,13 +8743,15 @@ SUBROUTINE property to TRUE. Otherwise the I/O pipeline treats the destination datapoints as completely uninitialized. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for the dataset transfer property list. - <dt><em>hbool_t</em> <code>status</code> - <dd>IN: Status of for the dataset transfer property list - (TRUE/FALSE). - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier for the dataset transfer property list.</td></tr> + <tr> + <td valign="top"><em>hbool_t</em> <code>status </code></td> + <td valign="top">IN: Status of for the dataset transfer property list + (TRUE/FALSE).</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -8578,10 +8814,11 @@ END SUBROUTINE h5pset_preserve_f achieved by the use of a compression filter without the shuffle filter. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Dataset creation property list identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id </code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -8631,12 +8868,14 @@ END SUBROUTINE h5pset_shuffle_f Setting the value to 0 with this API function will turn off the data sieving, even if the VFL driver attempts to use that strategy. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>hsize_t</em> <code>size</code> - <dd>IN: Maximum size, in bytes, of data sieve buffer. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id </code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>size</code></td> + <td valign="top">IN: Maximum size, in bytes, of data sieve buffer.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -8675,22 +8914,26 @@ END SUBROUTINE h5pset_sieve_buf_size_f <dd>Sets the byte size of the offsets and lengths used to address objects in an HDF5 file. <dt><strong>Description:</strong> - <dd><code>H5Pset_sizes</code> sets the byte size of the offsets and lengths used to - address objects in an HDF5 file. This function is only valid for - file creation property lists. Passing in a value of 0 for one of the - sizeof parameters retains the current value. The default value - for both values is the same as <code>sizeof(hsize_t)</code> - in the library (normally 8 bytes). + <dd><code>H5Pset_sizes</code> sets the byte size of the offsets + and lengths used to address objects in an HDF5 file. + This function is only valid for file creation property lists. + Passing in a value of 0 for one of the <code>sizeof_...</code> + parameters retains the current value. + The default value for both values is the same as + <code>sizeof(hsize_t)</code> in the library (normally 8 bytes). Valid values currently are 2, 4, 8 and 16. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of property list to modify. - <dt><em>size_t</em> <code>sizeof_addr</code> - <dd>IN: Size of an object offset in bytes. - <dt><em>size_t</em> <code>sizeof_size</code> - <dd>IN: Size of an object length in bytes. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier of property list to modify.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>sizeof_addr </code></td> + <td valign="top">IN: Size of an object offset in bytes.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>sizeof_size</code></td> + <td valign="top">IN: Size of an object length in bytes.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -8756,14 +8999,16 @@ END SUBROUTINE h5pset_sizes_f Setting <code>size</code> to zero (<code>0</code>) disables the small data block mechanism. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier . - <dt><em>hsize_t</em> <code>size</code> - <dd>IN: Maximum size, in bytes, of the small data block. + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id </code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>size</code></td> + <td valign="top">IN: Maximum size, in bytes, of the small data block. <br> - The default size is <code>2048</code>. - </dl> + The default size is <code>2048</code>.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise a negative value. @@ -8795,8 +9040,8 @@ END SUBROUTINE h5pset_small_data_block_size_f <dt><strong>Name:</strong> <a name="Property-SetSymK">H5Pset_sym_k</a> <dt><strong>Signature:</strong> <dd><em>herr_t </em><code>H5Pset_sym_k</code>(<em>hid_t</em> <code>plist</code>, - <em>int</em> <code>ik</code>, - <em>int</em> <code>lk</code> + <em>unsigned</em> <code>ik</code>, + <em>unsigned</em> <code>lk</code> ) <dt><strong>Purpose:</strong> <dd>Sets the size of parameters used to control the symbol table nodes. @@ -8819,14 +9064,17 @@ END SUBROUTINE h5pset_small_data_block_size_f contain 1.5 times the number of symbols specified by <code>lk</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for property list to query. - <dt><em>int</em> <code>ik</code> - <dd>IN: Symbol table tree rank. - <dt><em>int</em> <code>lk</code> - <dd>IN: Symbol table node size. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier for property list to query.</td></tr> + <tr> + <td valign="top"><em>unsigned</em> <code>ik</code></td> + <td valign="top">IN: Symbol table tree rank.</td></tr> + <tr> + <td valign="top"><em>unsigned</em> <code>lk</code></td> + <td valign="top">IN: Symbol table node size.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -8988,21 +9236,23 @@ END SUBROUTINE h5pset_sym_k_f <code>H5Zget_filter_info</code></a> can be employed to avoid such a failure. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Dataset creation property list identifier. - <dt><em>unsigned int</em> <code>options_mask</code> - <dd>IN: A bit-mask conveying the desired SZIP options. + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Dataset creation property list + identifier.</td></tr> + <tr> + <td valign="top"><em>unsigned int</em> <code>options_mask</code></td> + <td valign="top">IN: A bit-mask conveying the desired SZIP options. Valid values are <code>H5_SZIP_EC_OPTION_MASK</code> - and <code>H5_SZIP_NN_OPTION_MASK</code>. - <dt><em>unsigned int</em> <code>pixels_per_block</code> - <dd>IN: The number of pixels, or data elements, - in each data block. - </dl> + and <code>H5_SZIP_NN_OPTION_MASK</code>.</td></tr> + <tr> + <td valign="top"><em>unsigned int</em> <code>pixels_per_block </code></td> + <td valign="top">IN: The number of pixels or data elements in each data block.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. - <dt><strong>Notes:</strong> <dd>The following notes are of interest primarily to those who have used SZIP compression outside of the HDF5 context. @@ -9178,12 +9428,14 @@ END SUBROUTINE h5pset_szip_f The default user block size is 0; it may be set to any power of 2 equal to 512 or greater (512, 1024, 2048, etc.). <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of property list to modify. - <dt><em>hsize_t</em> <code>size</code> - <dd>IN: Size of the user-block in bytes. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier of property list to modify.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>size </code></td> + <td valign="top">IN: Size of the user-block in bytes.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -9262,26 +9514,31 @@ END SUBROUTINE h5pset_userblock_f and the <code>alloc_info</code> and <code>free_info</code> parameters are ignored. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for the dataset transfer property list. - <dt><em>H5MM_allocate_t</em> <code>alloc</code> - <dd>IN: User's allocate routine, or <code> NULL</code> - for system <code> malloc</code>. - <dt><em>void</em> *<code>alloc_info</code> - <dd>IN: Extra parameter for user's allocation routine. + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier for the dataset transfer property list.</td></tr> + <tr> + <td valign="top"><em>H5MM_allocate_t</em> <code>alloc </code></td> + <td valign="top">IN: User's allocate routine, or <code> NULL</code> + for system <code> malloc</code>.</td></tr> + <tr> + <td valign="top"><em>void</em> *<code>alloc_info</code></td> + <td valign="top">IN: Extra parameter for user's allocation routine. <br> Contents are ignored if preceding parameter is - <code> NULL</code>. - <dt><em>H5MM_free_t</em> <code>free</code> - <dd>IN: User's free routine, or <code> NULL</code> - for system <code>free</code>. - <dt><em>void</em> *<code>free_info</code> - <dd>IN: Extra parameter for user's free routine. + <code> NULL</code>.</td></tr> + <tr> + <td valign="top"><em>H5MM_free_t</em> <code>free</code></td> + <td valign="top">IN: User's free routine, or <code> NULL</code> + for system <code>free</code>.</td></tr> + <tr> + <td valign="top"><em>void</em> *<code>free_info</code></td> + <td valign="top">IN: Extra parameter for user's free routine. <br> Contents are ignored if preceding parameter is - <code> NULL</code>. - </dl> + <code> NULL</code>.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -9328,7 +9585,7 @@ SUBROUTINE <dt><strong>Parameters:</strong> <ul><table> <tr> - <td><em>H5P_class_t</em> <code>class</code></td> + <td><em>H5P_class_t</em> <code>class </code></td> <td>IN: Property list class from which to remove permanent property</td></tr> <tr> diff --git a/doc/html/RM_H5R.html b/doc/html/RM_H5R.html index b1c4f6b..646816e 100644 --- a/doc/html/RM_H5R.html +++ b/doc/html/RM_H5R.html @@ -76,6 +76,28 @@ to specific objects and data regions in an HDF5 file. <p> <strong>The C Interfaces:</strong> +<table border=0 width=80%> +<tr><td valign=top width=40%> +<ul> + <li><a href="#Reference-Create">H5Rcreate</a> + <li><a href="#Reference-Dereference">H5Rdereference</a> +</ul> +</td><td valign=top width=40%> +<ul> + <li><a href="#Reference-GetRegion">H5Rget_region</a> + <li><a href="#Reference-GetObjType">H5Rget_obj_type</a> +</ul> +</td><td valign=top width=20%> +<ul> + +</ul> +</td></tr> +</table> + +<p> + +<i>Alphabetical Listing</i> + <table border="0"> <tr> <td valign="top"> @@ -181,20 +203,25 @@ as the corresponding C function. to be pointed to for a dataset region reference. This parameter is unused with object references. <dt><strong>Parameters:</strong> - <dl> - <dt><em>void *</em><code>ref</code> - <dd>OUT: Reference created by the function call. - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Location identifier used to locate the object being - pointed to. - <dt><em>const char *</em><code>name</code> - <dd>IN: Name of object at location <code>loc_id</code>. - <dt><em>H5R_type_t</em> <code>ref_type</code> - <dd>IN: Type of reference. - <dt><em>hid_t</em> <code>space_id</code> - <dd>IN: Dataspace identifier with selection. - Used for dataset region references. - </dl> + <ul><table> + <tr> + <td valign="top"><em>void *</em><code>ref</code></td> + <td valign="top">OUT: Reference created by the function call.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: Location identifier used to locate the object being + pointed to.</td></tr> + <tr> + <td valign="top"><em>const char *</em><code>name</code></td> + <td valign="top">IN: Name of object at location <code>loc_id</code>.</td></tr> + <tr> + <td valign="top"><em>H5R_type_t</em> <code>ref_type </code></td> + <td valign="top">IN: Type of reference.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id</code></td> + <td valign="top">IN: Dataspace identifier with selection. + Used for dataset region references.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -262,14 +289,17 @@ END SUBROUTINE h5rcreate_f <li><code>H5R_DATASET_REGION</code> (<code>1</code>) </ul> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dataset</code> - <dd>IN: Dataset containing reference object. - <dt><em>H5R_type_t</em> <code>ref_type</code> - <dd>IN: The reference type of <code>ref</code>. - <dt><em>void *</em><code>ref</code> - <dd>IN: Reference to open. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dataset</code></td> + <td valign="top">IN: Dataset containing reference object.</td></tr> + <tr> + <td valign="top"><em>H5R_type_t</em> <code>ref_type </code></td> + <td valign="top">IN: The reference type of <code>ref</code>.</td></tr> + <tr> + <td valign="top"><em>void *</em><code>ref</code></td> + <td valign="top">IN: Reference to open.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns valid identifier if successful; otherwise returns a negative value. @@ -361,16 +391,19 @@ END SUBROUTINE h5rdereference_f </td></tr> </table> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>id</code>, - <dd>IN: The dataset containing the reference object or + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>id</code>,</td> + <td valign="top">IN: The dataset containing the reference object or the location identifier of the object that the - dataset is located within. - <dt><em>H5R_type_t</em> <code>ref_type</code> - <dd>IN: Type of reference to query. - <dt><em>void *</em><code>ref</code> - <dd>IN: Reference to query. - </dl> + dataset is located within.</td></tr> + <tr> + <td valign="top"><em>H5R_type_t</em> <code>ref_type </code></td> + <td valign="top">IN: Type of reference to query.</td></tr> + <tr> + <td valign="top"><em>void *</em><code>ref</code></td> + <td valign="top">IN: Reference to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns an object type as defined in <code>H5Gpublic.h</code> if successful; otherwise returns <code>H5G_UNKNOWN</code>. @@ -472,14 +505,17 @@ END SUBROUTINE h5rget_object_type_f <li><code>H5R_DATASET_REGION</code> (<code>1</code>) </ul> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dataset</code>, - <dd>IN: Dataset containing reference object. - <dt><em>H5R_type_t</em> <code>ref_type</code>, - <dd>IN: The reference type of <code>ref</code>. - <dt><em>void *</em><code>ref</code> - <dd>IN: Reference to open. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dataset</code></td> + <td valign="top">IN: Dataset containing reference object.</td></tr> + <tr> + <td valign="top"><em>H5R_type_t</em> <code>ref_type </code></td> + <td valign="top">IN: The reference type of <code>ref</code>.</td></tr> + <tr> + <td valign="top"><em>void *</em><code>ref</code></td> + <td valign="top">IN: Reference to open.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a valid identifier if successful; otherwise returns a negative value. diff --git a/doc/html/RM_H5S.html b/doc/html/RM_H5S.html index 3fa420d..9fcd282 100644 --- a/doc/html/RM_H5S.html +++ b/doc/html/RM_H5S.html @@ -254,10 +254,11 @@ of the <cite>HDF5 User's Guide.</cite>. Failure to release a dataspace with this call will result in resource leaks. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>Identifier of dataspace to release. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">Identifier of dataspace to release.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -296,10 +297,11 @@ END SUBROUTINE h5sclose_f The dataspace identifier returned from this function should be released with <code>H5Sclose</code> or resource leaks will occur. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>Identifier of dataspace to copy. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">Identifier of dataspace to copy.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a dataspace identifier if successful; otherwise returns a negative value. @@ -309,7 +311,7 @@ END SUBROUTINE h5sclose_f SUBROUTINE h5scopy_f(space_id, new_space_id, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier - INTEGER(HID_T), INTENT(OUT) :: new_space_id ! Identifier of dataspace's copy + INTEGER(HID_T), INTENT(OUT) :: new_space_id ! Identifier of dataspace copy INTEGER, INTENT(OUT) :: hdferr ! Error code ! 0 on success and -1 on failure END SUBROUTINE h5scopy_f @@ -339,10 +341,11 @@ END SUBROUTINE h5scopy_f <code>H5S_SIMPLE</code>; others are planned to be added later. <dt><strong>Parameters:</strong> - <dl> - <dt><em>H5S_class_t</em> <code>type</code> - <dd>The type of dataspace to be created. - </dl> + <ul><table> + <tr> + <td valign="top"><em>H5S_class_t</em> <code>type </code></td> + <td valign="top">The type of dataspace to be created.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a dataspace identifier if successful; otherwise returns a negative value. @@ -405,14 +408,17 @@ END SUBROUTINE h5screate_f The dataspace identifier returned from this function must be released with <code>H5Sclose</code> or resource leaks will occur. <dt><strong>Parameters:</strong> - <dl> - <dt><em>int</em> <code>rank</code> - <dd>Number of dimensions of dataspace. - <dt><em>const hsize_t *</em> <code>dims</code> - <dd>An array of the size of each dimension. - <dt><em>const hsize_t *</em> <code>maxdims</code> - <dd>An array of the maximum size of each dimension. - </dl> + <ul><table> + <tr> + <td valign="top"><em>int</em> <code>rank</code></td> + <td valign="top">Number of dimensions of dataspace.</td></tr> + <tr> + <td valign="top"><em>const hsize_t *</em> <code>dims</code></td> + <td valign="top">An array of the size of each dimension.</td></tr> + <tr> + <td valign="top"><em>const hsize_t *</em> <code>maxdims </code></td> + <td valign="top">An array of the maximum size of each dimension.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a dataspace identifier if successful; otherwise returns a negative value. @@ -456,14 +462,16 @@ END SUBROUTINE h5screate_simple_f <code>source_space_id</code> to <code>dest_space_id</code>. This action may change the type of the dataspace. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dest_space_id</code> - <dd>IN: The identifier for the dataspace to which - the extent is copied. - <dt><em>hid_t</em> <code>source_space_id</code> - <dd>IN: The identifier for the dataspace from which - the extent is copied. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dest_space_id</code></td> + <td valign="top">IN: The identifier for the dataspace to which + the extent is copied.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>source_space_id </code></td> + <td valign="top">IN: The identifier for the dataspace from which + the extent is copied.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -496,8 +504,8 @@ END SUBROUTINE h5sextent_copy_f <dt><strong>Name:</strong> <a name="Dataspace-SelectBounds">H5Sget_select_bounds</a> <dt><strong>Signature:</strong> <dd><em>herr_t </em><code>H5Sget_select_bounds</code>(<em>hid_t </em><code>space_id</code>, - <em>hssize_t *</em><code>start</code>, - <em>hssize_t *</em><code>end</code> + <em>hsize_t *</em><code>start</code>, + <em>hsize_t *</em><code>end</code> ) <dt><strong>Purpose:</strong> <dd>Gets the bounding box containing the current selection. @@ -520,15 +528,18 @@ END SUBROUTINE h5sextent_copy_f Calling this function on a <code>none</code> selection will return <code>FAIL</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>IN: Identifier of dataspace to query. - <dt><em>hssize_t *</em><code>start</code> - <dd>OUT: Starting coordinates of the bounding box. - <dt><em>hssize_t *</em><code>end</code> - <dd>OUT: Ending coordinates of the bounding box, - i.e., the coordinates of the diagonally opposite corner. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">IN: Identifier of dataspace to query.</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em><code>start</code></td> + <td valign="top">OUT: Starting coordinates of the bounding box.</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em><code>end</code></td> + <td valign="top">OUT: Ending coordinates of the bounding box, + i.e., the coordinates of the diagonally opposite corner.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -539,9 +550,9 @@ SUBROUTINE h5sget_select_bounds_f(space_id, start, end, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier - INTEGER(HSSIZE_T), DIMENSION(*), INTENT(OUT) :: start + INTEGER(HSIZE_T), DIMENSION(*), INTENT(OUT) :: start ! Starting coordinates of the bounding box - INTEGER(HSSIZE_T), DIMENSION(*), INTENT(OUT) :: end + INTEGER(HSIZE_T), DIMENSION(*), INTENT(OUT) :: end ! Ending coordinates of the bounding box, ! i.e., the coordinates of the diagonally ! opposite corner @@ -570,10 +581,11 @@ END SUBROUTINE h5sget_select_bounds_f <dd><code>H5Sget_select_elem_npoints</code> returns the number of element points in the current dataspace selection. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>IN: Identifier of dataspace to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">IN: Identifier of dataspace to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the number of element points in the current dataspace selection if successful. Otherwise returns a negative value. @@ -634,23 +646,27 @@ END SUBROUTINE h5sget_select_elem_npoints_f The points are returned in the order they will be iterated through when the selection is read/written from/to disk. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>IN: Dataspace identifier of selection to query. - <dt><em>hsize_t </em><code>startpoint</code> - <dd>IN: Element point to start with. - <dt><em>hsize_t </em><code>numpoints</code> - <dd>IN: Number of element points to get. - <dt><em>hsize_t *</em><code>buf</code> - <dd>OUT: List of element points selected. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id</code></td> + <td valign="top">IN: Dataspace identifier of selection to query.</td></tr> + <tr> + <td valign="top"><em>hsize_t </em><code>startpoint </code></td> + <td valign="top">IN: Element point to start with.</td></tr> + <tr> + <td valign="top"><em>hsize_t </em><code>numpoints</code></td> + <td valign="top">IN: Number of element points to get.</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em><code>buf</code></td> + <td valign="top">OUT: List of element points selected.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. <dt><strong>Fortran90 Interface:</strong> h5sget_select_elem_pointlist_f <dd> <pre> -SUBROUTINE h5sget_select_elem_pointlist_f(space_id, startpoint, num_points, & +SUBROUTINE h5sget_select_elem_pointlist_f(space_id, startpoint, num_points, buf, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier @@ -709,23 +725,27 @@ END SUBROUTINE h5sget_select_elem_pointlist_f <p> No guarantee is implied as the order in which blocks are listed. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>IN: Dataspace identifier of selection to query. - <dt><em>hsize_t </em><code>startblock</code> - <dd>IN: Hyperslab block to start with. - <dt><em>hsize_t </em><code>numblocks</code> - <dd>IN: Number of hyperslab blocks to get. - <dt><em>hsize_t *</em><code>buf</code> - <dd>OUT: List of hyperslab blocks selected. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id</code></td> + <td valign="top">IN: Dataspace identifier of selection to query.</td></tr> + <tr> + <td valign="top"><em>hsize_t </em><code>startblock </code></td> + <td valign="top">IN: Hyperslab block to start with.</td></tr> + <tr> + <td valign="top"><em>hsize_t </em><code>numblocks</code></td> + <td valign="top">IN: Number of hyperslab blocks to get.</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em><code>buf</code></td> + <td valign="top">OUT: List of hyperslab blocks selected.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. <dt><strong>Fortran90 Interface:</strong> h5sget_select_hyper_blocklist_f <dd> <pre> -SUBROUTINE h5sget_select_hyper_blocklist_f(space_id, startblock, num_blocks, & +SUBROUTINE h5sget_select_hyper_blocklist_f(space_id, startblock, num_blocks, buf, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier @@ -761,10 +781,11 @@ END SUBROUTINE h5sget_select_hyper_blocklist_f <dd><code>H5Sget_select_hyper_nblocks</code> returns the number of hyperslab blocks in the current dataspace selection. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>IN: Identifier of dataspace to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">IN: Identifier of dataspace to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the number of hyperslab blocks in the current dataspace selection if successful. @@ -802,10 +823,11 @@ END SUBROUTINE h5sget_select_hyper_nblocks_f <dd><code>H5Sget_select_npoints</code> determines the number of elements in the current selection of a dataspace. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>Dataspace identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">Dataspace identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the number of elements in the selection if successful; otherwise returns a negative value. @@ -844,10 +866,11 @@ END SUBROUTINE h5sget_select_npoints_f type of selection currently defined for the dataspace <code>space_id</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>Dataspace identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">Dataspace identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the dataspace selection type, a value of the enumerated datatype <code>H5S_sel_type</code>, @@ -924,14 +947,17 @@ END SUBROUTINE h5sget_select_type_f <code>H5S_UNLIMITED</code> (</code>-1</code>), the maximum size of that dimension is unlimited. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>IN: Identifier of the dataspace object to query - <dt><em>hsize_t *</em><code>dims</code> - <dd>OUT: Pointer to array to store the size of each dimension. - <dt><em>hsize_t *</em><code>maxdims</code> - <dd>OUT: Pointer to array to store the maximum size of each dimension. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id</code></td> + <td valign="top">IN: Identifier of the dataspace object to query</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em><code>dims</code></td> + <td valign="top">OUT: Pointer to array to store the size of each dimension.</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em><code>maxdims </code></td> + <td valign="top">OUT: Pointer to array to store the maximum size of each dimension.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the number of dimensions in the dataspace if successful; otherwise returns a negative value. @@ -972,10 +998,11 @@ END SUBROUTINE h5sget_simple_extent_dims_f <dd><code>H5Sget_simple_extent_ndims</code> determines the dimensionality (or rank) of a dataspace. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>Identifier of the dataspace - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">Identifier of the dataspace</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the number of dimensions in the dataspace if successful; otherwise returns a negative value. @@ -1013,10 +1040,11 @@ END SUBROUTINE h5sget_simple_extent_ndims_f in a dataspace. For example, a simple 3-dimensional dataspace with dimensions 2, 3, and 4 would have 24 elements. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>ID of the dataspace object to query - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">ID of the dataspace object to query</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the number of elements in the dataspace if successful; otherwise returns 0. @@ -1058,10 +1086,11 @@ END SUBROUTINE h5sget_simple_extent_npoints_f <code>H5S_SIMPLE</code>, or <code>H5S_NONE</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>Dataspace identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">Dataspace identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a dataspace class name if successful; otherwise H5S_NO_CLASS (-1). @@ -1072,10 +1101,10 @@ SUBROUTINE h5sget_simple_extent_type_f(space_id, classtype, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier INTEGER, INTENT(OUT) :: classtype ! Class type - ! Valid values are: + ! Possible values are: ! H5S_NO_CLASS_F ! H5S_SCALAR_F - ! H5S_SIMPLE_F + ! H5S_SIMPLE_F INTEGER, INTENT(OUT) :: hdferr ! Error code ! 0 on success and -1 on failure END SUBROUTINE h5sget_simple_extent_type_f @@ -1103,10 +1132,11 @@ END SUBROUTINE h5sget_simple_extent_type_f a simple dataspace. [Currently, all dataspace objects are simple dataspaces, complex dataspace support will be added in the future] <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>Identifier of the dataspace to query - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">Identifier of the dataspace to query</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>When successful, returns a positive value, for <code>TRUE</code>, or <code>0</code> (zero), for <code>FALSE</code>. @@ -1117,8 +1147,8 @@ END SUBROUTINE h5sget_simple_extent_type_f SUBROUTINE h5sis_simple_f(space_id, flag, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier - LOGICAL, INTENT(OUT) :: flag ! Flag, idicates if dataspace - ! is simple or not: + LOGICAL, INTENT(OUT) :: flag ! Flag, indicates if dataspace + ! is simple or not: ! TRUE or FALSE INTEGER, INTENT(OUT) :: hdferr ! Error code ! 0 on success and -1 on failure @@ -1156,12 +1186,14 @@ END SUBROUTINE h5sis_simple_f to different locations within a dataspace without requiring it to be redefined. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>IN: The identifier for the dataspace object to reset. - <dt><em>const hssize_t *</em><code>offset</code> - <dd>IN: The offset at which to position the selection. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id</code></td> + <td valign="top">IN: The identifier for the dataspace object to reset.</td></tr> + <tr> + <td valign="top"><em>const hssize_t *</em><code>offset </code></td> + <td valign="top">IN: The offset at which to position the selection.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1205,11 +1237,12 @@ END SUBROUTINE h5soffset_simple_f <code>space_id</code>. <tt>H5S_SELECT_ALL</tt> selects the entire dataspace for any dataspace it is applied to. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>IN: The identifier for the dataspace in which the - selection is being made. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">IN: The identifier for the dataspace in which the + selection is being made.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1241,7 +1274,7 @@ END SUBROUTINE h5sselect_all_f <dd><em>herr_t</em> <code>H5Sselect_elements</code>(<em>hid_t </em><code>space_id</code>, <em>H5S_seloper_t</em> <code>op</code>, <em>const size_t</em> <code>num_elements</code>, - <em>const hssize_t *</em><code>coord</code>[ ] + <em>const hsize_t *</em><code>coord</code>[ ] ) <dt><strong>Purpose:</strong> <dd>Selects array elements to be included in the selection for a dataspace. @@ -1295,38 +1328,42 @@ END SUBROUTINE h5sselect_all_f the selection ordering is reset to C array ordering. --> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>Identifier of the dataspace. - <dt><em>H5S_seloper_t</em> <code>op</code> - <dd>Operator specifying how the new selection is to be - combined with the existing selection for the dataspace. - <dt><em>const size_t</em> <code>num_elements</code> - <dd>Number of elements to be selected. - <dt><em>const hssize_t *</em><code>coord</code>[ ] - <dd>A 2-dimensional array of 0-based values specifying the - coordinates of the elements being selected. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id</code></td> + <td valign="top">Identifier of the dataspace.</td></tr> + <tr> + <td valign="top"><em>H5S_seloper_t</em> <code>op</code></td> + <td valign="top">Operator specifying how the new selection is to be + combined with the existing selection for the dataspace.</td></tr> + <tr> + <td valign="top"><em>const size_t</em> <code>num_elements </code></td> + <td valign="top">Number of elements to be selected.</td></tr> + <tr> + <td valign="top"><em>const hsize_t *</em><code>coord</code>[ ]</td> + <td valign="top">A 2-dimensional array of 0-based values specifying the + coordinates of the elements being selected.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. <dt><strong>Fortran90 Interface:</strong> h5sselect_elements_f <dd> <pre> -SUBROUTINE h5sselect_elements_f(space_id, operator, num_elements, & +SUBROUTINE h5sselect_elements_f(space_id, operator, num_elements, coord, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier INTEGER, INTENT(IN) :: op ! Flag, valid values are: ! H5S_SELECT_SET_F ! H5S_SELECT_OR_F - INTEGER, INTENT(IN) :: num_elements ! Number of elements to be selected</pre> -<!-- NEW PAGE --> -<pre> - INTEGER(HSSIZE_T), DIMENSION(*,*), INTENT(IN) :: coord + INTEGER, INTENT(IN) :: num_elements ! Number of elements to be selected + INTEGER(HSIZE_T), DIMENSION(*,*), INTENT(IN) :: coord ! Array with the coordinates ! of the selected elements: - ! coord(num_elements, rank) + ! coord(num_elements, rank)</pre> +<!-- NEW PAGE --> +<pre> INTEGER, INTENT(OUT) :: hdferr ! Error code ! 0 on success and -1 on failure END SUBROUTINE h5sselect_elements_f @@ -1348,7 +1385,7 @@ END SUBROUTINE h5sselect_elements_f <dt><strong>Signature:</strong> <dd><em>herr_t</em> <code>H5Sselect_hyperslab</code>(<em>hid_t</em> <code>space_id</code>, <em>H5S_seloper_t</em> <code>op</code>, - <em>const hssize_t *</em><code>start</code>, + <em>const hsize_t *</em><code>start</code>, <em>const hsize_t *</em><code>stride</code>, <em>const hsize_t *</em><code>count</code>, <em>const hsize_t *</em><code>block</code> @@ -1451,34 +1488,40 @@ END SUBROUTINE h5sselect_elements_f Regions selected with this function call default to C order iteration when I/O is performed. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>IN: Identifier of dataspace selection to modify - <dt><em>H5S_seloper_t</em> <code>op</code> - <dd>IN: Operation to perform on current selection. - <dt><em>const hssize_t *</em><code>start</code> - <dd>IN: Offset of start of hyperslab - <dt><em>const hsize_t *</em><code>count</code> - <dd>IN: Number of blocks included in hyperslab. - <dt><em>const hsize_t *</em><code>stride</code> - <dd>IN: Hyperslab stride. - <dt><em>const hsize_t *</em><code>block</code> - <dd>IN: Size of block in hyperslab. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id</code></td> + <td valign="top">IN: Identifier of dataspace selection to modify</td></tr> + <tr> + <td valign="top"><em>H5S_seloper_t</em> <code>op</code></td> + <td valign="top">IN: Operation to perform on current selection.</td></tr> + <tr> + <td valign="top"><em>const hsize_t *</em><code>start</code></td> + <td valign="top">IN: Offset of start of hyperslab</td></tr> + <tr> + <td valign="top"><em>const hsize_t *</em><code>count</code></td> + <td valign="top">IN: Number of blocks included in hyperslab.</td></tr> + <tr> + <td valign="top"><em>const hsize_t *</em><code>stride </code></td> + <td valign="top">IN: Hyperslab stride.</td></tr> + <tr> + <td valign="top"><em>const hsize_t *</em><code>block</code></td> + <td valign="top">IN: Size of block in hyperslab.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. <dt><strong>Fortran90 Interface:</strong> h5sselect_hyperslab_f <dd> <pre> -SUBROUTINE h5sselect_hyperslab_f(space_id, operator, start, count, & +SUBROUTINE h5sselect_hyperslab_f(space_id, operator, start, count, hdferr, stride, block) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier INTEGER, INTENT(IN) :: op ! Flag, valid values are: ! H5S_SELECT_SET_F ! H5S_SELECT_OR_F - INTEGER(HSSIZE_T), DIMENSION(*), INTENT(IN) :: start + INTEGER(HSIZE_T), DIMENSION(*), INTENT(IN) :: start ! Starting coordinates of hyperslab INTEGER(HSIZE_T), DIMENSION(*), INTENT(IN) :: count ! Number of blocks to select @@ -1514,11 +1557,12 @@ END SUBROUTINE h5sselect_hyperslab_f <dd><code>H5Sselect_none</code> resets the selection region for the dataspace <code>space_id</code> to include no elements. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>IN: The identifier for the dataspace in which the - selection is being reset. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">IN: The identifier for the dataspace in which the + selection is being reset.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1555,10 +1599,11 @@ END SUBROUTINE h5sselect_none_f for the dataspace <code>space_id</code> is within the extent of the dataspace if the current offset for the dataspace is used. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>The identifier for the dataspace being queried. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">The identifier for the dataspace being queried.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a positive value, for <code>TRUE</code>, if the selection is contained within the extent @@ -1600,11 +1645,12 @@ END SUBROUTINE h5sselect_valid_f <dd><code>H5Sset_extent_none</code> removes the extent from a dataspace and sets the type to <tt>H5S_NO_CLASS</tt>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>The identifier for the dataspace from which - the extent is to be removed. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">The identifier for the dataspace from which + the extent is to be removed.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1657,23 +1703,27 @@ END SUBROUTINE h5sset_extent_none_f type is set to <code>H5S_SIMPLE</code>, and the extent is set as specified. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>Dataspace identifier. - <dt><em>int</em> <code>rank</code> - <dd>Rank, or dimensionality, of the dataspace. - <dt><em>const hsize_t *</em><code>current_size</code> - <dd>Array containing current size of dataspace. - <dt><em>const hsize_t *</em><code>maximum_size</code> - <dd>Array containing maximum size of dataspace. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id</code></td> + <td valign="top">Dataspace identifier.</td> + <tr> + <td valign="top"><em>int</em> <code>rank</code></td> + <td valign="top">Rank, or dimensionality, of the dataspace.</td> + <tr> + <td valign="top"><em>const hsize_t *</em><code>current_size </code></td> + <td valign="top">Array containing current size of dataspace.</td> + <tr> + <td valign="top"><em>const hsize_t *</em><code>maximum_size</code></td> + <td valign="top">Array containing maximum size of dataspace.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a dataspace identifier if successful; otherwise returns a negative value. <dt><strong>Fortran90 Interface:</strong> h5sset_extent_simple_f <dd> <pre> -SUBROUTINE h5sset_extent_simple_f(space_id, rank, current_size, & +SUBROUTINE h5sset_extent_simple_f(space_id, rank, current_size, maximum_size, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier diff --git a/doc/html/RM_H5T.html b/doc/html/RM_H5T.html index a498ead..dc35f47 100644 --- a/doc/html/RM_H5T.html +++ b/doc/html/RM_H5T.html @@ -107,8 +107,8 @@ of a dataset. <li><a href="#Datatype-SetSize">H5Tset_size</a> <li><a href="#Datatype-GetOrder">H5Tget_order</a> <li><a href="#Datatype-SetOrder">H5Tset_order</a> - <li><a href="#Datatype-GetPrecision">H5Tget_precision</a> - <li><a href="#Datatype-SetPrecision">H5Tset_precision</a> + <li><a href="#Datatype-GetPrecision">H5Tget_precision</a> + <li><a href="#Datatype-SetPrecision">H5Tset_precision</a> <li><a href="#Datatype-GetOffset">H5Tget_offset</a> <li><a href="#Datatype-SetOffset">H5Tset_offset</a> <li><a href="#Datatype-GetPad">H5Tget_pad</a> @@ -413,20 +413,24 @@ in the <cite>HDF5 User's Guide</cite> for further information, including a compl permutation, i.e. C versus FORTRAN array order. <b><i>(The parameter </i><code>perm</code><i> is currently unused and is not yet implemented.)</i></b> - <p> + <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>base</code> - <dd>IN: Datatype identifier for the array base datatype. - <dt><em>int</em> <code>rank</code> - <dd>IN: Rank of the array. - <dt><em>const hsize_t</em> <code>dims[/*rank*/]</code> - <dd>IN: Size of each array dimension. - <dt><em>const int</em> <code>perm[/*rank*/]</code> - <dd>IN: Dimension permutation. + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>base</code></td> + <td valign="top">IN: Datatype identifier for the array base datatype.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>rank</code></td> + <td valign="top">IN: Rank of the array.</td></tr> + <tr> + <td valign="top"><em>const hsize_t</em> <code>dims[/*rank*/] </code></td> + <td valign="top">IN: Size of each array dimension.</td></tr> + <tr> + <td valign="top"><em>const int</em> <code>perm[/*rank*/]</code></td> + <td valign="top">IN: Dimension permutation. - <b><i>(Currently not implemented.)</i></b> - </dl> + <b><i>(Currently not implemented.)</i></b></td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -467,10 +471,11 @@ END SUBROUTINE h5tarray_create_f through the datatype identifier is illegal. Failure to release a datatype with this call will result in resource leaks. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to release. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to release.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -512,14 +517,17 @@ END SUBROUTINE h5tclose_f which, when combined with <code>name</code>, refers to a new named datatype. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: A file or group identifier. - <dt><em>const char *</em> <code>name</code> - <dd>IN: A datatype name. - <dt><em>hid_t</em> <code>type</code> - <dd>IN: A datatype identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: A file or group identifier.</td></tr> + <tr> + <td valign="top"><em>const char *</em> <code>name </code></td> + <td valign="top">IN: A datatype name.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>type</code></td> + <td valign="top">IN: A datatype identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -562,10 +570,11 @@ END SUBROUTINE h5tcommit_f return committed datatypes with <code>H5Dget_type()</code> are able to share the datatype with other datasets in the same file. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type</code> - <dd>IN: Datatype identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type </code></td> + <td valign="top">IN: Datatype identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>When successful, returns a positive value, for <code>TRUE</code>, if the datatype has been committed, or <code>0</code> (zero), @@ -624,20 +633,26 @@ END SUBROUTINE h5tcommitted_f As of Release 1.2, this parameter is only used to pass along the variable-length datatype custom allocation information. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>src_id</code> - <dd>Identifier for the source datatype. - <dt><em>hid_t</em> <code>dst_id</code> - <dd>Identifier for the destination datatype. - <dt><em>size_t</em> <code>nelmts</code> - <dd>Size of array <code>buf</code>. - <dt><em>void *</em><code>buf</code> - <dd>Array containing pre- and post-conversion values. - <dt><em>void *</em><code>background</code> - <dd>Optional background buffer. - <dt><em>hid_t</em> <code>plist_id</code> - <dd>Dataset transfer property list identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>src_id</code></td> + <td valign="top">Identifier for the source datatype.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>dst_id</code></td> + <td valign="top">Identifier for the destination datatype.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>nelmts</code></td> + <td valign="top">Size of array <code>buf</code>.</td></tr> + <tr> + <td valign="top"><em>void *</em><code>buf</code></td> + <td valign="top">Array containing pre- and post-conversion values.</td></tr> + <tr> + <td valign="top"><em>void *</em><code>background </code></td> + <td valign="top">Optional background buffer.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">Dataset transfer property list identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -734,12 +749,13 @@ SUBROUTINE </dl> </ul> --> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to copy. Can be a datatype + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to copy. Can be a datatype identifier, a predefined datatype (defined in - <code>H5Tpublic.h</code>), or a dataset identifier. - </dl> + <code>H5Tpublic.h</code>), or a dataset identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a datatype identifier if successful; otherwise returns a negative value @@ -790,12 +806,14 @@ END SUBROUTINE h5tcopy_f The datatype identifier returned from this function should be released with <code>H5Tclose</code> or resource leaks will result. <dt><strong>Parameters:</strong> - <dl> - <dt><em>H5T_class_t</em> <code>class</code> - <dd>Class of datatype to create. - <dt><em>size_t</em> <code>size</code> - <dd>The number of bytes in the datatype to create. - </dl> + <ul><table> + <tr> + <td valign="top"><em>H5T_class_t</em> <code>class </code></td> + <td valign="top">Class of datatype to create.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>size</code></td> + <td valign="top">The number of bytes in the datatype to create.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns datatype identifier if successful; otherwise returns a negative value. @@ -846,12 +864,14 @@ END SUBROUTINE h5tcreate_f Valid class identifiers are as defined in <a href="#Datatype-GetClass"><code>H5Tget_class</code></a>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dtype_id</code> - <dd>Datatype identifier. - <dt><em>H5T_class_t</em><code>dtype_class</code> - <dd>Datatype class. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dtype_id</code></td> + <td valign="top">Datatype identifier.</td></tr> + <tr> + <td valign="top"><em>H5T_class_t</em> <code>dtype_class </code></td> + <td valign="top">Datatype class.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns <code>TRUE</code> or <code>FALSE</code> if successful; otherwise returns a negative value. @@ -887,10 +907,11 @@ SUBROUTINE based on the specified base datatype, <code>parent_id</code>, which must be an integer type. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>parent_id</code> - <dd>IN: Datatype identifier for the base datatype. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>parent_id </code></td> + <td valign="top">IN: Datatype identifier for the base datatype.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the datatype identifier for the new enumeration datatype if successful; otherwise returns a negative value. @@ -941,14 +962,17 @@ END SUBROUTINE h5tenum_create_f <code>value</code> points to data which is of the datatype defined when the enumeration datatype was created. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type</code> - <dd>IN: Datatype identifier for the enumeration datatype. - <dt><em>const char</em> *<code>name</code> - <dd>IN: Name of the new member. - <dt><em>void</em> *<code>value</code> - <dd>IN: Pointer to the value of the new member. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type</code></td> + <td valign="top">IN: Datatype identifier for the enumeration datatype.</td></tr> + <tr> + <td valign="top"><em>const char</em> *<code>name </code></td> + <td valign="top">IN: Name of the new member.</td></tr> + <tr> + <td valign="top"><em>void</em> *<code>value</code></td> + <td valign="top">IN: Pointer to the value of the new member.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -997,16 +1021,20 @@ END SUBROUTINE h5tenum_insert_f many characters as possible are copied (not null terminated) and the function fails. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type</code> - <dd>IN: Enumeration datatype identifier. - <dt><em>void</em> *<code>value</code>, - <dd>IN: Value of the enumeration datatype. - <dt><em>char</em> *<code>name</code>, - <dd>OUT: Buffer for output of the symbol name. - <dt><em>size_t</em> <code>size</code> - <dd>IN: Anticipated size of the symbol name, in bytes (characters). - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type</code></td> + <td valign="top">IN: Enumeration datatype identifier.</td></tr> + <tr> + <td valign="top"><em>void</em> *<code>value, </code></td> + <td valign="top">IN: Value of the enumeration datatype.</td></tr> + <tr> + <td valign="top"><em>char</em> *<code>name</code>,</td> + <td valign="top">OUT: Buffer for output of the symbol name.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>size</code></td> + <td valign="top">IN: Anticipated size of the symbol name, in bytes (characters).</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value @@ -1055,14 +1083,17 @@ END SUBROUTINE h5tenum_nameof_f as large as the value of <code>H5Tget_size(type)</code> in order to hold the result. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type</code> - <dd>IN: Enumeration datatype identifier. - <dt><em>const char</em> *<code>name</code>, - <dd>IN: Symbol name of the enumeration datatype. - <dt><em>void</em> *<code>value</code>, - <dd>OUT: Buffer for output of the value of the enumeration datatype. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type</code></td> + <td valign="top">IN: Enumeration datatype identifier.</td></tr> + <tr> + <td valign="top"><em>const char</em> *<code>name, </code></td> + <td valign="top">IN: Symbol name of the enumeration datatype.</td></tr> + <tr> + <td valign="top"><em>void</em> *<code>value</code>,</td> + <td valign="top">OUT: Buffer for output of the value of the enumeration datatype.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1101,12 +1132,14 @@ END SUBROUTINE h5tenum_valueof_f <dd><code>H5Tequal</code> determines whether two datatype identifiers refer to the same datatype. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id1</code> - <dd>Identifier of datatype to compare. - <dt><em>hid_t</em> <code>type_id2</code> - <dd>Identifier of datatype to compare. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id1 </code></td> + <td valign="top">Identifier of datatype to compare.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id2</code></td> + <td valign="top">Identifier of datatype to compare.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>When successful, returns a positive value, for <code>TRUE</code>, if the datatype identifiers refer to the same datatype, @@ -1154,14 +1187,17 @@ END SUBROUTINE h5tequal_f by the soft type conversion function of this path when the conversion function was installed on the path. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>src_id</code> - <dd>IN: Identifier for the source datatype. - <dt><em>hid_t</em> <code>dst_id</code> - <dd>IN: Identifier for the destination datatype. - <dt><em>H5T_cdata_t **</em><code>pcdata</code> - <dd>OUT: Pointer to type conversion data. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>src_id</code></td> + <td valign="top">IN: Identifier for the source datatype.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>dst_id</code></td> + <td valign="top">IN: Identifier for the destination datatype.</td></tr> + <tr> + <td valign="top"><em>H5T_cdata_t **</em><code>pcdata </code></td> + <td valign="top">OUT: Pointer to type conversion data.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a pointer to a suitable conversion function if successful. Otherwise returns NULL. @@ -1202,14 +1238,17 @@ SUBROUTINE The dimension permutations, i.e., C versus FORTRAN array order, are returned in the array <code>perm</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>adtype_id</code> - <dd>IN: Datatype identifier of array object. - <dt><em>hsize_t *</em><code>dims[]</code> - <dd>OUT: Sizes of array dimensions. - <dt><em>int *</em><code>perm[]</code> - <dd>OUT: Dimension permutations. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>adtype_id </code></td> + <td valign="top">IN: Datatype identifier of array object.</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em><code>dims[]</code></td> + <td valign="top">OUT: Sizes of array dimensions.</td></tr> + <tr> + <td valign="top"><em>int *</em><code>perm[]</code></td> + <td valign="top">OUT: Dimension permutations.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the non-negative number of dimensions of the array type if successful; otherwise returns a negative value. @@ -1248,10 +1287,11 @@ END SUBROUTINE h5tget_array_dims_f <dd><code>H5Tget_array_ndims</code> returns the rank, the number of dimensions, of an array datatype object. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>adtype_id</code> - <dd>IN: Datatype identifier of array object. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>adtype_id </code></td> + <td valign="top">IN: Datatype identifier of array object.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the rank of the array if successful; otherwise returns a negative value. @@ -1301,10 +1341,11 @@ END SUBROUTINE h5tget_array_ndims_f <li><code>H5T_ARRAY</code> </ul> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns datatype class identifier if successful; otherwise <code>H5T_NO_CLASS</code> (-1). @@ -1351,15 +1392,16 @@ END SUBROUTINE h5tget_class_f <dt><strong>Description:</strong> <dd><code>H5Tget_cset</code> retrieves the character set type of a string datatype. Valid character set types are: - <ul> <dl> + <dl><ul> <dt>H5T_CSET_ASCII (<code>0</code>) <dd>Character set is US ASCII - </dl> </ul> + </ul></dl> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a valid character set type if successful; otherwise <code>H5T_CSET_ERROR</code> (-1). @@ -1398,10 +1440,11 @@ END SUBROUTINE h5tget_cset_f <dt><strong>Description:</strong> <dd><code>H5Tget_ebias</code> retrieves the exponent bias of a floating-point type. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the bias if successful; otherwise 0. @@ -1447,20 +1490,26 @@ END SUBROUTINE h5tget_ebias_f numbered with the least significant bit number zero. Any (or even all) of the arguments can be null pointers. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>IN: Identifier of datatype to query. - <dt><em>size_t *</em><code>spos</code> - <dd>OUT: Pointer to location to return floating-point sign bit. - <dt><em>size_t *</em><code>epos</code> - <dd>OUT: Pointer to location to return exponent bit-position. - <dt><em>size_t *</em><code>esize</code> - <dd>OUT: Pointer to location to return size of exponent in bits. - <dt><em>size_t *</em><code>mpos</code> - <dd>OUT: Pointer to location to return mantissa bit-position. - <dt><em>size_t *</em><code>msize</code> - <dd>OUT: Pointer to location to return size of mantissa in bits. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">IN: Identifier of datatype to query.</td></tr> + <tr> + <td valign="top"><em>size_t *</em><code>spos</code></td> + <td valign="top">OUT: Pointer to location to return floating-point sign bit.</td></tr> + <tr> + <td valign="top"><em>size_t *</em><code>epos</code></td> + <td valign="top">OUT: Pointer to location to return exponent bit-position.</td></tr> + <tr> + <td valign="top"><em>size_t *</em><code>esize</code></td> + <td valign="top">OUT: Pointer to location to return size of exponent in bits.</td></tr> + <tr> + <td valign="top"><em>size_t *</em><code>mpos</code></td> + <td valign="top">OUT: Pointer to location to return mantissa bit-position.</td></tr> + <tr> + <td valign="top"><em>size_t *</em><code>msize</code></td> + <td valign="top">OUT: Pointer to location to return size of mantissa in bits.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1509,10 +1558,11 @@ END SUBROUTINE h5tget_fields_f <dd>Leave background alone. </dl> </ul> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a valid padding type if successful; otherwise <code>H5T_PAD_ERROR</code> (-1). @@ -1548,7 +1598,7 @@ END SUBROUTINE h5tget_inpad_f <dt><strong>Signature:</strong> <dd><em>H5T_class_t</em> <code>H5Tget_member_class</code>( <em>hid_t</em> <code>cdtype_id</code>, - <em>int </em><code>member_no</code> + <em>unsigned </em><code>member_no</code> ) <dt><strong>Purpose:</strong> <dd>Returns datatype class of compound datatype member. @@ -1557,12 +1607,14 @@ END SUBROUTINE h5tget_inpad_f <code>H5Tget_member_class</code> returns the datatype class of the compound datatype member specified by <code>member_no</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>cdtype_id</code> - <dd>IN: Datatype identifier of compound object. - <dt><em>int</em> <code>member_no</code> - <dd>IN: Compound object member number. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>cdtype_id </code></td> + <td valign="top">IN: Datatype identifier of compound object.</td></tr> + <tr> + <td valign="top"><em>unsigned</em> <code>member_no</code></td> + <td valign="top">IN: Compound object member number.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the datatype class, a non-negative value, if successful; otherwise returns a negative value. @@ -1603,12 +1655,14 @@ END SUBROUTINE h5tget_inpad_f with index values of 0 through <em>N</em>-1, where <em>N</em> is the value returned by <code>H5Tget_nmembers</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - <dt><em>const char *</em> <code>field_name</code> - <dd>Name of the field or member whose index is to be retrieved. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + <tr> + <td valign="top"><em>const char *</em> <code>field_name </code></td> + <td valign="top">Name of the field or member whose index is to be retrieved.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a valid field or member index if successful; otherwise returns a negative value. @@ -1635,7 +1689,7 @@ END SUBROUTINE h5tget_inpad_f <dt><strong>Name:</strong> <a name="Datatype-GetMemberName">H5Tget_member_name</a> <dt><strong>Signature:</strong> <dd><em>char *</em> <code>H5Tget_member_name</code>(<em>hid_t </em><code>type_id</code>, - <em>int</em> <code>field_idx</code> + <em>unsigned</em> <code>field_idx</code> ) <dt><strong>Purpose:</strong> <dd>Retrieves the name of a compound or enumeration datatype member. @@ -1654,13 +1708,15 @@ END SUBROUTINE h5tget_inpad_f allocated with <code>malloc()</code> and the caller is responsible for freeing the memory used. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - <dt><em>int</em> <code>field_idx</code> - <dd>Zero-based index of the field or element whose name - is to be retrieved. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + <tr> + <td valign="top"><em>unsigned</em> <code>field_idx</code></td> + <td valign="top">Zero-based index of the field or element whose name + is to be retrieved.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a valid pointer to a string allocated with <code>malloc()</code> if successful; @@ -1695,7 +1751,7 @@ END SUBROUTINE h5tget_member_name_f <dt><strong>Name:</strong> <a name="Datatype-GetMemberOffset">H5Tget_member_offset</a> <dt><strong>Signature:</strong> <dd><em>size_t</em> <code>H5Tget_member_offset</code>(<em>hid_t </em><code>type_id</code>, - <em>int</em> <code>memb_no</code> + <em>unsigned</em> <code>memb_no</code> ) <dt><strong>Purpose:</strong> <dd>Retrieves the offset of a field of a compound datatype. @@ -1705,12 +1761,14 @@ END SUBROUTINE h5tget_member_name_f compound datatype with respect to the beginning of the compound data type datum. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - <dt><em>int</em> <code>memb_no</code> - <dd>Number of the field whose offset is requested. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + <tr> + <td valign="top"><em>unsigned</em> <code>memb_no</code></td> + <td valign="top">Number of the field whose offset is requested.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the byte offset of the field if successful; otherwise returns <code>0</code> (zero). @@ -1746,7 +1804,7 @@ END SUBROUTINE h5tget_member_offset_f <dt><strong>Name:</strong> <a name="Datatype-GetMemberType">H5Tget_member_type</a> <dt><strong>Signature:</strong> <dd><em>hid_t</em> <code>H5Tget_member_type</code>(<em>hid_t </em><code>type_id</code>, - <em>int</em> <code>field_idx</code> + <em>unsigned</em> <code>field_idx</code> ) <dt><strong>Purpose:</strong> <dd>Returns the datatype of the specified member. @@ -1754,12 +1812,14 @@ END SUBROUTINE h5tget_member_offset_f <dd><code>H5Tget_member_type</code> returns the datatype of the specified member. The caller should invoke H5Tclose() to release resources associated with the type. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - <dt><em>int</em> <code>field_idx</code> - <dd>Field index (0-based) of the field type to retrieve. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + <tr> + <td valign="top"><em>unsigned</em> <code>field_idx</code></td> + <td valign="top">Field index (0-based) of the field type to retrieve.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the identifier of a copy of the datatype of the field if successful; @@ -1793,7 +1853,7 @@ END SUBROUTINE h5tget_member_type_f <dt><strong>Name:</strong> <a name="Datatype-GetMemberValue">H5Tget_member_value</a> <dt><strong>Signature:</strong> <dd><em>hid_t</em> <code>H5Tget_member_value</code>(<em>hid_t</em> <code>type</code> - <em>int</em> <code>memb_no</code>, + <em>unsigned</em> <code>memb_no</code>, <em>void</em> *<code>value</code> ) <dt><strong>Purpose:</strong> @@ -1805,15 +1865,18 @@ END SUBROUTINE h5tget_member_type_f The member value is returned in a user-supplied buffer pointed to by <code>value</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type</code> - <dd>IN: Datatype identifier for the enumeration datatype. - <dt><em>int</em> <code>memb_no</code>, - <dd>IN: Number of the enumeration datatype member. - <dt><em>void</em> *<code>value</code> - <dd>OUT: Pointer to a buffer for output of the - value of the enumeration datatype member. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type</code></td> + <td valign="top">IN: Datatype identifier for the enumeration datatype.</td></tr> + <tr> + <td valign="top"><em>unsigned</em> <code>memb_no</code>,</td> + <td valign="top">IN: Number of the enumeration datatype member.</td></tr> + <tr> + <td valign="top"><em>void</em> *<code>value </code></td> + <td valign="top">OUT: Pointer to a buffer for output of the + value of the enumeration datatype member.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1907,12 +1970,14 @@ END SUBROUTINE h5tget_member_value_f should eventually be closed by calling <code>H5Tclose</code> to release resources. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Datatype identifier for the dataset datatype. - <dt><em>H5T_direction_t</em> <code>direction</code> - <dd>Direction of search. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">Datatype identifier for the dataset datatype.</td></tr> + <tr> + <td valign="top"><em>H5T_direction_t</em> <code>direction </code></td> + <td valign="top">Direction of search.</td></tr> + </table></ul> <!-- NEW PAGE --> <dt><strong>Returns:</strong> <dd>Returns the native datatype identifier for the @@ -1949,10 +2014,11 @@ SUBROUTINE the number of fields in a compound datatype or the number of members of an enumeration datatype. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the number of elements if successful; otherwise returns a negative value. @@ -1998,10 +2064,11 @@ END SUBROUTINE h5tget_nmembers_f <dd>Mantissa is not normalized </dl> </ul> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a valid normalization type if successful; otherwise <code>H5T_NORM_ERROR</code> (-1). @@ -2093,10 +2160,11 @@ END SUBROUTINE h5tget_norm_f </tr> </table> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns an offset value if successful; otherwise returns a negative value. @@ -2144,10 +2212,11 @@ END SUBROUTINE h5tget_offset_f <dd>VAX mixed byte ordering (not currently supported). </dl></ul> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a byte order constant if successful; otherwise <code>H5T_ORDER_ERROR</code> (-1). @@ -2240,16 +2309,19 @@ SUBROUTINE <dd>Leave background alone. </dl> </ul> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>IN: Identifier of datatype to query. - <dt><em>H5T_pad_t *</em> <code>lsb</code> - <dd>OUT: Pointer to location to return least-significant - bit padding type. - <dt><em>H5T_pad_t *</em> <code>msb</code> - <dd>OUT: Pointer to location to return most-significant - bit padding type. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">IN: Identifier of datatype to query.</td></tr> + <tr> + <td valign="top"><em>H5T_pad_t *</em> <code>lsb </code></td> + <td valign="top">OUT: Pointer to location to return least-significant + bit padding type.</td></tr> + <tr> + <td valign="top"><em>H5T_pad_t *</em> <code>msb</code></td> + <td valign="top">OUT: Pointer to location to return most-significant + bit padding type.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -2297,10 +2369,11 @@ END SUBROUTINE h5tget_pad_f precision is the number of significant bits which, unless padding is present, is 8 times larger than the value returned by H5Tget_size(). <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the number of significant bits if successful; otherwise 0. @@ -2343,10 +2416,11 @@ END SUBROUTINE h5tget_precision_f <dd>Two's complement signed integer type. </dl> </ul> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a valid sign type if successful; otherwise <code>H5T_SGN_ERROR</code> (-1). @@ -2390,10 +2464,11 @@ END SUBROUTINE h5tget_sign_f <dt><strong>Description:</strong> <dd><code>H5Tget_size</code> returns the size of a datatype in bytes. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the size of the datatype in bytes if successful; otherwise 0. @@ -2432,10 +2507,11 @@ END SUBROUTINE h5tget_size_f for a string datatype, as defined in <a href="#Datatype-SetStrpad"><code>H5Tset_strpad</code></a>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a valid string storage mechanism if successful; otherwise <code>H5T_STR_ERROR</code> (-1). @@ -2480,10 +2556,11 @@ END SUBROUTINE h5tget_strpad_f <P> In the case of an enumeration type, the return value is an integer type. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type</code> - <dd>Datatype identifier for the derived datatype. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type </code></td> + <td valign="top">Datatype identifier for the derived datatype.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the datatype identifier for the base datatype if successful; otherwise returns a negative value. @@ -2523,10 +2600,11 @@ END SUBROUTINE h5tget_super_f The tag is returned via a pointer to an allocated string, which the caller must free. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Datatype identifier for the opaque datatype. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Datatype identifier for the opaque datatype.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a pointer to an allocated string if successful; otherwise returns <code>NULL</code>. @@ -2575,16 +2653,20 @@ END SUBROUTINE h5tget_tag_f Note: Members of a compound datatype do not have to be atomic datatypes; a compound datatype can have a member which is a compound datatype. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of compound datatype to modify. - <dt><em>const char *</em> <code>name</code> - <dd>Name of the field to insert. - <dt><em>size_t</em> <code>offset</code> - <dd>Offset in memory structure of the field to insert. - <dt><em>hid_t</em> <code>field_id</code> - <dd>Datatype identifier of the field to insert. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">Identifier of compound datatype to modify.</td></tr> + <tr> + <td valign="top"><em>const char *</em> <code>name </code></td> + <td valign="top">Name of the field to insert.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>offset</code></td> + <td valign="top">Offset in memory structure of the field to insert.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>field_id</code></td> + <td valign="top">Datatype identifier of the field to insert.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -2628,10 +2710,11 @@ END SUBROUTINE h5tinsert_f This function can be used to distinguish between fixed and variable-length string datatypes. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dtype_id</code> - <dd>Datatype identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dtype_id </code></td> + <td valign="top">Datatype identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns <code>TRUE</code> or <code>FALSE</code> if successful; otherwise returns a negative value. @@ -2675,10 +2758,11 @@ END SUBROUTINE h5tis_variable_str_f inadvertently change or delete a predefined type. Once a datatype is locked it can never be unlocked. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to lock. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to lock.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -2716,12 +2800,15 @@ SUBROUTINE group identifier. The identifier should eventually be closed by calling <code>H5Tclose</code> to release resources. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: A file or group identifier. - <dt><em>const char *</em> <code>name</code> - <dd>IN: A datatype name, defined within the file or group identified by <code>loc_id</code>. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: A file or group identifier.</td></tr> + <tr> + <td valign="top"><em>const char *</em> <code>name </code></td> + <td valign="top">IN: A datatype name, defined within the file + or group identified by <code>loc_id</code>.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a named datatype identifier if successful; otherwise returns a negative value. @@ -2761,10 +2848,11 @@ END SUBROUTINE h5topen_f <dd><code>H5Tpack</code> recursively removes padding from within a compound datatype to make it more efficient (space-wise) to store that data. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to modify. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to modify.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -2858,20 +2946,24 @@ END SUBROUTINE h5tpack_f section of “The Datatype Interface (H5T)” in the <cite>HDF5 User's Guide</cite>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>H5T_pers_t</em> <code>pers</code> - <dd><code>H5T_PERS_HARD</code> for hard conversion functions; - <code>H5T_PERS_SOFT</code> for soft conversion functions. -<!-- NEW PAGE --> - <dt><em>const char *</em> <code>name</code> - <dd>Name displayed in diagnostic output. - <dt><em>hid_t</em> <code>src_id</code> - <dd>Identifier of source datatype. - <dt><em>hid_t</em> <code>dst_id</code> - <dd>Identifier of destination datatype. - <dt><em>H5T_conv_t</em> <code>func</code> - <dd>Function to convert between source and destination datatypes. - </dl> + <ul><table> + <tr> + <td valign="top"><em>H5T_pers_t</em> <code>pers</code></td> + <td valign="top"><code>H5T_PERS_HARD</code> for hard conversion functions; + <code>H5T_PERS_SOFT</code> for soft conversion functions.</td></tr> + <tr> + <td valign="top"><em>const char *</em> <code>name</code></td> + <td valign="top">Name displayed in diagnostic output.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>src_id</code></td> + <td valign="top">Identifier of source datatype.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>dst_id</code></td> + <td valign="top">Identifier of destination datatype.</td></tr> + <tr> + <td valign="top"><em>H5T_conv_t</em> <code>func </code></td> + <td valign="top">Function to convert between source and destination datatypes.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -2913,12 +3005,14 @@ SUBROUTINE <dd>Character set is US ASCII. </dl> </ul> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to modify. - <dt><em>H5T_cset_t</em> <code>cset</code> - <dd>Character set type. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">Identifier of datatype to modify.</td></tr> + <tr> + <td valign="top"><em>H5T_cset_t</em> <code>cset </code></td> + <td valign="top">Character set type.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -2958,12 +3052,14 @@ END SUBROUTINE h5tset_cset_f <dt><strong>Description:</strong> <dd><code>H5Tset_ebias</code> sets the exponent bias of a floating-point type. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to set. - <dt><em>size_t</em> <code>ebias</code> - <dd>Exponent bias value. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to set.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>ebias</code></td> + <td valign="top">Exponent bias value.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3012,21 +3108,27 @@ END SUBROUTINE h5tset_ebias_f <P>Fields are not allowed to extend beyond the number of bits of precision, nor are they allowed to overlap with one another. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to set. - <dt><em>size_t</em> <code>spos</code> - <dd>Sign position, i.e., the bit offset of the floating-point - sign bit. - <dt><em>size_t</em> <code>epos</code> - <dd>Exponent bit position. - <dt><em>size_t</em> <code>esize</code> - <dd>Size of exponent in bits. - <dt><em>size_t</em> <code>mpos</code> - <dd>Mantissa bit position. - <dt><em>size_t</em> <code>msize</code> - <dd>Size of mantissa in bits. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to set.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>spos</code></td> + <td valign="top">Sign position, i.e., the bit offset of the floating-point + sign bit.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>epos</code></td> + <td valign="top">Exponent bit position.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>esize</code></td> + <td valign="top">Size of exponent in bits.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>mpos</code></td> + <td valign="top">Mantissa bit position.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>msize</code></td> + <td valign="top">Size of mantissa in bits.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3078,12 +3180,14 @@ END SUBROUTINE h5tset_fields_f <dd>Leave background alone. </dl> </ul> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to modify. - <dt><em>H5T_pad_t</em> <code>pad</code> - <dd>Padding type. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">Identifier of datatype to modify.</td></tr> + <tr> + <td valign="top"><em>H5T_pad_t</em> <code>pad </code></td> + <td valign="top">Padding type.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3135,12 +3239,14 @@ END SUBROUTINE h5tset_inpad_f <dd>Mantissa is not normalized </dl> </ul> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to set. - <dt><em>H5T_norm_t</em> <code>norm</code> - <dd>Mantissa normalization type. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">Identifier of datatype to set.</td></tr> + <tr> + <td valign="top"><em>H5T_norm_t</em> <code>norm </code></td> + <td valign="top">Mantissa normalization type.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3240,12 +3346,14 @@ the value from hanging over the edge of the datatype. <P>The offset of an H5T_STRING cannot be set to anything but zero. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to set. - <dt><em>size_t</em> <code>offset</code> - <dd>Offset of first significant bit. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to set.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>offset</code></td> + <td valign="top">Offset of first significant bit.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3292,12 +3400,14 @@ END SUBROUTINE h5tset_offset_f <dd>VAX mixed byte ordering (not currently supported). </dl> </ul> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to set. - <dt><em>H5T_order_t</em> <code>order</code> - <dd>Byte ordering constant. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">Identifier of datatype to set.</td></tr> + <tr> + <td valign="top"><em>H5T_order_t</em> <code>order </code></td> + <td valign="top">Byte ordering constant.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3350,10 +3460,11 @@ END SUBROUTINE h5tset_order_f <p> The NULL pointer may be passed to remove the overflow handler. <dt><strong>Parameters:</strong> - <dl> - <dt><em>H5T_overflow_t</em> <code>func</code> - <dd>Overflow function. - </dl> + <ul><table> + <tr> + <td valign="top"><em>H5T_overflow_t</em> <code>func </code></td> + <td valign="top">Overflow function.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3387,23 +3498,26 @@ SUBROUTINE <dd>Sets the least and most-significant bits padding types. <dt><strong>Description:</strong> <dd><code>H5Tset_pad</code> sets the least and most-significant bits padding types. - <ul> <dl> + <dl> <ul> <dt>H5T_PAD_ZERO (<code>0</code>) <dd>Set background to zeros. <dt>H5T_PAD_ONE (<code>1</code>) <dd>Set background to ones. <dt>H5T_PAD_BACKGROUND (<code>2</code>) <dd>Leave background alone. - </dl> </ul> + </ul> </dl> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to set. - <dt><em>H5T_pad_t</em> <code>lsb</code> - <dd>Padding type for least-significant bits. - <dt><em>H5T_pad_t</em> <code>msb</code> - <dd>Padding type for most-significant bits. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">Identifier of datatype to set.</td></tr> + <tr> + <td valign="top"><em>H5T_pad_t</em> <code>lsb </code></td> + <td valign="top">Padding type for least-significant bits.</td></tr> + <tr> + <td valign="top"><em>H5T_pad_t</em> <code>msb</code></td> + <td valign="top">Padding type for most-significant bits.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3460,12 +3574,14 @@ END SUBROUTINE h5tset_pad_f locations and sizes of the sign, mantissa, and exponent fields first. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to set. - <dt><em>size_t</em> <code>precision</code> - <dd>Number of bits of precision for datatype. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">Identifier of datatype to set.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>precision </code></td> + <td valign="top">Number of bits of precision for datatype.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3508,12 +3624,14 @@ END SUBROUTINE h5tset_precision_f <dd>Two's complement signed integer type. </dl> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to set. - <dt><em>H5T_sign_t</em> <code>sign</code> - <dd>Sign type. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">Identifier of datatype to set.</td></tr> + <tr> + <td valign="top"><em>H5T_sign_t</em> <code>sign </code></td> + <td valign="top">Sign type.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3569,12 +3687,14 @@ END SUBROUTINE h5tset_sign_f to 8*<code>size</code>. A compound datatype may increase in size, but may not shrink. All datatypes must have a positive size. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to change size. - <dt><em>size_t</em> <code>size</code> - <dd>Size in bytes to modify datatype. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to change size.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>size</code></td> + <td valign="top">Size in bytes to modify datatype.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3641,12 +3761,14 @@ END SUBROUTINE h5tset_size_f <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to modify. - <dt><em>H5T_str_t</em> <code>strpad</code> - <dd>String padding type. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">Identifier of datatype to modify.</td></tr> + <tr> + <td valign="top"><em>H5T_str_t</em> <code>strpad </code></td> + <td valign="top">String padding type.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3660,7 +3782,7 @@ SUBROUTINE h5tset_strpad_f(type_id, strpad, hdferr) INTEGER, INTENT(IN) :: strpad ! String padding method for a string datatype ! Possible values of padding type are: ! Pad with zeros (as C does): - !r H5T_STR_NULLPAD_(0) + ! H5T_STR_NULLPAD_F(0) ! Pad with spaces (as FORTRAN does): ! H5T_STR_SPACEPAD_F(1) INTEGER, INTENT(OUT) :: hdferr ! Error code @@ -3690,13 +3812,15 @@ END SUBROUTINE h5tset_strpad_f <dd><code>H5Tset_tag</code> tags an opaque datatype <code>type_id</code> with a descriptive ASCII identifier,<code> tag</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>IN: Datatype identifier for the opaque datatype to be tagged. - <dt><em>const char</em> *<code>tag</code> - <dd>IN: Descriptive ASCII string with which the - opaque datatype is to be tagged. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">IN: Datatype identifier for the opaque datatype to be tagged.</td></tr> + <tr> + <td valign="top"><em>const char</em> *<code>tag </code></td> + <td valign="top">IN: Descriptive ASCII string with which the + opaque datatype is to be tagged.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3736,10 +3860,11 @@ END SUBROUTINE h5tset_tag_f The conversion function pointer type declaration is described in <a href="#Datatype-Register">H5Tregister</a>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>H5T_conv_t</em> <code>func</code> - <dd>Function to remove from conversion paths. - </dl> + <ul><table> + <tr> + <td valign="top"><em>H5T_conv_t</em> <code>func </code></td> + <td valign="top">Function to remove from conversion paths.</td> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3783,10 +3908,11 @@ SUBROUTINE The datatype identifier returned from this function should be released with <code>H5Tclose</code> or resource leaks will result. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>base_type_id</code> - <dd>Base type of datatype to create. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>base_type_id </code></td> + <td valign="top">Base type of datatype to create.</td></tr> + </table></ul> <dt><strong>See Also:</strong> <dd><a href="RM_H5D.html#Dataset-GetVLBuf">H5Dget_vlen_buf_size</a> <dd><a href="RM_H5D.html#Dataset-VLReclaim">H5Dvlen_reclaim</a> diff --git a/doc/html/RM_H5Z.html b/doc/html/RM_H5Z.html index 11506ce..44c67ca 100644 --- a/doc/html/RM_H5Z.html +++ b/doc/html/RM_H5Z.html @@ -105,7 +105,7 @@ as the corresponding C function. </ul> </td><td> </td><td valign=top width="30%"> <ul> -<!--<li><a href="#Compression-Register">h5zregister_f</a><br> --> +<!--<li><a href="#Compression-Register">h5zregister_f</a><br> --> <li><a href="#Compression-GetFilterInfo">h5zget_filter_info_f</a> </ul> </td><td> </td><td valign=top width="30%"> @@ -129,10 +129,10 @@ The flexibility of the filter pipeline implementation enables the definition of additional filters by a user application. A filter <ul> - <li>is associated with a dataset when the dataset is created,<br> - <li>can be used only with chunked data<br> - (i.e., datasets stored in the <code>H5D_CHUNKED</code> - storage layout), and + <li>is associated with a dataset when the dataset is created, + <li>can be used only with chunked data + <br>(i.e., datasets stored in the <code>H5D_CHUNKED</code> + storage layout), and <li>is applied independently to each chunk of the dataset. </ul> <p> @@ -179,12 +179,13 @@ data compression. <dd><code>H5Zfilter_avail</code> determines whether the filter specified in <code>filter</code> is available to the application. <dt><strong>Parameters:</strong> - <dl> - <dt><em>H5Z_filter_t</em> <code>filter</code> - <dd>IN: Filter identifier. - See the introduction to this section of the reference manual - for a list of valid filter identifiers. - </dl> + <ul><table> + <tr> + <td valign="top"><em>H5Z_filter_t</em> <code>filter </code></td> + <td valign="top">IN: Filter identifier. + See the introduction to this section of the reference manual + for a list of valid filter identifiers.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -275,20 +276,20 @@ END SUBROUTINE h5zfilter_avail_f the filter is not so configured. <p> If a filter is not encode-enabled, the corresponding - <code>H5Pset_*</code> function will return an error if the - filter is added to a dataset creation property list (which is + <code>H5Pset_*</code> function will return an error if the + filter is added to a dataset creation property list (which is required if the filter is to be used to encode that dataset). For example, if the <code>H5Z_FILTER_CONFIG_ENCODE_ENABLED</code> - flag is not returned for the SZIP filter, - <code>H5Z_FILTER_SZIP</code>, a call to <code>H5Pset_szip</code> + flag is not returned for the SZIP filter, + <code>H5Z_FILTER_SZIP</code>, a call to <code>H5Pset_szip</code> will fail. <p> - If a filter is not decode-enabled, the application will not be - able to read an existing file encoded with that filter. + If a filter is not decode-enabled, the application will not be + able to read an existing file encoded with that filter. <p> - This function should be called, and the returned - <code>filter_config_flags</code> analyzed, before calling - any other function, such as <code>H5Pset_szip</code>, + This function should be called, and the returned + <code>filter_config_flags</code> analyzed, before calling + any other function, such as <code>H5Pset_szip</code>, that might require a particular filter configuration. <dt><strong>Parameters:</strong> @@ -301,24 +302,24 @@ END SUBROUTINE h5zfilter_avail_f <dd>OUT: A bit field encoding the returned filter information </dl> <dt><strong>Returns:</strong> - <dd>Returns a non-negative value on success, + <dd>Returns a non-negative value on success, a negative value on failure. <!-- NEW PAGE --> <dt><strong>Fortran90 Interface:</strong> <dd> <pre> -SUBROUTINE h5zget_filter_info_f(filter, config_flags, hdferr) +SUBROUTINE h5zget_filter_info_f(filter, config_flags, hdferr) IMPLICIT NONE - INTEGER, INTENT(IN) :: filter ! Filter, may be one of the + INTEGER, INTENT(IN) :: filter ! Filter, may be one of the ! following: ! H5Z_FILTER_DEFLATE_F ! H5Z_FILTER_SHUFFLE_F ! H5Z_FILTER_FLETCHER32_F ! H5Z_FILTER_SZIP_F - INTEGER, INTENT(OUT) :: config_flags ! Bit field indicating whether - ! a filter's encoder and/or + INTEGER, INTENT(OUT) :: config_flags ! Bit field indicating whether + ! a filter's encoder and/or ! decoder are available INTEGER, INTENT(OUT) :: hdferr ! Error code @@ -326,8 +327,8 @@ END SUBROUTINE h5zfilter_avail_f </pre> <!--<dt><strong>Non-C API(s):</strong> <dd> - - <img src="Graphics/Java.gif"> + + <img src="Graphics/Java.gif"> <img src="Graphics/C++.gif"> --> </dl> @@ -523,10 +524,11 @@ END SUBROUTINE h5zfilter_avail_f the <i>set local</i> and <i>can apply</i> callback functions first appeared in HDF5 Release 1.6. <dt><strong>Parameters:</strong> - <dl> - <dt><em>const H5Z_class_t</em> <code>filter_class</code> - <dd>IN: Struct containing filter-definition information. - </dl> + <ul><table> + <tr> + <td valign="top"><em>const H5Z_class_t</em> <code>filter_class </code></td> + <td valign="top">IN: Struct containing filter-definition information.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -563,13 +565,14 @@ END SUBROUTINE h5zfilter_avail_f specified in <code>filter</code> will no longer be available to the application. <dt><strong>Parameters:</strong> - <dl> - <dt><em>H5Z_filter_t</em> <code>filter</code> - <dd>IN: Identifier of the filter to be unregistered. - See the introduction to this section of the reference manual - for a list of identifiers for standard filters distributed - with the HDF5 Library. - </dl> + <ul><table> + <tr> + <td valign="top"><em>H5Z_filter_t</em> <code>filter </code></td> + <td valign="top">IN: Identifier of the filter to be unregistered. + See the introduction to this section of the reference manual + for a list of identifiers for standard filters + distributed with the HDF5 Library.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. diff --git a/doc/html/References.html b/doc/html/References.html index 2b7b4cf..766b92c 100644 --- a/doc/html/References.html +++ b/doc/html/References.html @@ -339,7 +339,7 @@ write the dataset to the file. href_t data[10][10]; /* HDF5 reference type */ int rank; size_t dimsf[2]; - hssize_t start[3],count[3]; + hsize_t start[3],count[3]; int i, j; /* Open the file */ diff --git a/doc/html/Tutor/examples/h5_copy.c b/doc/html/Tutor/examples/h5_copy.c index b0a5e00..357596b 100644 --- a/doc/html/Tutor/examples/h5_copy.c +++ b/doc/html/Tutor/examples/h5_copy.c @@ -38,7 +38,7 @@ int main (void) int bufnew[DIM1][DIM2]; int val[] = {53, 59}; hsize_t marray[] = {2}; - hssize_t coord[NUMP][RANK]; + hsize_t coord[NUMP][RANK]; herr_t ret; uint i, j; @@ -95,7 +95,7 @@ int main (void) coord[0][0] = 0; coord[0][1] = 3; coord[1][0] = 0; coord[1][1] = 1; - ret = H5Sselect_elements (fid1, H5S_SELECT_SET, NUMP, (const hssize_t **)coord); + ret = H5Sselect_elements (fid1, H5S_SELECT_SET, NUMP, (const hsize_t **)coord); ret = H5Dwrite (dataset1, H5T_NATIVE_INT, mid1, fid1, H5P_DEFAULT, val); diff --git a/doc/html/Tutor/examples/h5_extend.c b/doc/html/Tutor/examples/h5_extend.c index ae26ed6..1f81827 100644 --- a/doc/html/Tutor/examples/h5_extend.c +++ b/doc/html/Tutor/examples/h5_extend.c @@ -32,7 +32,7 @@ main (void) hsize_t maxdims[2] = {H5S_UNLIMITED, H5S_UNLIMITED}; hsize_t size[2]; - hssize_t offset[2]; + hsize_t offset[2]; hsize_t i,j; herr_t status, status_n; int data1[3][3] = { {1, 1, 1}, /* data to write */ diff --git a/doc/html/Tutor/examples/h5_hyperslab.c b/doc/html/Tutor/examples/h5_hyperslab.c index fc953d5..120e30d 100644 --- a/doc/html/Tutor/examples/h5_hyperslab.c +++ b/doc/html/Tutor/examples/h5_hyperslab.c @@ -40,9 +40,9 @@ main (void) int data_out[NX][NY][NZ ]; /* output buffer */ hsize_t count[2]; /* size of the hyperslab in the file */ - hssize_t offset[2]; /* hyperslab offset in the file */ + hsize_t offset[2]; /* hyperslab offset in the file */ hsize_t count_out[3]; /* size of the hyperslab in memory */ - hssize_t offset_out[3]; /* hyperslab offset in memory */ + hsize_t offset_out[3]; /* hyperslab offset in memory */ int i, j, k, status_n, rank; diff --git a/doc/html/Tutor/examples/h5_read.c b/doc/html/Tutor/examples/h5_read.c index 31cb882..8f2f179 100644 --- a/doc/html/Tutor/examples/h5_read.c +++ b/doc/html/Tutor/examples/h5_read.c @@ -36,9 +36,9 @@ main (void) int data_out[NX][NY][NZ ]; /* output buffer */ hsize_t count[2]; /* size of the hyperslab in the file */ - hssize_t offset[2]; /* hyperslab offset in the file */ + hsize_t offset[2]; /* hyperslab offset in the file */ hsize_t count_out[3]; /* size of the hyperslab in memory */ - hssize_t offset_out[3]; /* hyperslab offset in memory */ + hsize_t offset_out[3]; /* hyperslab offset in memory */ int i, j, k, status_n, rank; for (j = 0; j < NX; j++) { diff --git a/doc/html/Tutor/examples/h5_ref2regr.c b/doc/html/Tutor/examples/h5_ref2regr.c index 26b5daf..9f747ae 100644 --- a/doc/html/Tutor/examples/h5_ref2regr.c +++ b/doc/html/Tutor/examples/h5_ref2regr.c @@ -24,8 +24,8 @@ main(void) hid_t sid1, /* Dataspace ID #1 */ sid2; /* Dataspace ID #2 */ hsize_t * coords; /* Coordinate buffer */ - hssize_t low[SPACE2_RANK]; /* Selection bounds */ - hssize_t high[SPACE2_RANK]; /* Selection bounds */ + hsize_t low[SPACE2_RANK]; /* Selection bounds */ + hsize_t high[SPACE2_RANK]; /* Selection bounds */ hdset_reg_ref_t *rbuf; /* buffer to to read disk */ int *drbuf; /* Buffer for reading numeric data from disk */ int i, j; /* counting variables */ diff --git a/doc/html/Tutor/examples/h5_ref2regw.c b/doc/html/Tutor/examples/h5_ref2regw.c index 5f27950..35352f8 100644 --- a/doc/html/Tutor/examples/h5_ref2regw.c +++ b/doc/html/Tutor/examples/h5_ref2regw.c @@ -18,18 +18,18 @@ int main(void) { - hid_t fid1; /* HDF5 File IDs */ - hid_t dset1, /* Dataset ID */ + hid_t fid1; /* HDF5 File IDs */ + hid_t dset1, /* Dataset ID */ dset2; /* Dereferenced dataset ID */ - hid_t sid1, /* Dataspace ID #1 */ + hid_t sid1, /* Dataspace ID #1 */ sid2; /* Dataspace ID #2 */ - hsize_t dims1[] = {SPACE1_DIM1}, + hsize_t dims1[] = {SPACE1_DIM1}, dims2[] = {SPACE2_DIM1, SPACE2_DIM2}; - hssize_t start[SPACE2_RANK]; /* Starting location of hyperslab */ - hsize_t stride[SPACE2_RANK]; /* Stride of hyperslab */ - hsize_t count[SPACE2_RANK]; /* Element count of hyperslab */ - hsize_t block[SPACE2_RANK]; /* Block size of hyperslab */ - hssize_t coord1[POINT1_NPOINTS][SPACE2_RANK]; + hsize_t start[SPACE2_RANK]; /* Starting location of hyperslab */ + hsize_t stride[SPACE2_RANK]; /* Stride of hyperslab */ + hsize_t count[SPACE2_RANK]; /* Element count of hyperslab */ + hsize_t block[SPACE2_RANK]; /* Block size of hyperslab */ + hsize_t coord1[POINT1_NPOINTS][SPACE2_RANK]; /* Coordinates for point selection */ hdset_reg_ref_t *wbuf; /* buffer to write to disk */ int *dwbuf; /* Buffer for writing numeric data to disk */ @@ -88,7 +88,7 @@ main(void) coord1[7][0]=9; coord1[7][1]=0; coord1[8][0]=7; coord1[8][1]=1; coord1[9][0]=3; coord1[9][1]=3; - ret = H5Sselect_elements(sid2,H5S_SELECT_SET,POINT1_NPOINTS,(const hssize_t **)coord1); + ret = H5Sselect_elements(sid2,H5S_SELECT_SET,POINT1_NPOINTS,(const hsize_t **)coord1); /* Store second dataset region */ ret = H5Rcreate(&wbuf[1],fid1,"/Dataset2",H5R_DATASET_REGION,sid2); diff --git a/doc/html/Tutor/examples/refregexample.f90 b/doc/html/Tutor/examples/refregexample.f90 index 05fcf3f..5d72f1e 100644 --- a/doc/html/Tutor/examples/refregexample.f90 +++ b/doc/html/Tutor/examples/refregexample.f90 @@ -27,13 +27,13 @@ TYPE(hdset_reg_ref_t_f) , DIMENSION(2) :: ref_out ! INTEGER(HSIZE_T), DIMENSION(2) :: dims = (/2,9/) ! Datasets dimensions INTEGER(HSIZE_T), DIMENSION(1) :: dimsr = (/2/) ! - INTEGER(HSSIZE_T), DIMENSION(2) :: start + INTEGER(HSIZE_T), DIMENSION(2) :: start INTEGER(HSIZE_T), DIMENSION(2) :: count INTEGER :: rankr = 1 INTEGER :: rank = 2 INTEGER , DIMENSION(2,9) :: data INTEGER , DIMENSION(2,9) :: data_out = 0 - INTEGER(HSSIZE_T) , DIMENSION(2,3) :: coord + INTEGER(HSIZE_T) , DIMENSION(2,3) :: coord INTEGER(SIZE_T) ::num_points = 3 ! Number of selected points INTEGER :: i, j INTEGER :: ref_size diff --git a/doc/html/Tutor/examples/selectele.f90 b/doc/html/Tutor/examples/selectele.f90 index c75958c..8727bd9 100644 --- a/doc/html/Tutor/examples/selectele.f90 +++ b/doc/html/Tutor/examples/selectele.f90 @@ -38,7 +38,7 @@ ! Memory dataspace dimensions INTEGER(HSIZE_T), DIMENSION(2) :: dimsf = (/3,4/) ! File dataspace dimensions - INTEGER(HSSIZE_T), DIMENSION(RANK,NUMP) :: coord ! Elements coordinates + INTEGER(HSIZE_T), DIMENSION(RANK,NUMP) :: coord ! Elements coordinates ! in the file INTEGER, DIMENSION(3,4) :: buf1, buf2, bufnew ! Data buffers diff --git a/doc/html/Tutor/select.html b/doc/html/Tutor/select.html index b8381e5..b4109b0 100644 --- a/doc/html/Tutor/select.html +++ b/doc/html/Tutor/select.html @@ -195,7 +195,7 @@ add to the current selected region for a specified dataspace. <I><B>C</B></I>: <pre> herr_t H5Sselect_hyperslab (hid_t space_id, H5S_seloper_t operator, - const hssize_t *start, const hsize_t *stride, + const hsize_t *start, const hsize_t *stride, const hsize_t *count, const hsize_t *block ) </pre> <P> @@ -206,7 +206,7 @@ add to the current selected region for a specified dataspace. space_id IN: INTEGER(HID_T) operator IN: INTEGER - start IN: INTEGER(HSSIZE_T), DIMENSION(*) + start IN: INTEGER(HSIZE_T), DIMENSION(*) count IN: INTEGER(HSIZE_T), DIMENSION(*) hdferr OUT: INTEGER stride IN: INTEGER(HSIZE_T), DIMENSION(*), OPTIONAL diff --git a/doc/html/Tutor/selectc.html b/doc/html/Tutor/selectc.html index c73b754..59c464c 100644 --- a/doc/html/Tutor/selectc.html +++ b/doc/html/Tutor/selectc.html @@ -71,7 +71,7 @@ included in the selection for a dataspace: <pre> herr_t H5Sselect_elements (hid_t space_id, H5S_seloper_t operator, size_t num_elements, - const hssize_t **coord ) + const hsize_t **coord ) </pre> <P> <I><B>FORTRAN</B></I>: @@ -81,7 +81,7 @@ included in the selection for a dataspace: space_id IN: INTEGER(HID_T) operator IN: INTEGER num_elements IN: INTEGER - coord IN: INTEGER(HSSIZE_T), DIMENSION(*,*) + coord IN: INTEGER(HSIZE_T), DIMENSION(*,*) hdferr OUT: INTEGER </pre> <P> diff --git a/doc/html/cpplus/CppInterfaces.html b/doc/html/cpplus/CppInterfaces.html index e8fa070..4b22251 100644 --- a/doc/html/cpplus/CppInterfaces.html +++ b/doc/html/cpplus/CppInterfaces.html @@ -253,10 +253,10 @@ class CompType : public DataType int getNmembers() const; // Returns the name of a member of this compound datatype. - string getMemberName( int member_num ) const; + string getMemberName( unsigned member_num ) const; // Returns the offset of a member of this compound datatype. - size_t getMemberOffset( int memb_no ) const; + size_t getMemberOffset( unsigned memb_no ) const; // Returns the dimensionality of the specified member of this compound datatype. int getMemberDims( int member_num, size_t* dims, int* perm ) const; @@ -264,7 +264,7 @@ class CompType : public DataType // Returns the type class of the specified member of this compound // datatype. It provides to the user a way of knowing what type // to create another datatype of the same class. - H5T_class_t getMemberClass( int member_num ) const; + H5T_class_t getMemberClass( unsigned member_num ) const; // Returns the generic datatype of the specified member in // this compound datatype. @@ -405,7 +405,7 @@ class DataSpace : public IdComponent // Selects array elements to be included in the selection for // this dataspace. - void selectElements ( H5S_seloper_t op, const size_t num_elements, const hssize_t* coord[ ] ) const; + void selectElements ( H5S_seloper_t op, const size_t num_elements, const hsize_t* coord[ ] ) const; // Selects the entire dataspace. void selectAll () const; @@ -417,7 +417,7 @@ class DataSpace : public IdComponent bool selectValid () const; // Selects a hyperslab region to add to the current selected region. - void selectHyperslab( H5S_seloper_t op, const hsize_t *count, const hssize_t *start, const hsize_t *stride = NULL, const hsize_t *block = NULL ) const; + void selectHyperslab( H5S_seloper_t op, const hsize_t *count, const hsize_t *start, const hsize_t *stride = NULL, const hsize_t *block = NULL ) const; // Default constructor DataSpace(); @@ -560,7 +560,7 @@ class DSetCreatPropList : public PropList int getExternalCount() const; // Returns information about an external file - void getExternal( int idx, size_t name_size, char* name, off_t& offset, hsize_t& size ) const; + void getExternal( unsigned idx, size_t name_size, char* name, off_t& offset, hsize_t& size ) const; // Creates a copy of an existing dataset creation property list // using the property list id @@ -674,7 +674,7 @@ class EnumType : public DataType void valueOf( const char* name, void *value ) const; // Returns the value of an enumeration datatype member - void getMemberValue( int memb_no, void *value ) const; + void getMemberValue( unsigned memb_no, void *value ) const; // Default constructor EnumType(); @@ -872,7 +872,7 @@ class FileCreatPropList : public PropList FileCreatPropList& operator=( const FileCreatPropList& rhs ); // Retrieves version information for various parts of a file. - void getVersion( int& boot, int& freelist, int& stab, int& shhdr ) const; + void getVersion( unsigned& boot, unsigned& freelist, unsigned& stab, unsigned& shhdr ) const; // Sets the userblock size field of a file creation property list. void setUserblock( hsize_t size ) const; @@ -888,18 +888,18 @@ class FileCreatPropList : public PropList void getSizes( size_t& sizeof_addr, size_t& sizeof_size ) const; // Sets the size of parameters used to control the symbol table nodes. - void setSymk( int int_nodes_k, int leaf_nodes_k ) const; + void setSymk( unsigned int_nodes_k, unsigned leaf_nodes_k ) const; // Retrieves the size of the symbol table B-tree 1/2 rank and the // symbol table leaf node 1/2 size. - void getSymk( int& int_nodes_k, int& leaf_nodes_k ) const; + void getSymk( unsigned& int_nodes_k, unsigned& leaf_nodes_k ) const; // Sets the size of parameter used to control the B-trees for // indexing chunked datasets. - void setIstorek( int ik ) const; + void setIstorek( unsigned ik ) const; // Returns the 1/2 rank of an indexed storage B-tree. - int getIstorek() const; + unsigned getIstorek() const; // Creates a copy of an existing file create property list // using the property list id. diff --git a/doc/html/h5s.examples b/doc/html/h5s.examples index e7a479f..688382f 100644 --- a/doc/html/h5s.examples +++ b/doc/html/h5s.examples @@ -51,7 +51,7 @@ Example 2: Create a simple fixed size 3-D dataspace in memory and on disk and hid_t dataset; /* Dataset ID */ hid_t mem_space, file_space; /* Dataspaces for memory and the file */ uint8 *buf; /* Buffer for data */ - hssize_t start[3]={3,4,5}; /* Start of hyperslab */ + hsize_t start[3]={3,4,5}; /* Start of hyperslab */ hsize_t stride[3]={1,2,2}; /* Stride for hyperslab */ hsize_t count[3]={3,3,3}; /* Hyperslab block count in each dimension */ hsize_t block[3]={2,2,2}; /* Hyperslab block size in each dimension */ @@ -169,7 +169,7 @@ Example 4: Create a simple fixed size 3-D dataspace in memory and on disk and hid_t dataset; /* Dataset ID */ hid_t mem_space, file_space; /* Dataspaces for memory and the file */ uint8 *buf; /* Buffer for data */ - hssize_t start[3]; /* Start of hyperslab */ + hsize_t start[3]; /* Start of hyperslab */ hsize_t stride[3]; /* Stride for hyperslab */ hsize_t count[3]; /* Hyperslab block count in each dimension */ hsize_t block[3]; /* Hyperslab block size in each dimension */ @@ -299,7 +299,7 @@ Example 6: Create a stored dataspace on disk and use the H5Ssubspace function { hid_t file; /* File ID */ hid_t space1, space2; /* Dataspace IDs */ - hssize_t start[3]; /* Start of hyperslab */ + hsize_t start[3]; /* Start of hyperslab */ hsize_t count[3]; /* Hyperslab block count in each dimension */ hsize_t curr_dims[3]={13,14,15};/* Dimensions of the dataset */ diff --git a/doc/html/ph5example.c b/doc/html/ph5example.c index 84f5ab7..a69f221 100644 --- a/doc/html/ph5example.c +++ b/doc/html/ph5example.c @@ -70,7 +70,7 @@ int dowrite=1; /* write test */ * Assume dimension rank is 2. */ void -slab_set(hssize_t start[], hsize_t count[], hsize_t stride[], int mode) +slab_set(hsize_t start[], hsize_t count[], hsize_t stride[], int mode) { switch (mode){ case BYROW: @@ -110,7 +110,7 @@ slab_set(hssize_t start[], hsize_t count[], hsize_t stride[], int mode) * Assume dimension rank is 2 and data is stored contiguous. */ void -dataset_fill(hssize_t start[], hsize_t count[], hsize_t stride[], DATATYPE * dataset) +dataset_fill(hsize_t start[], hsize_t count[], hsize_t stride[], DATATYPE * dataset) { DATATYPE *dataptr = dataset; int i, j; @@ -127,7 +127,7 @@ dataset_fill(hssize_t start[], hsize_t count[], hsize_t stride[], DATATYPE * dat /* * Print the content of the dataset. */ -void dataset_print(hssize_t start[], hsize_t count[], hsize_t stride[], DATATYPE * dataset) +void dataset_print(hsize_t start[], hsize_t count[], hsize_t stride[], DATATYPE * dataset) { DATATYPE *dataptr = dataset; int i, j; @@ -146,7 +146,7 @@ void dataset_print(hssize_t start[], hsize_t count[], hsize_t stride[], DATATYPE /* * Print the content of the dataset. */ -int dataset_vrfy(hssize_t start[], hsize_t count[], hsize_t stride[], DATATYPE *dataset, DATATYPE *original) +int dataset_vrfy(hsize_t start[], hsize_t count[], hsize_t stride[], DATATYPE *dataset, DATATYPE *original) { #define MAX_ERR_REPORT 10 /* Maximum number of errors reported */ DATATYPE *dataptr = dataset; @@ -204,7 +204,7 @@ phdf5writeInd(char *filename) {SPACE1_DIM1,SPACE1_DIM2}; /* local dataspace dim sizes */ DATATYPE data_array1[SPACE1_DIM1][SPACE1_DIM2]; /* data buffer */ - hssize_t start[SPACE1_RANK]; /* for hyperslab setting */ + hsize_t start[SPACE1_RANK]; /* for hyperslab setting */ hsize_t count[SPACE1_RANK], stride[SPACE1_RANK]; /* for hyperslab setting */ herr_t ret; /* Generic return value */ @@ -342,7 +342,7 @@ phdf5readInd(char *filename) DATATYPE data_array1[SPACE1_DIM1][SPACE1_DIM2]; /* data buffer */ DATATYPE data_origin1[SPACE1_DIM1][SPACE1_DIM2]; /* expected data buffer */ - hssize_t start[SPACE1_RANK]; /* for hyperslab setting */ + hsize_t start[SPACE1_RANK]; /* for hyperslab setting */ hsize_t count[SPACE1_RANK], stride[SPACE1_RANK]; /* for hyperslab setting */ herr_t ret; /* Generic return value */ @@ -466,7 +466,7 @@ phdf5writeAll(char *filename) {SPACE1_DIM1,SPACE1_DIM2}; /* dataspace dim sizes */ DATATYPE data_array1[SPACE1_DIM1][SPACE1_DIM2]; /* data buffer */ - hssize_t start[SPACE1_RANK]; /* for hyperslab setting */ + hsize_t start[SPACE1_RANK]; /* for hyperslab setting */ hsize_t count[SPACE1_RANK], stride[SPACE1_RANK]; /* for hyperslab setting */ herr_t ret; /* Generic return value */ @@ -670,7 +670,7 @@ phdf5readAll(char *filename) DATATYPE data_array1[SPACE1_DIM1][SPACE1_DIM2]; /* data buffer */ DATATYPE data_origin1[SPACE1_DIM1][SPACE1_DIM2]; /* expected data buffer */ - hssize_t start[SPACE1_RANK]; /* for hyperslab setting */ + hsize_t start[SPACE1_RANK]; /* for hyperslab setting */ hsize_t count[SPACE1_RANK], stride[SPACE1_RANK]; /* for hyperslab setting */ herr_t ret; /* Generic return value */ |