From 9fb77d56b800f04e7818190f50193028a134603f Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Tue, 24 Feb 2004 17:10:12 -0500 Subject: [svn-r8221] Purpose: Clean up RM formatting. Modify RM HTML code to facilitate automated generation of PDF version. Minor edits. Description: Reworked format of "Parameters" sections. Added HTML tags (and pseudo-HTML tags) used by HTMLdoc to generate PDF files. Fixed the "Copyright" link on RM_H5Front.html. Other minor copy edits. Platforms tested: IE 5 --- doc/html/Glossary.html | 9 +- doc/html/PredefDTypes.html | 10 +- doc/html/RM_H5.html | 85 +- doc/html/RM_H5A.html | 208 +++-- doc/html/RM_H5D.html | 370 ++++---- doc/html/RM_H5E.html | 145 ++-- doc/html/RM_H5F.html | 262 +++--- doc/html/RM_H5Front.html | 25 +- doc/html/RM_H5G.html | 385 +++++---- doc/html/RM_H5I.html | 68 +- doc/html/RM_H5P.html | 2038 +++++++++++++++++++++++++++----------------- doc/html/RM_H5R.html | 109 +-- doc/html/RM_H5S.html | 378 ++++---- doc/html/RM_H5T.html | 912 +++++++++++--------- doc/html/RM_H5Z.html | 35 +- doc/html/Tools.html | 71 +- 16 files changed, 2984 insertions(+), 2126 deletions(-) diff --git a/doc/html/Glossary.html b/doc/html/Glossary.html index 8564b32..94ff8e5 100644 --- a/doc/html/Glossary.html +++ b/doc/html/Glossary.html @@ -42,8 +42,7 @@ HDF5 Glossary -
-
+

HDF5 Glossary

@@ -239,6 +238,7 @@ HDF5 Glossary supporting metadata.

+

dataset access property list
A property list containing information on how a dataset is to be accessed.

@@ -557,14 +557,13 @@ HDF5 Glossary

-
-
+
HDF Help Desk
Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0
diff --git a/doc/html/PredefDTypes.html b/doc/html/PredefDTypes.html index 4ad5c01..853279a 100644 --- a/doc/html/PredefDTypes.html +++ b/doc/html/PredefDTypes.html @@ -60,8 +60,7 @@ And in this document, the -
-
+

HDF5 Predefined Datatypes

@@ -388,7 +387,7 @@ The following datatypes are predefined in HDF5. - +

FORTRAN90 API datatypes

 @@ -493,14 +492,13 @@ And in this document, the
-
-
+
HDF Help Desk
Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0
diff --git a/doc/html/RM_H5.html b/doc/html/RM_H5.html index 4232ac6..0f7d673 100644 --- a/doc/html/RM_H5.html +++ b/doc/html/RM_H5.html @@ -22,10 +22,7 @@ HDF5/H5 API Specification --> - - - - +
@@ -60,8 +57,7 @@ And in this document, the
-
-
+

H5: General Library Functions

@@ -240,14 +236,17 @@ facilitate moving easily between them. the 1 is the release number, relnum. -->
Parameters: -
-
unsigned majnum -
IN: The major version of the library. -
unsigned minnum -
IN: The minor version of the library. -
unsigned relnum -
IN: The release number of the library. -
+
    + + + + + + + + + +
    unsigned majnumIN: The major version of the library.
    unsigned minnum    IN: The minor version of the library.
    unsigned relnumIN: The release number of the library.
Returns:
Returns a non-negative value if successful. Upon failure, this function causes the application to abort. @@ -429,14 +428,17 @@ END SUBROUTINE h5garbage_collect_f numbers of the version of the HDF library which is linked to the application.
Parameters: -
-
unsigned *majnum -
OUT: The major version of the library. -
unsigned *minnum -
OUT: The minor version of the library. -
unsigned *relnum -
OUT: The release number of the library. -
+
    + + + + + + + + + +
    unsigned *majnumOUT: The major version of the library.
    unsigned *minnum    OUT: The minor version of the library.
    unsigned *relnumOUT: The release number of the library.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. @@ -559,20 +561,26 @@ END SUBROUTINE h5open_f Using a value of -1 for a limit means that no limit is set for the specified type of free list.
Parameters: -
-
int reg_global_lim -
IN: The limit on all regular free list memory used -
int reg_list_lim -
IN: The limit on memory used in each regular free list -
int arr_global_lim -
IN: The limit on all array free list memory used -
int arr_list_lim -
IN: The limit on memory used in each array free list -
int blk_global_lim -
IN: The limit on all block free list memory used -
int blk_list_lim -
IN: The limit on memory used in each block free list -
+
    + + + + + + + + + + + + + + + + + + +
    int reg_global_lim    IN: The limit on all regular free list memory used
    int reg_list_limIN: The limit on memory used in each regular free list
    int arr_global_limIN: The limit on all array free list memory used
    int arr_list_limIN: The limit on memory used in each array free list
    int blk_global_limIN: The limit on all block free list memory used
    int blk_list_limIN: The limit on memory used in each block free list
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. @@ -626,14 +634,13 @@ And in this document, the
-
-
+
HDF Help Desk
Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0
diff --git a/doc/html/RM_H5A.html b/doc/html/RM_H5A.html index b3334bf..68b51c3 100644 --- a/doc/html/RM_H5A.html +++ b/doc/html/RM_H5A.html @@ -61,8 +61,7 @@ And in this document, the -
-
+

H5A: Attribute Interface

@@ -205,10 +204,11 @@ See Attributes in the Further use of a released attribute identifier is illegal; a function using such an identifier will fail.
Parameters: -
-
hid_t attr_id -
IN: Attribute to release access to. -
+
    + + + +
    hid_t attr_idIN: Attribute to release access to.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. @@ -237,11 +237,11 @@ END SUBROUTINE h5aclose_f
Name: H5Acreate
Signature: -
hid_t H5Acreate(hid_t loc_id, +
hid_t H5Acreate(hid_t loc_id, const char *name, hid_t type_id, hid_t space_id, - hid_t create_plist + hid_t create_plist )
Purpose:
Creates a dataset as an attribute of another group, dataset, @@ -272,19 +272,24 @@ END SUBROUTINE h5aclose_f The attribute identifier returned from this function must be released with H5Aclose or resource leaks will develop.
Parameters: -
-
hid_t loc_id
-
IN: Object (dataset, group, or named datatype) to be attached to.
-
const char *name
-
IN: Name of attribute to create.
-
hid_t type_id
-
IN: Identifier of datatype for attribute.
-
hid_t space_id
-
IN: Identifier of dataspace for attribute.
-
hid_t create_plist
-
IN: Identifier of creation property list. (Currently unused; - the only accepted value is H5P_DEFAULT.)
-
+
    + + + + + + + + + + + + + + + +
    hid_t loc_idIN: Object (dataset, group, or named datatype) to be attached to.
    const char *nameIN: Name of attribute to create.
    hid_t type_idIN: Identifier of datatype for attribute.
    hid_t space_idIN: Identifier of dataspace for attribute.
    hid_t create_plist    IN: Identifier of creation property list. (Currently unused; + the only accepted value is H5P_DEFAULT.)
Returns:
Returns an attribute identifier if successful; otherwise returns a negative value. @@ -333,13 +338,15 @@ END SUBROUTINE h5acreate_f of the attributes to change and future writes to the open attributes to produce incorrect results.
Parameters: -
-
hid_t loc_id -
IN: Identifier of the dataset, group, or named datatype - to have the attribute deleted from. -
const char *name -
IN: Name of the attribute to delete. -
+
    + + + + + + +
    hid_t loc_idIN: Identifier of the dataset, group, or named datatype + to have the attribute deleted from.
    const char *name    IN: Name of the attribute to delete.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. @@ -384,14 +391,17 @@ END SUBROUTINE h5adelete_f (buf_size -1), the string terminator is stored in the last position of the buffer to properly terminate the string.
Parameters: -
-
hid_t attr_id -
IN: Identifier of the attribute. -
size_t buf_size -
IN: The size of the buffer to store the name in. -
char *buf -
IN: Buffer to store name in. -
+
    + + + + + + + + + +
    hid_t attr_idIN: Identifier of the attribute.
    size_t buf_size    IN: The size of the buffer to store the name in.
    char *bufIN: Buffer to store name in.
Returns:
Returns the length of the attribute's name, which may be longer than buf_size, if successful. @@ -432,10 +442,11 @@ END SUBROUTINE h5aget_name_f loc_id. The object can be a group, dataset, or named datatype.
Parameters: -
-
hid_t loc_id -
IN: Identifier of a group, dataset, or named datatype. -
+
    + + + +
    hid_t loc_id    IN: Identifier of a group, dataset, or named datatype.
Returns:
Returns the number of attributes if successful; otherwise returns a negative value. @@ -474,10 +485,11 @@ END SUBROUTINE h5aget_num_attrs_f this function must be released with H5Sclose or resource leaks will develop.
Parameters: -
-
hid_t attr_id -
IN: Identifier of an attribute. -
+
    + + + +
    hid_t attr_id    IN: Identifier of an attribute.
Returns:
Returns attribute dataspace identifier if successful; otherwise returns a negative value. @@ -522,10 +534,11 @@ END SUBROUTINE h5aget_space_f The datatype identifier returned from this function must be released with H5Tclose or resource leaks will develop.
Parameters: -
-
hid_t attr_id -
IN: Identifier of an attribute. -
+
    + + + +
    hid_t attr_id    IN: Identifier of an attribute.
Returns:
Returns a datatype identifier if successful; otherwise returns a negative value. @@ -598,16 +611,20 @@ END SUBROUTINE h5aget_type_f attribute.
Parameters: -
-
hid_t loc_id -
IN: Identifier of a group, dataset or named datatype. -
unsigned * idx -
IN/OUT: Starting (IN) and ending (OUT) attribute index. -
H5A_operator_t op -
IN: User's function to pass each attribute to -
void *op_data -
IN/OUT: User's data to pass through to iterator operator function -
+
    + + + + + + + + + + + + +
    hid_t loc_idIN: Identifier of a group, dataset or named datatype.
    unsigned * idxIN/OUT: Starting (IN) and ending (OUT) attribute index.
    H5A_operator_t op    IN: User's function to pass each attribute to
    void *op_dataIN/OUT: User's data to pass through to iterator operator function
Returns:
If successful, returns the return value of the last operator if it was non-zero, or zero if all attributes were processed. @@ -650,13 +667,15 @@ SUBROUTINE The attribute identifier returned from this function must be released with H5Aclose or resource leaks will develop.
Parameters: -
-
hid_t loc_id -
IN: Identifier of the group, dataset, or named datatype - attribute to be attached to. -
unsigned int idx -
IN: Index of the attribute to open. -
+
    + + + + + + +
    hid_t loc_idIN: Identifier of the group, dataset, or named datatype + attribute to be attached to.
    unsigned int idx    IN: Index of the attribute to open.
Returns:
Returns attribute identifier if successful; otherwise returns a negative value. @@ -702,13 +721,15 @@ END SUBROUTINE h5aopen_idx_f be released with H5Aclose or resource leaks will develop.
Parameters: -
-
hid_t loc_id -
IN: Identifier of a group, dataset, or named datatype - atttribute to be attached to. -
const char *name -
IN: Attribute name. -
+
    + + + + + + +
    hid_t loc_idIN: Identifier of a group, dataset, or named datatype + atttribute to be attached to.
    const char *name    IN: Attribute name.
Returns:
Returns attribute identifier if successful; otherwise returns a negative value. @@ -759,14 +780,17 @@ END SUBROUTINE h5aopen_name_f data conversion, including the range of conversions currently supported by the HDF5 libraries.
Parameters: -
-
hid_t attr_id -
IN: Identifier of an attribute to read. -
hid_t mem_type_id -
IN: Identifier of the attribute datatype (in memory). -
void *buf -
OUT: Buffer for data to be read. -
+
    + + + + + + + + + +
    hid_t attr_idIN: Identifier of an attribute to read.
    hid_t mem_type_id    IN: Identifier of the attribute datatype (in memory).
    void *bufOUT: Buffer for data to be read.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. @@ -826,14 +850,17 @@ END SUBROUTINE h5aread_f data conversion, including the range of conversions currently supported by the HDF5 libraries.
Parameters: -
-
hid_t attr_id -
IN: Identifier of an attribute to write. -
hid_t mem_type_id -
IN: Identifier of the attribute datatype (in memory). -
const void *buf -
IN: Data to be written. -
+
    + + + + + + + + + +
    hid_t attr_idIN: Identifier of an attribute to write.
    hid_t mem_type_id    IN: Identifier of the attribute datatype (in memory).
    const void *bufIN: Data to be written.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. @@ -900,14 +927,13 @@ And in this document, the
-
-
+
HDF Help Desk
Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0
diff --git a/doc/html/RM_H5D.html b/doc/html/RM_H5D.html index 59e5fb6..f77a3ec 100644 --- a/doc/html/RM_H5D.html +++ b/doc/html/RM_H5D.html @@ -61,8 +61,7 @@ And in this document, the -
-
+

H5D: Datasets Interface

@@ -207,10 +206,11 @@ as the corresponding C function. Further use of the dataset identifier is illegal in calls to the dataset API.
Parameters: -
-
hid_t dataset_id -
IN: Identifier of the dataset to close access to. -
+
    + + + +
    hid_t dataset_id    IN: Identifier of the dataset to close access to.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. @@ -294,15 +294,15 @@ END SUBROUTINE h5dclose_f
  - H5Dfill
- H5Pset_fill_value
- H5Pget_fill_value
- H5Pfill_value_defined + H5Dfill
+ H5Pset_fill_value
+ H5Pget_fill_value
+ H5Pfill_value_defined 		- H5Pset_fill_time
- H5Pget_fill_time
- H5Pset_alloc_time
- H5Pget_alloc_time + H5Pset_fill_time
+ H5Pget_fill_time
+ H5Pset_alloc_time
+ H5Pget_alloc_time
This information is also included in the @@ -310,21 +310,27 @@ END SUBROUTINE h5dclose_f the new HDF5 User's Guide, which is being prepared for release.
Parameters: -
-
hid_t loc_id -
IN: Identifier of the file or group - within which to create the dataset. -
const char * name -
IN: The name of the dataset to create. -
hid_t type_id -
IN: Identifier of the datatype to use - when creating the dataset. -
hid_t space_id -
IN: Identifier of the dataspace to use - when creating the dataset. -
hid_t create_plist_id -
IN: Identifier of the set creation property list. -
+
    + + + + + + + + + + + + + + + +
    hid_t loc_idIN: Identifier of the file or group + within which to create the dataset.
    const char * nameIN: The name of the dataset to create.
    hid_t type_idIN: Identifier of the datatype to use + when creating the dataset.
    hid_t space_idIN: Identifier of the dataspace to use + when creating the dataset.
    hid_t create_plist_id    IN: Identifier of the set creation property list.
+
Returns:
Returns a dataset identifier if successful; otherwise returns a negative value. @@ -386,12 +392,14 @@ END SUBROUTINE h5dcreate_f H5Pset_alloc_time.)
Parameters: -
-
hid_t dataset_id -
IN: Identifier of the dataset. -
const hsize_t * size -
IN: Array containing the new magnitude of each dimension. -
+
    + + + + + + +
    hid_t dataset_idIN: Identifier of the dataset.
    const hsize_t * size    IN: Array containing the new magnitude of each dimension.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. @@ -465,20 +473,25 @@ END SUBROUTINE h5dextend_f and H5Dcreate.
Parameters: -
-
const void *fill -
IN: Pointer to the fill value to be used. -
hid_t fill_type_id -
IN: Fill value datatype identifier. -
void *buf -
IN/OUT: Pointer to the memory buffer containing the - selection to be filled. -
hid_t buf_type_id -
IN: Datatype of dataspace elements to be filled. -
hid_t space_id -
IN: Dataspace describing memory buffer and - containing the selection to be filled. -
+
    + + + + + + + + + + + + + + + +
    const void *fillIN: Pointer to the fill value to be used.
    hid_t fill_type_id    IN: Fill value datatype identifier.
    void *bufIN/OUT: Pointer to the memory buffer containing the + selection to be filled.
    hid_t buf_type_idIN: Datatype of dataspace elements to be filled.
    hid_t space_idIN: Dataspace describing memory buffer and + containing the selection to be filled.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. @@ -524,10 +537,11 @@ END SUBROUTINE h5dfill_f The creation property list identifier should be released with the H5Pclose function.
Parameters: -
-
hid_t dataset_id -
IN: Identifier of the dataset to query. -
+
    + + + +
    hid_t dataset_id    IN: Identifier of the dataset to query.
Returns:
Returns a dataset creation property list identifier if successful; otherwise returns a negative value. @@ -568,10 +582,11 @@ END SUBROUTINE h5dget_create_plist_f That address is expressed as the offset in bytes from the beginning of the file.
Parameters: -
-
hid_t dset_id -
Dataset identifier. -
+
    + + + +
    hid_t dset_id    Dataset identifier.
Returns:
Returns the offset in bytes; otherwise returns HADDR_UNDEF, a negative value. @@ -607,10 +622,11 @@ SUBROUTINE The dataspace identifier should be released with the H5Sclose function.
Parameters: -
-
hid_t dataset_id -
IN: Identifier of the dataset to query. -
+
    + + + +
    hid_t dataset_id    IN: Identifier of the dataset to query.
Returns:
Returns a dataspace identifier if successful; otherwise returns a negative value. @@ -653,15 +669,15 @@ END SUBROUTINE h5dget_space_f
     - H5D_SPACE_STATUS_NOT_ALLOCATED + H5D_SPACE_STATUS_NOT_ALLOCATED Space has not been allocated for this dataset.
- H5D_SPACE_STATUS_ALLOCATED + H5D_SPACE_STATUS_ALLOCATED Space has been allocated for this dataset.
- H5D_SPACE_STATUS_PART_ALLOCATED   + H5D_SPACE_STATUS_PART_ALLOCATED   Space has been partially allocated for this dataset. (Used only for datasets with chunked storage.) @@ -669,12 +685,14 @@ END SUBROUTINE h5dget_space_f
Parameters: -
-
hid_t dset_id -
IN: Identifier of the dataset to query. -
H5D_space_status_t *status -
OUT: Space allocation status. -
+
    + + + + + + +
    hid_t dset_idIN: Identifier of the dataset to query.
    H5D_space_status_t *status    OUT: Space allocation status.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. @@ -719,10 +737,11 @@ END SUBROUTINE h5dget_space_status_f the chunk size. The return value may be zero if no data has been stored.
Parameters: -
-
hid_t dataset_id -
IN: Identifier of the dataset to query. -
+
    + + + +
    hid_t dataset_id    IN: Identifier of the dataset to query.
Returns:
Returns the amount of storage space allocated for the dataset, not counting meta data; @@ -768,10 +787,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.
Parameters: -
-
hid_t dataset_id -
IN: Identifier of the dataset to query. -
+
    + + + +
    hid_t dataset_id    IN: Identifier of the dataset to query.
Returns:
Returns a datatype identifier if successful; otherwise returns a negative value. @@ -822,23 +842,28 @@ END SUBROUTINE h5dget_type_f the iteration may then be re-started by the user where it left off.
Parameters: -
-
void *buf -
IN/OUT: Pointer to the buffer in memory containing the - elements to iterate over. -
hid_t type_id -
IN: Datatype identifier for the elements stored in - buf. -
hid_t space_id -
IN: Dataspace identifier for buf. - Also contains the selection to iterate over. -
H5D_operator_t operator -
IN: Function pointer to the routine to be called - for each element in buf iterated over. -
void *operator_data -
IN/OUT: Pointer to any user-defined data associated - with the operation. -
+
    + + + + + + + + + + + + + + + +
    void *bufIN/OUT: Pointer to the buffer in memory containing the + elements to iterate over.
    hid_t type_idIN: Datatype identifier for the elements stored in + buf.
    hid_t space_idIN: Dataspace identifier for buf. + Also contains the selection to iterate over.
    H5D_operator_t operator    IN: Function pointer to the routine to be called + for each element in buf iterated over.
    void *operator_dataIN/OUT: Pointer to any user-defined data associated + with the operation.
Returns:
Returns the return value of the last operator if it was non-zero, or zero if all elements have been processed. @@ -875,13 +900,15 @@ SUBROUTINE or group specified in loc_id. name is a dataset name and is used to identify the dataset in the file.
Parameters: -
-
hid_t loc_id -
IN: Identifier of the file or group - within which the dataset to be accessed will be found. -
const char * name -
IN: The name of the dataset to access. -
+
    + + + + + + +
    hid_t loc_idIN: Identifier of the file or group + within which the dataset to be accessed will be found.
    const char * name    IN: The name of the dataset to access.
Returns:
Returns a dataset identifier if successful; otherwise returns a negative value. @@ -1049,21 +1076,27 @@ END SUBROUTINE h5dopen_f data conversion, including the range of conversions currently supported by the HDF5 libraries.
Parameters: -
-
hid_t dataset_id -
IN: Identifier of the dataset read from. -
hid_t mem_type_id -
IN: Identifier of the memory datatype. -
hid_t mem_space_id -
IN: Identifier of the memory dataspace. -
hid_t file_space_id -
IN: Identifier of the dataset's dataspace in the file. -
hid_t xfer_plist_id -
IN: Identifier of a transfer property list - for this I/O operation. -
void * buf -
OUT: Buffer to receive data read from file. -
+
    + + + + + + + + + + + + + + + + + + +
    hid_t dataset_idIN: Identifier of the dataset read from.
    hid_t mem_type_idIN: Identifier of the memory datatype.
    hid_t mem_space_idIN: Identifier of the memory dataspace.
    hid_t file_space_id    IN: Identifier of the dataset's dataspace in the file.
    hid_t xfer_plist_id    IN: Identifier of a transfer property list + for this I/O operation.
    void * bufOUT: Buffer to receive data read from file.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. @@ -1077,7 +1110,7 @@ END SUBROUTINE h5dopen_f 
-SUBROUTINE h5dread_f(dset_id, mem_type_id, buf, dims, hdferr, &
+SUBROUTINE h5dread_f(dset_id, mem_type_id, buf, dims, hdferr, & 
                      mem_space_id, file_space_id, xfer_prp)
 
   IMPLICIT NONE
@@ -1107,11 +1140,12 @@ SUBROUTINE h5dread_f(dset_id, mem_type_id, buf, dims, hdferr, &
 END SUBROUTINE h5dread_f
+

Use this h5dread_f call for object reference and dataset region reference datatypes: 

-SUBROUTINE h5dread_f(dset_id, mem_type_id, buf, n, hdferr, &
+SUBROUTINE h5dread_f(dset_id, mem_type_id, buf, n, hdferr, & 
                      mem_space_id, file_space_id, xfer_prp)
 
   IMPLICIT NONE
@@ -1172,16 +1206,21 @@ END SUBROUTINE h5dread_f
         *size is returned with the number of bytes 
         required to store the VL data in memory.          
 
Parameters:
-    

-        
hid_t dataset_id
-            
IN: Identifier of the dataset to query.
-        
hid_t type_id
-            
IN: Datatype identifier.
-        
hid_t space_id
-            
IN: Dataspace identifier.
-        
hsize_t *size
-            
OUT: The size in bytes of the memory buffer required to store the VL data.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t dataset_id    IN: Identifier of the dataset to query.
    hid_t type_idIN: Datatype identifier.
    hid_t space_idIN: Dataspace identifier.
    hsize_t *sizeOUT: The size in bytes of the memory 
+			                 buffer required to store the VL data.

 
Returns:
     
Returns non-negative value if successful;
         otherwise returns a negative value.
@@ -1241,16 +1280,20 @@ END SUBROUTINE h5dvlen_get_max_len_f
         this routine frees them from the bottom up, releasing all 
         the memory without creating memory leaks.
 
Parameters:
-    

-        
hid_t type_id
-            
IN: Identifier of the datatype.
-        
hid_t space_id
-            
IN: Identifier of the dataspace.
-        
hid_t plist_id
-            
IN: Identifier of the property list used to create the buffer.
-        
void *buf
-            
IN: Pointer to the buffer to be reclaimed.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t type_idIN: Identifier of the datatype.
    hid_t space_id    IN: Identifier of the dataspace.
    hid_t plist_idIN: Identifier of the property list used to create the buffer.
    void *bufIN: Pointer to the buffer to be reclaimed.

 
Returns:
     
Returns non-negative value if successful;
         otherwise returns a negative value.
@@ -1431,21 +1474,27 @@ SUBROUTINE
         write identical data to the dataset from all processes.
 	
 
Parameters:
-    

-        
hid_t dataset_id
-            
IN: Identifier of the dataset to write to.
-        
hid_t mem_type_id
-            
IN: Identifier of the memory datatype.
-        
hid_t mem_space_id
-            
IN: Identifier of the memory dataspace.
-        
hid_t file_space_id
-            
IN: Identifier of the dataset's dataspace in the file.
-        
hid_t xfer_plist_id
-            
IN: Identifier of a transfer property list 
-                for this I/O operation.
-        
const void * buf
-            
IN: Buffer with data to be written to the file.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t dataset_idIN: Identifier of the dataset to write to.
    hid_t mem_type_idIN: Identifier of the memory datatype.
    hid_t mem_space_idIN: Identifier of the memory dataspace.
    hid_t file_space_id    IN: Identifier of the dataset's dataspace in the file.
    hid_t xfer_plist_idIN: Identifier of a transfer property list 
+                for this I/O operation.
    const void * bufIN: Buffer with data to be written to the file.

 
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -1459,14 +1508,16 @@ SUBROUTINE
 	
 	

 	
-SUBROUTINE h5dwrite_f(dset_id, mem_type_id, buf, dims, hdferr, &
+SUBROUTINE h5dwrite_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(IN) :: buf                    ! Data buffer; may be a scalar 
-                                             ! or an array
+                                             ! or an array

+
+
   DIMENSION(*), INTEGER(HSIZE_T), INTENT(IN)  :: dims 
                                              ! Array to hold corresponding 
                                              ! dimension sizes of data 
@@ -1494,7 +1545,7 @@ END SUBROUTINE h5dwrite_f
 	   and dataset region reference datatypes:
 
 	
-SUBROUTINE h5dwrite_f(dset_id, mem_type_id, buf, n, hdferr, &
+SUBROUTINE h5dwrite_f(dset_id, mem_type_id, buf, n, hdferr, & 
                       mem_space_id, file_space_id, xfer_prp)
 
   IMPLICIT NONE
@@ -1566,14 +1617,13 @@ And in this document, the
-
-
+
HDF Help Desk
Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0
diff --git a/doc/html/RM_H5E.html b/doc/html/RM_H5E.html index 6d1efa4..8f4d3ce 100644 --- a/doc/html/RM_H5E.html +++ b/doc/html/RM_H5E.html @@ -61,8 +61,7 @@ And in this document, the -
-
+

H5E: Error Interface

@@ -203,9 +202,9 @@ errors within the H5E package. H5Eclear can fail if there are problems initializing the library.
Parameters: -
-
None -
+
    + +
    None
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. @@ -245,13 +244,15 @@ END SUBROUTINE h5eclear_f and its data, client_data. Either (or both) arguments may be null in which case the value is not returned.
Parameters: -
-
H5E_auto_t * func -
OUT: Current setting for the function to be called upon an - error condition. -
void **client_data -
OUT: Current setting for the data passed to the error function. -
+
    + + + + + + +
    H5E_auto_t * funcOUT: Current setting for the function to be called upon an + error condition.
    void **client_data    OUT: Current setting for the data passed to the error function.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. @@ -286,10 +287,11 @@ SUBROUTINE
Given a major error number, H5Eget_major returns a constant character string that describes the error.
Parameters: -
-
H5E_major_t n -
IN: Major error number. -
+
    + + + +
    H5E_major_t n    IN: Major error number.
Returns:
Returns a character string describing the error if successful. Otherwise returns "Invalid major error number." @@ -326,10 +328,11 @@ END SUBROUTINE h5eget_major_f
Given a minor error number, H5Eget_minor returns a constant character string that describes the error.
Parameters: -
-
H5E_minor_t n -
IN: Minor error number. -
+
    + + + +
    H5E_minor_t n    IN: Minor error number.
Returns:
Returns a character string describing the error if successful. Otherwise returns "Invalid minor error number." @@ -372,10 +375,11 @@ END SUBROUTINE h5eget_minor_f H5Ewalk with a function that prints error messages. Users are encouraged to write their own more specific error handlers.
Parameters: -
-
FILE * stream -
IN: File pointer, or stderr if NULL. -
+
    + + + +
    FILE * stream    IN: File pointer, or stderr if NULL.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. @@ -427,20 +431,26 @@ END SUBROUTINE h5eprint_f The function name, file name, and error description strings must be statically allocated.
Parameters: -
-
const char *file, -
IN: Name of the file in which the error was detected. -
const char *func, -
IN: Name of the function in which the error was detected. -
unsigned line, -
IN: Line within the file at which the error was detected. -
H5E_major_t maj_num, -
IN: Major error number. -
H5E_minor_t min_num, -
IN: Minor error number. -
const char *str -
IN: Error description string. -
+
    + + + + + + + + + + + + + + + + + + +
    const char *file,IN: Name of the file in which the error was detected.
    const char *func,IN: Name of the function in which the error was detected.
    unsigned line,IN: Line within the file at which the error was detected.
    H5E_major_t maj_num,    IN: Major error number.
    H5E_minor_t min_num,IN: Minor error number.
    const char *strIN: Error description string.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. @@ -487,12 +497,14 @@ SUBROUTINE Automatic stack traversal is always in the H5E_WALK_DOWNWARD direction.
Parameters: -
-
H5E_auto_t func -
IN: Function to be called upon an error condition. -
void *client_data -
IN: Data passed to the error function. -
+
    + + + + + + +
    H5E_auto_t funcIN: Function to be called upon an error condition.
    void *client_data    IN: Data passed to the error function.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. @@ -576,14 +588,17 @@ END SUBROUTINE h5eset_auto_f H5Ewalk can fail if there are problems initializing the library.
Parameters: -
-
H5E_direction_t direction -
IN: Direction in which the error stack is to be walked. -
H5E_walk_t func -
IN: Function to be called for each error encountered. -
void * client_data -
IN: Data to be passed with func. -
+
    + + + + + + + + + +
    H5E_direction_t direction    IN: Direction in which the error stack is to be walked.
    H5E_walk_t funcIN: Function to be called for each error encountered.
    void * client_dataIN: Data to be passed with func.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. @@ -639,15 +654,18 @@ SUBROUTINE client_data argument of H5Ewalk. It is expected to be a file pointer (or stderr if NULL).
Parameters: -
-
int n -
IN/OUT: Number of times this function has been called - for this traversal of the stack. -
H5E_error_t *err_desc -
OUT: Error description. -
void *client_data -
IN: A file pointer, or stderr if NULL. -
+
    + + + + + + + + + +
    int nIN/OUT: Number of times this function has been called + for this traversal of the stack.
    H5E_error_t *err_desc    OUT: Error description.
    void *client_dataIN: A file pointer, or stderr if NULL.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. @@ -701,14 +719,13 @@ And in this document, the
-
-
+
HDF Help Desk
Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0
diff --git a/doc/html/RM_H5F.html b/doc/html/RM_H5F.html index ef2d9d0..6d662a3 100644 --- a/doc/html/RM_H5F.html +++ b/doc/html/RM_H5F.html @@ -61,8 +61,7 @@ And in this document, the -
-
+

H5F: File Interface

@@ -234,10 +233,11 @@ facilitate moving easily between them. in a file before calling H5Fclose. It is generally recommended to do so in all cases.
Parameters: -
-
hid_t file_id -
IN: Identifier of a file to terminate access to. -
+
    + + + +
    hid_t file_id    IN: Identifier of a file to terminate access to.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. @@ -327,11 +327,13 @@ END SUBROUTINE h5fclose_f with an already opened file.
Parameters: -
-
const char *name -
IN: Name of the file to access. -
uintn flags -
IN: File access flags. Allowable values are: +
    + + + + + + + + + + + + +
    const char *name    IN: Name of the file to access.
    uintn flagsIN: File access flags. Allowable values are:
      H5F_ACC_TRUNC
      Truncate file, if it already exists, @@ -344,18 +346,20 @@ END SUBROUTINE h5fclose_f
    • An additional flag, H5F_ACC_DEBUG, prints debug information. This flag is used only by HDF5 library developers; it is neither tested nor supported - for use in applications. -
      hid_t create_id -
      IN: File creation property list identifier, used when modifying + for use in applications.
    hid_t create_id    IN: File creation property list identifier, used when modifying default file meta-data. - Use H5P_DEFAULT for default file creation properties. -
    hid_t access_id -
    IN: File access property list identifier. + Use H5P_DEFAULT for default file creation properties.
    hid_t access_idIN: File access property list identifier. If parallel file access is desired, this is a collective call according to the communicator stored in the access_id. - Use H5P_DEFAULT for default file access properties. - + Use H5P_DEFAULT for default file access properties.
Returns:
Returns a file identifier if successful; otherwise returns a negative value. @@ -419,16 +423,14 @@ END SUBROUTINE h5fcreate_f

scope specifies whether the scope of the flushing action is global or local. Valid values are -

- + - - + + - +
H5F_SCOPE_GLOBAL
H5F_SCOPE_GLOBAL     Flushes the entire virtual file.
H5F_SCOPE_LOCALFlushes the entire virtual file.
H5F_SCOPE_LOCAL Flushes only the specified file.
Flushes only the specified file.
-
Note:
HDF5 does not possess full control over buffering. H5Fflush flushes the internal HDF5 buffers then @@ -436,12 +438,14 @@ END SUBROUTINE h5fcreate_f open files. After that, the OS is responsible for ensuring that the data is actually flushed to disk.
Parameters: -
-
hid_t object_id -
IN: Identifier of object used to identify the file. -
H5F_scope_t scope -
IN: Specifies the scope of the flushing action. -
+
    + + + + + + +
    hid_t object_idIN: Identifier of object used to identify the file.
    H5F_scope_t scope    IN: Specifies the scope of the flushing action.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. @@ -488,10 +492,11 @@ END SUBROUTINE h5fflush_f HDF5 User's Guide for additional information and related functions.
Parameters: -
-
hid_t file_id -
IN: Identifier of file to get access property list of -
+
    + + + +
    hid_t file_id    IN: Identifier of file to get access property list of
Returns:
Returns a file access property list identifier if successful; otherwise returns a negative value. @@ -540,10 +545,11 @@ END SUBROUTINE h5fget_access_plist_f HDF5 User's Guide for additional information and related functions.
Parameters: -
-
hid_t file_id -
IN: Identifier of the file to get creation property list of -
+
    +
    +
    + +
    hid_t file_id    IN: Identifier of the file to get creation property list of
Returns:
Returns a file creation property list identifier if successful; otherwise returns a negative value. @@ -589,10 +595,11 @@ END SUBROUTINE h5fget_create_plist_f only report the free space that has been created during that interval.
Parameters: -
-
hid_t file_id -
IN: Identifier of a currently-open HDF5 file -
+
    + + + +
    hid_t file_id    IN: Identifier of a currently-open HDF5 file
Returns:
Returns a the amount of free space in the file if successful; otherwise returns a negative value. @@ -681,13 +688,15 @@ END SUBROUTINE h5fget_freespace_f For example, the expression (H5F_OBJ_DATASET|H5F_OBJ_GROUP) would call for datasets and groups.
Parameters: -
-
hid_t file_id -
IN: Identifier of a currently-open HDF5 file or - H5F_OBJ_ALL for all currently-open HDF5 files. -
unsigned int types -
IN: Type of object for which identifiers are to be returned. -
+
    + + + + + + +
    hid_t file_idIN: Identifier of a currently-open HDF5 file or + H5F_OBJ_ALL for all currently-open HDF5 files.
    unsigned int types    IN: Type of object for which identifiers are to be returned.
Returns:
Returns a the number of open objects if successful; otherwise returns a negative value. @@ -748,17 +757,22 @@ END SUBROUTINE h5fget_obj_count_f To retrieve identifiers for all open objects, pass a negative value for the max_objs.
Parameters: -
-
hid_t file_id -
IN: Identifier of a currently-open HDF5 file or - H5F_OBJ_ALL for all currently-open HDF5 files. -
unsigned int types -
IN: Type of object for which identifiers are to be returned. -
int max_objs -
IN: Maximum number of object identifiers to place into obj_id_list. -
hid_t *obj_id_list -
OUT: Pointer to the returned list of open object identifiers. -
+
    + + + + + + + + + + + + +
    hid_t file_idIN: Identifier of a currently-open HDF5 file or + H5F_OBJ_ALL for all currently-open HDF5 files.
    unsigned int typesIN: Type of object for which identifiers are to be returned.
    int max_objsIN: Maximum number of object identifiers to place into + obj_id_list.
    hid_t *obj_id_list    OUT: Pointer to the returned list of open object identifiers.
Returns:
Returns number of objects placed into obj_id_list if successful; otherwise returns a negative value. @@ -818,22 +832,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.
Parameters: -
-
hid_t file_id -
IN: Identifier of the file to be queried. -
hid_t fapl_id -
IN: File access property list identifier. +
    + + + + + + + + + +
    hid_t file_idIN: Identifier of the file to be queried.
    hid_t fapl_idIN: File access property list identifier. For most drivers, the value will be H5P_DEFAULT. - For the FAMILY or MULTI drivers, - this value should be defined through the property list - functions: - H5Pset_family_offset for the FAMILY - driver and H5Pset_multi_type for the - MULTI driver. -
    void *file_handle -
    OUT: Pointer to the file handle being used by - the low-level virtual file driver. - + For the FAMILY or MULTI drivers, + this value should be defined through the property list + functions: + H5Pset_family_offset for the FAMILY + driver and H5Pset_multi_type for the + MULTI driver.
    void *file_handle    OUT: Pointer to the file handle being used by + the low-level virtual file driver.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. @@ -868,10 +885,11 @@ SUBROUTINE
H5Fis_hdf5 determines whether a file is in the HDF5 format.
Parameters: -
-
const char *name -
IN: File name to check format. -
+
    + + + +
    const char *name    IN: File name to check format.
Returns:
When successful, returns a positive value, for TRUE, or 0 (zero), for FALSE. @@ -920,19 +938,23 @@ END SUBROUTINE h5fis_hdf5_f Note that loc_id is either a file or group identifier and name is relative to loc_id.
Parameters: -
-
hid_t loc_id -
IN: Identifier for of file or group in - which name is defined. -
const char *name -
IN: Name of the group onto which the +
    + + + + + + + + + + + + +
    hid_t loc_idIN: Identifier for of file or group in + which name is defined.
    const char *name    IN: Name of the group onto which the file specified by child_id - is to be mounted. -
    hid_t child_id -
    IN: Identifier of the file to be mounted. -
    hid_t plist_id -
    IN: Identifier of the property list to be used. - + is to be mounted.
    hid_t child_idIN: Identifier of the file to be mounted.
    hid_t plist_idIN: Identifier of the property list to be used.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. @@ -1020,11 +1042,13 @@ END SUBROUTINE h5fmount_f multiple opens of the same file.
Parameters: -
-
const char *name -
IN: Name of the file to access. -
unsigned flags -
IN: File access flags. Allowable values are: +
    + + + + + + + + + + +
    const char *name    IN: Name of the file to access.
    unsigned flagsIN: File access flags. Allowable values are:
      H5F_ACC_RDWR
      Allow read and write access to file. @@ -1037,14 +1061,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. -
    -
    hid_t access_id -
    IN: Identifier for the file access properties list. +
    hid_t access_id    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 access_id. - Use H5P_DEFAULT for default file access properties. - + Use H5P_DEFAULT for default file access properties.
Returns:
Returns a file identifier if successful; otherwise returns a negative value. @@ -1104,11 +1130,12 @@ END SUBROUTINE h5fopen_f The new file identifier should be closed by calling H5Fclose when it is no longer needed.
Parameters: -
-
hid_t file_id -
IN: Identifier of a file for which an additional identifier - is required. -
+
    + + + +
    hid_t file_id    IN: Identifier of a file for which an additional identifier + is required.
Returns:
Returns a new file identifier if successful; otherwise returns a negative value. @@ -1159,13 +1186,15 @@ END SUBROUTINE h5freopen_f Note that loc_id is either a file or group identifier and name is relative to loc_id.
Parameters: -
-
hid_t loc_id -
IN: File or group identifier for the location at which - the specified file is to be unmounted. -
const char *name -
IN: Name of the mount point. -
+
    + + + + + + +
    hid_t loc_idIN: File or group identifier for the location at which + the specified file is to be unmounted.
    const char *name    IN: Name of the mount point.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. @@ -1225,14 +1254,13 @@ And in this document, the
-
-
+
HDF Help Desk
Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0
diff --git a/doc/html/RM_H5Front.html b/doc/html/RM_H5Front.html index 8bdca20..fa588df 100644 --- a/doc/html/RM_H5Front.html +++ b/doc/html/RM_H5Front.html @@ -66,8 +66,7 @@ And in this document, the -
-
+

HDF5: API Specification
Reference Manual

@@ -75,7 +74,15 @@ And in this document, the The HDF5 library provides several interfaces, each of which provides the tools required to meet specific aspects of the HDF5 data-handling requirements.

-See below for the FORTRAN90 and C++ APIs. + + + +Notes regarding FORTRAN90 and C++ APIs appear on the next page. +

@@ -138,6 +145,8 @@ from http://hdf.ncsa.uiuc.edu/HDF5/doc/PSandPDF/ approximately one week after each release. + +
@@ -169,7 +178,8 @@ which are described in the following documents. H5R, H5S, H5T, and H5Z interfaces and are described on those pages. In general, each Fortran subroutine performs exactly the same task as the corresponding C function. -

+ +

Whereas Fortran subroutines had been described on separate pages in prior releases, those descriptions were fully integrated into the body of the reference manual for HDF5 Release 1.6.2 @@ -232,8 +242,7 @@ And in this document, the

-
- +
diff --git a/doc/html/RM_H5G.html b/doc/html/RM_H5G.html index 6823f00..6f2e191 100644 --- a/doc/html/RM_H5G.html +++ b/doc/html/RM_H5G.html @@ -61,8 +61,7 @@ And in this document, the
@@ -242,7 +251,7 @@ And in this document, the Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0
@@ -250,7 +259,7 @@ document.writeln("Last modified: 18 February 2004");
-
-
+

H5G: Group Interface

@@ -221,10 +220,11 @@ create or access function.

Failure to release a group with this call will result in resource leaks.

Parameters: -
-
hid_t group_id -
IN: Group identifier to release. -
+
    + + + +
    hid_t group_id    IN: Group identifier to release.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. @@ -279,20 +279,23 @@ END SUBROUTINE h5gclose_f This group identifier should be closed by calling H5Gclose when it is no longer needed.
Parameters: -
-
hid_t loc_id -
IN: File or group identifier. -
const char *name -
IN: Absolute or relative name of the new group. -
size_t size_hint -
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. -
+
    + + + + + + + + + +
    hid_t loc_idIN: File or group identifier.
    const char *nameIN: Absolute or relative name of the new group.
    size_t size_hint    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.
Returns:
Returns a valid group identifier for the open group if successful; otherwise returns a negative value. @@ -348,17 +351,21 @@ END SUBROUTINE h5gcreate_f If an object does not have a comment, the empty string is returned.
Parameters: -
-
hid_t loc_id -
IN: Identifier of the file or group. -
const char *name -
IN: Name of the object whose comment is to be set or reset. -
size_t bufsize -
IN: Anticipated size of the buffer required to hold - comment. -
char *comment -
OUT: The comment. -
+
    + + + + + + + + + + + + +
    hid_t loc_idIN: Identifier of the file or group.
    const char *name    IN: Name of the object whose comment is to be set or reset.
    size_t bufsizeIN: Anticipated size of the buffer required to hold + comment.
    char *commentOUT: The comment.
Returns:
Returns the number of characters in the comment, counting the null terminator, if successful; the value @@ -418,17 +425,21 @@ END SUBROUTINE h5gget_comment_f This function should be used only after H5Gget_objinfo has been called to verify that name is a symbolic link.
Parameters: -
-
hid_t loc_id -
IN: Identifier of the file or group. -
const char *name -
IN: Symbolic link to the object whose name is to be returned. -
size_t size -
IN: Maximum number of characters of value - to be returned. -
char *value -
OUT: A buffer to hold the name of the object being sought. -
+
    + + + + + + + + + + + + +
    hid_t loc_idIN: Identifier of the file or group.
    const char *name    IN: Symbolic link to the object whose name is to be returned.
    size_t sizeIN: Maximum number of characters of value + to be returned.
    char *valueOUT: A buffer to hold the name of the object being sought.
Returns:
Returns a non-negative value, with the link value in value, if successful. @@ -472,12 +483,14 @@ END SUBROUTINE h5gget_linkval_f If a file identifier is passed in, then the number of objects in the root group is returned.
Parameters: -
-
hid_t loc_id -
IN: Identifier of the group or the file -
hsize_t* num_obj -
OUT: Number of objects in the group. -
+
    + + + + + + +
    hid_t loc_idIN: Identifier of the group or the file
    hsize_t *num_obj    OUT: Number of objects in the group.
Returns:
Returns positive value if successful; otherwise returns a negative value. @@ -575,17 +588,22 @@ SUBROUTINE
Some systems will be able to record the time accurately but unable to retrieve the correct time; such systems (e.g., Irix64) will report an mtime value of 0 (zero). +
Parameters: -
-
hid_t loc_id -
IN: File or group identifier. -
const char *name -
IN: Name of the object for which status is being sought. -
hbool_t follow_link -
IN: Link flag. -
H5G_stat_t *statbuf -
OUT: Buffer in which to return information about the object. -
+
    + + + + + + + + + + + + +
    hid_t loc_idIN: File or group identifier.
    const char *nameIN: Name of the object for which status is being sought.
    hbool_t follow_linkIN: Link flag.
    H5G_stat_t *statbuf    OUT: Buffer in which to return information about the object.
Returns:
Returns a non-negative value if successful, with the fields of statbuf (if non-null) initialized. @@ -647,16 +665,20 @@ SUBROUTINE A second call to H5Gget_objname_by_idx can then be used to retrieve the actual name.
Parameters: -
-
hid_t loc_id -
IN: Group or file identifier. -
hsize_t idx -
IN: Transient index identifying object. -
char *name -
IN/OUT: Pointer to user-provided buffer the object name. -
size_t size -
IN: Name length. -
+
    + + + + + + + + + + + + +
    hid_t loc_id    IN: Group or file identifier.
    hsize_t idxIN: Transient index identifying object.
    char *nameIN/OUT: Pointer to user-provided buffer the object name.
    size_t sizeIN: Name length.
Returns:
Returns the size of the object name if successful, or 0 if no name is associated with the group identifier. @@ -750,12 +772,14 @@ SUBROUTINE
Parameters: -
-
hid_t loc_id -
IN: Group or file identifier. -
hsize_t idx -
IN: Transient index identifying object. -
+
    + + + + + + +
    hid_t loc_id    IN: Group or file identifier.
    hsize_t idxIN: Transient index identifying object.
Returns:
Returns the type of the object if successful. Otherwise returns a negative value. @@ -806,12 +830,15 @@ SUBROUTINE non-zero.

The prototype for H5G_iterate_t is: -

    -
    typedef herr_t (*H5G_iterate_t)(hid_t group_id, - const char *member_name, - void *operator_data); -
-
The operation receives the group identifier for the group being + + + + +
    typedef herr_t (*H5G_iterate_t) + (hid_t group_id, const char * + member_name, void *operator_data);
+ +

The operation receives the group identifier for the group being iterated over, group_id, the name of the current object within the group, member_name, and the pointer to the operator data passed in to H5Giterate, @@ -834,23 +861,29 @@ SUBROUTINE iteration. If the membership changes during the iteration, the function's behavior is undefined.

Parameters: -
-
hid_t loc_id -
IN: File or group identifier. -
const char *name -
IN: Group over which the iteration is performed. -
int *idx -
IN/OUT: Location at which to begin the iteration. -
H5G_iterate_t operator -
IN: Operation to be performed on an object at each step of - the iteration. -
void *operator_data -
IN/OUT: Data associated with the operation. -
+
    + + + + + + + + + + + + + + + +
    hid_t loc_idIN: File or group identifier.
    const char *nameIN: Group over which the iteration is performed.
    int *idxIN/OUT: Location at which to begin the iteration.
    H5G_iterate_t operator    IN: Operation to be performed on an object at each step of + the iteration.
    void *operator_dataIN/OUT: Data associated with the operation.
Returns:
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. +
Fortran90 Interface:
There is no direct FORTRAN couterpart for the C function H5Giterate. @@ -868,15 +901,8 @@ SUBROUTINE Returns the number of group members. - - h5gget_obj_info_idx_f -    - Purpose: - Returns the number of group members. - - h5gget_obj_info_idx_f + h5gget_obj_info_idx_f    Purpose: Returns name and type of the group member identified by its index. @@ -897,7 +923,7 @@ END SUBROUTINE h5gn_members_f 
-SUBROUTINE h5gget_obj_info_idx_f(loc_id, name, idx, &
+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 
@@ -948,19 +974,23 @@ END SUBROUTINE h5gget_obj_info_idx_f
         is made for ./x/y/bar, then the actual object looked 
         up is ./x/y/./foo.                            
   
Parameters:
-    

-      
hid_t loc_id
-        
IN: File or group identifier.
-      
H5G_link_t link_type
-        
IN: Link type.
+    
    
+      
+	    
+        
+      
+	    
+        
+      
+	    
+        
+      
+	    
+        
+    
    hid_t loc_idIN: File or group identifier.
    H5G_link_t link_typeIN: Link type.
             Possible values are H5G_LINK_HARD and 
-            H5G_LINK_SOFT.
-      
    const char * current_name
-        
    IN: Name of the existing object if link is a hard link.
-            Can be anything for the soft link.
-      
    const char * new_name
-        
    IN: New name for the object.
-    
+            H5G_LINK_SOFT.
    const char * current_name    IN: Name of the existing object if link is a hard link.
+            Can be anything for the soft link.
    const char * new_nameIN: New name for the object.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -1024,21 +1054,25 @@ END SUBROUTINE h5glink_f
         is made for ./x/y/bar, then the actual object looked 
         up is ./x/y/./foo.                            
   
Parameters:
-    

-      
hid_t curr_loc_id 
-        
IN: The file or group identifier for the original object. 
-      
const char * current_name
-        
IN: Name of the existing object if link is a hard link.
-            Can be anything for the soft link.
-      
H5G_link_t link_type
-        
IN: Link type.
+    
    
+	  
+	    
+        
+	  
+        
+        
+	  
+        
+        
+	  
+        
+         
+        
+        
+    
    hid_t curr_loc_idIN: The file or group identifier for the original object.
    const char * current_name    IN: Name of the existing object if link is a hard link.
+            Can be anything for the soft link.
    H5G_link_t link_typeIN: Link type.
             Possible values are H5G_LINK_HARD and 
-            H5G_LINK_SOFT.
-      
    hid_t new_loc_id 
-        
    IN: The file or group identifier for the new link. 
-      
    const char * new_name
-        
    IN: New name for the object.
-    
+            H5G_LINK_SOFT.
    hid_t new_loc_idIN: The file or group identifier for the new link.
    const char * new_nameIN: New name for the object.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -1094,14 +1128,17 @@ END SUBROUTINE h5glink2_f
         See The Group Interface 
         in the HDF5 User's Guide.
   
Parameters:
-    

-      
hid_t loc_id
-        
IN: File or group identifier.
-      
const char *src_name
-        
IN: Object's original name.
-      
const char *dst_name
-        
IN: Object's new name.
-    

+    
    
+      
+	    
+        
+      
+	    
+        
+      
+	    
+        
+    
    hid_t loc_idIN: File or group identifier.
    const char *src_name    IN: Object's original name.
    const char *dst_nameIN: Object's new name.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -1150,16 +1187,20 @@ END SUBROUTINE h5gmove_f
     inaccessible with H5Gmove. See The 
     Group Interface in the HDF5 User's Guide. 
   
Parameters: 
-    

-      
hid_t src_loc_id 
-      
IN: Original file or group identifier. 
-      
const char *src_name 
-      
IN: Object's original name. 
-      
hid_t dst_loc_id 
-      
IN: Destination file or group identifier. 
-      
const char *dst_name 
-      
IN: Object's new name. 
-    

+    
    
+      
+	     
+        
+      
+	     
+        
+      
+	     
+        
+      
+	     
+        
+    
    hid_t src_loc_idIN: Original file or group identifier.
    const char *src_name    IN: Object's original name.
    hid_t dst_loc_idIN: Destination file or group identifier.
    const char *dst_nameIN: Object's new name.

   
Returns: 
   
Returns a non-negative value if successful; otherwise returns a negative 
     value. 
@@ -1209,12 +1250,14 @@ END SUBROUTINE h5gmove2_f
         that was opened.  This group identifier should be released by 
         calling H5Gclose when it is no longer needed.  
   
Parameters:
-    

-      
hid_t loc_id
-        
IN: File or group identifier within which group is to be open.
-      
const char * name
-        
IN: Name of group to open.
-    

+    
    
+      
+	    
+        
+      
+	    
+        
+    
    hid_t loc_idIN: File or group identifier within which group is to be open.
    const char * name    IN: Name of group to open.

   
Returns:
     
Returns a valid group identifier if successful; 
         otherwise returns a negative value.
@@ -1266,14 +1309,17 @@ END SUBROUTINE h5gopen_f
         e.g., data sets, groups, named data types, and data spaces, but 
         not symbolic links.
   
Parameters:
-    

-      
hid_t loc_id
-        
IN: Identifier of the file or group.
-      
const char *name
-        
IN: Name of the object whose comment is to be set or reset.
-      
const char *comment
-        
IN: The new comment.
-    

+    
    
+      
+	    
+        
+      
+	    
+        
+      
+	    
+        
+    
    hid_t loc_idIN: Identifier of the file or group.
    const char *nameIN: Name of the object whose comment is to be set or reset.
    const char *comment    IN: The new comment.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -1337,12 +1383,14 @@ END SUBROUTINE h5gset_comment_f
         See The Group Interface 
         in the HDF5 User's Guide.
   
Parameters:
-    

-      
hid_t loc_id
-        
IN: Identifier of the file or group containing the object.
-      
const char * name
-        
IN: Name of the object to unlink.
-    

+    
          
+	  
+	    
+        
+      
+	    
+        
+    
    hid_t loc_idIN: Identifier of the file or group containing the object.
    const char * name    IN: Name of the object to unlink.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -1399,14 +1447,13 @@ And in this document, the
-
-
+
HDF Help Desk
Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0
diff --git a/doc/html/RM_H5I.html b/doc/html/RM_H5I.html index 478671f..b17c668 100644 --- a/doc/html/RM_H5I.html +++ b/doc/html/RM_H5I.html @@ -61,8 +61,7 @@ And in this document, the
-
-
+

H5I: Identifier Interface

@@ -151,6 +150,7 @@ as the corresponding C function. +
@@ -197,10 +197,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.
Parameters: -
-
hid_t obj_id -
IN: Object identifier whose reference count will be modified. -
+
    + + + +
    hid_t obj_id    IN: Object identifier whose reference count will be modified.
Returns:
Returns a non-negative reference count of the object ID after decrementing it if successful; otherwise a negative value is returned. @@ -225,7 +226,6 @@ END SUBROUTINE h5idec_ref_f
-
@@ -262,16 +262,18 @@ END SUBROUTINE h5idec_ref_f varying according to the path through the HDF5 group hierarchy used to reach that object.
Parameters: -
-
hid_t obj_id -
IN: Identifier of the object. - This identifier can refer to a group, dataset, or - named datatype. -
char *name -
OUT: A name associated with the identifier. -
size_t size -
IN: The size of the name buffer. -
+
    + + + + + + + + + +
    hid_t obj_id    IN: Identifier of the object. + This identifier can refer to a group, dataset, or named datatype.
    char *nameOUT: A name associated with the identifier.
    size_t sizeIN: The size of the name buffer.
Returns:
Returns the length of the name if successful, returning 0 (zero) if no name is associated with the identifier. @@ -321,10 +323,11 @@ END SUBROUTINE h5iget_name_f A non-negative return value from this function indicates that the ID is still valid.
Parameters: -
-
hid_t obj_id -
IN: Object identifier whose reference count will be retrieved. -
+
    + + + +
    hid_t obj_id    IN: Object identifier whose reference count will be retrieved.
Returns:
Returns a non-negative current reference count of the object ID if successful; otherwise a negative value is returned. @@ -388,10 +391,11 @@ END SUBROUTINE h5iget_ref_f H5Gclose, etc.) to call after a call to H5Rdereference.
Parameters: -
-
hid_t obj_id -
IN: Object identifier whose type is to be determined. -
+
    + + + +
    hid_t obj_id    IN: Object identifier whose type is to be determined.
Returns:
Returns the object type if successful; otherwise H5I_BADID. @@ -469,10 +473,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.
Parameters: -
-
hid_t obj_id -
IN: Object identifier whose reference count will be modified. -
+
    + + + +
    hid_t obj_id    IN: Object identifier whose reference count will be modified.
Returns:
Returns a non-negative reference count of the object ID after incrementing it if successful; otherwise a negative value is returned. @@ -529,14 +534,13 @@ And in this document, the
-
-
+
HDF Help Desk
Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0
diff --git a/doc/html/RM_H5P.html b/doc/html/RM_H5P.html index a12084e..0dbc15f 100644 --- a/doc/html/RM_H5P.html +++ b/doc/html/RM_H5P.html @@ -61,8 +61,7 @@ And in this document, the -
-
+

H5P: Property List Interface

Property List API Functions

@@ -74,6 +73,7 @@ which require many different parameters to be easily manipulated.

The C Interfaces: + + + + + + + + + + + + + + + +
+ + General Functions + + + Generic Properties + +  + File Access Properties + +  + File Creation Properties + + File Close Properties + +

+   || Indicates functions
+     available only in the
+     parallel HDF5 library. +











+   (Function listing
+   continues on next page.) +
+ + + + + + + + + + + + + +
+ Dataset Creation Properties + +  + Dataset Access, Memory, and
Transfer Properties + +		  +
+   || Indicates functions
+     available only in the
+     parallel HDF5 library. +
+ +
* Functions labelled with an asterisk (*) are provided only for @@ -269,6 +480,7 @@ backwards compatibility with HDF5 Releases 1.4.x. See further notes in the description of each function.

+ Alphabetical Listing @@ -411,6 +623,7 @@ See further notes in the description of each function.

+ The FORTRAN90 Interfaces:
@@ -606,10 +819,11 @@ as the corresponding C function. set in the dataset creation property list dcpl_id are currently available.

Parameters: -
-
hid_t dcpl_id -
IN: Dataset creation property list identifier. -
+
    + + + +
    hid_t dcpl_id    IN: Dataset creation property list identifier.
Returns:
Returns TRUE if all filters are available and FALSE if one or more is not currently available.
@@ -646,10 +860,11 @@ SUBROUTINE finished accessing them. This frees resources used by the property list.
Parameters: -
-
hid_t plist -
IN: Identifier of the property list to terminate access to. -
+
    + + + +
    hid_t plist    IN: Identifier of the property list to terminate access to.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. @@ -696,7 +911,7 @@ END SUBROUTINE h5pclose_f
Parameters:
    - +
    hid_t classhid_t class     IN: Property list class to close
@@ -751,7 +966,7 @@ END SUBROUTINE h5pclose_class_f
Parameters:
    -
    hid_t plist + hid_t plist     IN: Property list to close
@@ -794,10 +1009,11 @@ END SUBROUTINE h5pclose_list_f The new property list has the same properties and values as the original property list.
Parameters: -
-
hid_t plist -
IN: Identifier of property list to duplicate. -
+
    + + + +
    hid_t plist    IN: Identifier of property list to duplicate.
Returns:
Returns a property list identifier if successful; otherwise returns a negative value. @@ -873,7 +1089,7 @@ END SUBROUTINE h5pcopy_f hid_t src_id IN: Identifier of the source property list or class - const char *name + const char *name     IN: Name of the property to copy @@ -949,10 +1165,11 @@ END SUBROUTINE h5pcopy_prop_f H5Pclose; otherwise, errors are likely to occur.
Parameters: -
-
H5P_class_t type -
IN: The type of property list to create. -
+
    + + + +
    H5P_class_t type    IN: The type of property list to create.
Returns:
Returns a property list identifier (plist) if successful; otherwise Fail (-1). @@ -1095,7 +1312,7 @@ END SUBROUTINE h5pcreate_f const char *name IN: Name of property list class to register - H5P_cls_create_func_t create + H5P_cls_create_func_t create     IN: Callback routine called when a property list is created H5P_cls_copy_func_t copy @@ -1110,6 +1327,7 @@ END SUBROUTINE h5pcreate_f
Success: a valid property list class identifier
Failure: a negative value +
Fortran90 Interface: h5pcreate_class_f 
@@ -1164,7 +1382,7 @@ END SUBROUTINE h5pcreate_class_f
   
Parameter:
     
    
-        
+        
    
     
    hid_t class;hid_t class;    
         IN: Class of property list to create.
    
     

 
@@ -1312,7 +1530,7 @@ END SUBROUTINE h5premove_filter_f
   
Parameters:
     
    
-        
+        
@@ -1372,7 +1590,7 @@ END SUBROUTINE h5pequal_f
         
-        
+        
    
     
    hid_t id1hid_t id1    
         IN: First property object to be compared
    
     
    
         hid_t id2hid_t id
         IN: Identifier for the property to query
    
     
    const char *nameconst char *name    
         IN: Name of property to check for
    
     

 
@@ -1442,12 +1660,14 @@ END SUBROUTINE h5pexist_f
 	See H5Dcreate for 
 	further cross-references.
   
Parameters:
-    

-        
hid_t plist_id
-            
IN: Dataset creation property list identifier.
-        
H5D_fill_value_t *status
-            
OUT: Status of fill value in property list.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plist_idIN: Dataset creation property list identifier.
    H5D_fill_value_t *status    OUT: Status of fill value in property list.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -1509,7 +1729,7 @@ SUBROUTINE
         hid_t plid
         IN: Identifier of the property list to query
     
-        const char *name
+        const char *name    
         IN: Name of property to query
     
         void *value
@@ -1566,14 +1786,17 @@ END SUBROUTINE h5pget_f
         The threshold and/or alignment pointers 
         may be null pointers (NULL). 
   
Parameters:
-    

-        
hid_t plist
-            
IN: Identifier of a file access property list.
-        
hsize_t *threshold
-            
OUT: Pointer to location of return threshold value.
-        
hsize_t *alignment
-            
OUT: Pointer to location of return alignment value.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plistIN: Identifier of a file access property list.
    hsize_t *threshold    OUT: Pointer to location of return threshold value.
    hsize_t *alignmentOUT: Pointer to location of return alignment value.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -1644,12 +1867,14 @@ END SUBROUTINE h5pget_alignment_f
 	set with the functions 
 	H5Pget_fill_value and H5Pget_fill_time.
   
Parameters:
-    

-        
hid_t plist_id
-            
IN: Dataset creation property list identifier.
-        
H5D_alloc_time_t *alloc_time
-            
IN: When to allocate dataset storage space.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plist_idIN: Dataset creation property list identifier.
    H5D_alloc_time_t *alloc_time    IN: When to allocate dataset storage space.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -1701,16 +1926,20 @@ END SUBROUTINE h5pget_alloc_time_f
         arguments left, middle, and right,
         as set by the H5Pset_btree_ratios function.
   
Parameters:
-    

-        
hid_t plist
-            
IN: The dataset transfer property list identifier.
-        
double left
-            
OUT: The B-tree split ratio for left-most nodes.
-        
double right
-            
OUT: The B-tree split ratio for right-most nodes and lone nodes.
-        
double middle
-            
OUT: The B-tree split ratio for all other nodes.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plistIN: The dataset transfer property list identifier.
    double leftOUT: The B-tree split ratio for left-most nodes.
    double rightOUT: The B-tree split ratio for right-most nodes and lone nodes.
    double middle    OUT: The B-tree split ratio for all other nodes.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -1754,16 +1983,19 @@ END SUBROUTINE h5pget_btree_ratios_f
     
H5Pget_buffer reads values previously set 
         with H5Pset_buffer.
   
Parameters:
-    

-        
hid_t plist
-            
IN: Identifier for the dataset transfer property list.
-        
void **tconv
-            
OUT: Address of the pointer to application-allocated 
-                type conversion buffer.
-        
void **bkg
-            
OUT: Address of the pointer to application-allocated 
-                background buffer.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plistIN: Identifier for the dataset transfer property list.
    void **tconv    OUT: Address of the pointer to application-allocated 
+                type conversion buffer.
    void **bkgOUT: Address of the pointer to application-allocated 
+                background buffer.

   
Returns:
     
Returns buffer size, in bytes, if successful;
         otherwise 0 on failure.
@@ -1811,18 +2043,23 @@ END SUBROUTINE h5pget_buffer_f
         Any (or all) arguments may be null pointers, in which case the 
         corresponding datum is not returned.
   
Parameters:
-    

-        
hid_t plist_id
-            
IN: Identifier of the file access property list.
-        
int *mdc_nelmts
-            
IN/OUT: Number of elements (objects) in the meta data cache.
-        
int *rdcc_nelmts
-            
IN/OUT: Number of elements (objects) in the raw data chunk cache.
-        
size_t *rdcc_nbytes
-            
IN/OUT: Total size of the raw data chunk cache, in bytes.
-        
double *rdcc_w0
-            
IN/OUT: Preemption policy.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plist_idIN: Identifier of the file access property list.
    int *mdc_nelmtsIN/OUT: Number of elements (objects) in the meta data cache.
    int *rdcc_nelmtsIN/OUT: Number of elements (objects) in the raw data chunk cache.
    size_t *rdcc_nbytes    IN/OUT: Total size of the raw data chunk cache, in bytes.
    double *rdcc_w0IN/OUT: Preemption policy.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -1873,14 +2110,17 @@ END SUBROUTINE h5pget_cache_f
             At most, max_ndims elements of dims 
             will be initialized.
   
Parameters:
-    

-        
hid_t plist
-            
IN: Identifier of property list to query.
-        
int max_ndims
-            
IN: Size of the dims array.
-        
hsize_t * dims
-            
OUT: Array to store the chunk dimensions.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plistIN: Identifier of property list to query.
    int max_ndims    IN: Size of the dims array.
    hsize_t * dimsOUT: Array to store the chunk dimensions.

   
Returns:
     
Returns chunk dimensionality successful;
         otherwise returns a negative value.
@@ -1925,10 +2165,11 @@ END SUBROUTINE h5pget_chunk_f
         Valid property list classes are defined in the description of
         H5Pcreate.
   
Parameters:
-    

-      
hid_t plist
-        
IN: Identifier of property list to query.
-    

+    
    
+      
+	    
+        
+    
    hid_t plist    IN: Identifier of property list to query.

   
Returns:
     
Returns a property list class if successful.
         Otherwise returns H5P_NO_CLASS (-1).
@@ -1982,7 +2223,7 @@ END SUBROUTINE h5pget_class_f
   
Parameters:
     
    
-        
+        
    
     
    hid_t pcidhid_t pcid    
         IN: Identifier of the property class  to query
    
     

 
@@ -2038,7 +2279,7 @@ END SUBROUTINE h5pget_class_name_f
   
Parameters:
     
    
-        
+        
    
     
    hid_t pcidhid_t pcid    
         IN: Identifier of the property class to query
    
     

 
@@ -2103,10 +2344,11 @@ END SUBROUTINE h5pget_class_parent_f
         The returned driver identifier is only valid as long as the 
         file driver remains registered.
   
Parameters:
-    

-        
hid_t plist_id
-            
IN: File access or data transfer property list identifier.
-    

+    
    
+        
+		    
+            
+    
    hid_t plist_id    IN: File access or data transfer property list identifier.

   
Returns:
     
Returns a valid low-level driver identifier if successful.
         Otherwise returns a negative value.
@@ -2198,12 +2440,14 @@ END SUBROUTINE h5pget_driver_f
         

         H5Pget_dxpl_mpio is not a collective function.
   
Parameters:
-    

-        
hid_t dxpl_id
-            
IN: Data transfer property list identifier.
-        
H5FD_mpio_xfer_t *xfer_mode
-            
OUT: Data transfer mode.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t dxpl_idIN: Data transfer property list identifier.
    H5FD_mpio_xfer_t *xfer_mode    OUT: Data transfer mode.

   
Returns:
     
Returns a non-negative value if successful.
         Otherwise returns a negative value.
@@ -2248,12 +2492,14 @@ END SUBROUTINE h5pget_dxpl_mpio_f
     
H5Pget_dxpl_multi returns the data transfer property list
         information for the multi-file driver.
   
Parameters:
-    

-        
hid_t dxpl_id,
-            
IN: Data transfer property list identifier.
-        
const hid_t *memb_dxpl
-            
OUT: Array of data access property lists.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t dxpl_id,IN: Data transfer property list identifier.
    const hid_t *memb_dxpl    OUT: Array of data access property lists.

   
Returns:
     
Returns a non-negative value if successful.
         Otherwise returns a negative value.
@@ -2287,10 +2533,11 @@ SUBROUTINE
         list plist to determine whether error detection 
         is enabled for data read operations. 
   
Parameters:
-    

-        
hid_t plist
-            
IN: Dataset transfer property list identifier.
-    

+    
    
+        
+		    
+            
+    
    hid_t plist    IN: Dataset transfer property list identifier.

   
Returns:
     
Returns H5Z_ENABLE_EDC or H5Z_DISABLE_EDC 
         if successful;
@@ -2348,21 +2595,27 @@ END SUBROUTINE h5pget_edc_check_f
         If offset or size are null pointers 
         then the corresponding information is not returned.
   
Parameters:
-    

-        
hid_t plist
-            
IN: Identifier of a dataset creation property list.
-        
int idx
-            
IN: External file index.
-        
size_t name_size
-            
IN: Maximum length of name array.
-        
char *name
-            
OUT: Name of the external file.
-        
off_t *offset
-            
OUT: Pointer to a location to return an offset value.
-        
hsize_t *size
-            
OUT: Pointer to a location to return the size of the 
-                external file data.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plistIN: Identifier of a dataset creation property list.
    int idxIN: External file index.
    size_t name_size    IN: Maximum length of name array.
    char *nameOUT: Name of the external file.
    off_t *offsetOUT: Pointer to a location to return an offset value.
    hsize_t *sizeOUT: Pointer to a location to return the size of the 
+                external file data.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -2408,10 +2661,11 @@ END SUBROUTINE h5pget_external_f
     
H5Pget_external_count returns the number of external files 
         for the specified dataset.
   
Parameters:
-    

-        
hid_t plist
-            
IN: Identifier of a dataset creation property list.
-    

+    
    
+        
+		    
+            
+    
    hid_t plist    IN: Identifier of a dataset creation property list.

   
Returns:
     
Returns the number of external files if successful;
         otherwise returns a negative value.
@@ -2466,12 +2720,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 FAMILY file driver.
   
Parameters:
-    

-        
hid_t fapl_id
-            
IN: File access property list identifier.
-        
hsize_t *offset
-            
IN: Offset in bytes within the HDF5 file.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t fapl_idIN: File access property list identifier.
    hsize_t *offset    IN: Offset in bytes within the HDF5 file.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -2508,15 +2764,18 @@ SUBROUTINE
     
H5Pget_fapl_core queries the H5FD_CORE 
     driver properties as set by H5Pset_fapl_core.
   
Parameters:
-    

-        
hid_t fapl_id
-            
IN: File access property list identifier.
-        
size_t *increment
-            
OUT: Size, in bytes, of memory increments.
-        
hbool_t *backing_store
-            
OUT: Boolean flag indicating whether to write the file
-                contents to disk when the file is closed.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t fapl_idIN: File access property list identifier.
    size_t *incrementOUT: Size, in bytes, of memory increments.
    hbool_t *backing_store    OUT: Boolean flag indicating whether to write the file
+                contents to disk when the file is closed.

   
Returns:
     
Returns a non-negative value if successful.
         Otherwise returns a negative value.
@@ -2562,15 +2821,18 @@ END SUBROUTINE h5pget_fapl_core_f
         for use with the family driver.
         This information is returned through the output parameters.
   
Parameters:
-    

-        
hid_t fapl_id
-            
IN: File access property list identifier.
-        
 hsize_t *memb_size
-            
OUT: Size in bytes of each file member.
-        
hid_t *memb_fapl_id
-            
OUT: Identifier of file access property list for each 
-                    family member.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t fapl_idIN: File access property list identifier.
     hsize_t *memb_sizeOUT: Size in bytes of each file member.
    hid_t *memb_fapl_id    OUT: Identifier of file access property list for each 
+                    family member.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -2625,12 +2887,14 @@ END SUBROUTINE h5pget_fapl_family_f
         For further information, see 
         http//www.globus.org/.
   
Parameters:
-    

-        
hid_t fapl_id,
-            
IN: File access property list identifier.
-        
GASS_Info *info
-            
OUT: Pointer to the GASS information structure.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t fapl_id,IN: File access property list identifier.
    GASS_Info *info    OUT: Pointer to the GASS information structure.

   
Returns:
     
Returns a non-negative value if successful.
         Otherwise returns a negative value.
@@ -2673,14 +2937,17 @@ SUBROUTINE
         so they are valid only until the file access property list 
         is either modified or closed.
   
Parameters:
-    

-        
hid_t fapl_id
-            
IN: File access property list identifier.
-        
MPI_Comm *comm
-            
OUT: MPI-2 communicator.
-        
MPI_Info *info
-            
OUT: MPI-2 info object.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t fapl_idIN: File access property list identifier.
    MPI_Comm *comm    OUT: MPI-2 communicator.
    MPI_Info *infoOUT: MPI-2 info object.

   
Returns:
     
Returns a non-negative value if successful.
         Otherwise returns a negative value.
@@ -2727,12 +2994,14 @@ END SUBROUTINE h5pget_fapl_mpio_f
         comm is not copied, so it is valid only 
         until the file access property list is either modified or closed.
   
Parameters:
-    

-        
hid_t fapl_id
-            
IN: File access property list identifier.
-        
MPI_Comm *comm
-            
OUT: MPI-2 communicator.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t fapl_idIN: File access property list identifier.
    MPI_Comm *comm    OUT: MPI-2 communicator.

   
Returns:
     
Returns a non-negative value if successful.
         Otherwise returns a negative value.
@@ -2776,21 +3045,27 @@ END SUBROUTINE h5pget_fapl_mpiposix_f
     
H5Pget_fapl_multi returns information about the 
         multi-file access property list.
   
Parameters:
-    

-        
hid_t fapl_id
-            
IN: File access property list identifier.
-        
const H5FD_mem_t *memb_map
-            
OUT: Maps memory usage types to other memory usage types.
-        
const hid_t *memb_fapl
-            
OUT: Property list for each memory usage type.
-        
const char **memb_name
-            
OUT: Name generator for names of member files.
-        
const haddr_t *memb_addr
-            
OUT: 
-        
hbool_t *relax
-            
OUT: Allows read-only access to incomplete file sets 
-                when TRUE.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t fapl_idIN: File access property list identifier.
    const H5FD_mem_t *memb_map    OUT: Maps memory usage types to other memory usage types.
    const hid_t *memb_faplOUT: Property list for each memory usage type.
    const char **memb_nameOUT: Name generator for names of member files.
    const haddr_t *memb_addrOUT:
    hbool_t *relaxOUT: Allows read-only access to incomplete file sets 
+                when TRUE.

   
Returns:
     
Returns a non-negative value if successful.
         Otherwise returns a negative value.
@@ -2849,12 +3124,14 @@ END SUBROUTINE h5pget_fapl_multi_f
         Storage Resource Broker (SRB).  For further information, see 
         http//www.npaci.edu/Research/DI/srb/.
   
Parameters:
-    

-        
hid_t fapl_id
-            
IN: File access property list identifier.
-        
SRB_Info *info
-            
OUT: Pointer to the SRB information structure.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t fapl_idIN: File access property list identifier.
    SRB_Info *info    OUT: Pointer to the SRB information structure.

   
Returns:
     
Returns a non-negative value if successful.
         Otherwise returns a negative value.
@@ -2892,12 +3169,14 @@ SUBROUTINE
         H5Pset_fapl_stream and H5Pget_fapl_stream 
         are not intended for use in a parallel environment.
   
Parameters:
-    

-        
hid_t fapl_id
-            
IN: File access property list identifier.
-        
H5FD_stream_fapl_t *fapl
-            
OUT: The streaming I/O file access property list.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t fapl_idIN: File access property list identifier.
    H5FD_stream_fapl_t *fapl    OUT: The streaming I/O file access property list.

   
Returns:
     
Returns a non-negative value if successful.
         Otherwise returns a negative value.
@@ -2935,13 +3214,15 @@ SUBROUTINE
       is called to close that file.  fc_degree can have any one of 
       four valid values as described above in H5Pset_fclose_degree. 
   
Parameters: 
-    

-      
hid_t fapl_id 
-      
IN: File access property list identifier. 
-      
H5F_close_degree_t fc_degree 
-      
OUT: Pointer to a location to which to return the file close degree 
-        property, the value of fc_degree.
-    

+    
    
+      
+	      
+          
+      
+	       
+          
+    
    hid_t fapl_idIN: File access property list identifier.
    H5F_close_degree_t fc_degree    OUT: Pointer to a location to which to return the file close degree 
+            property, the value of fc_degree.

   
Returns: 
   
Returns a non-negative value if successful. Otherwise returns a negative 
     value. 
@@ -3010,12 +3291,14 @@ END SUBROUTINE h5pget_fclose_degree_f
 	dataset storage allocation time properties, retrieved with the functions 
 	H5Pget_fill_value and H5Pget_alloc_time.
   
Parameters:
-    

-        
hid_t plist_id
-            
IN: Dataset creation property list identifier.
-        
H5D_fill_time_t *fill_time
-            
OUT: Setting for the timing of writing fill values to the dataset.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plist_idIN: Dataset creation property list identifier.
    H5D_fill_time_t *fill_time    OUT: Setting for the timing of writing fill values to the dataset.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -3085,15 +3368,17 @@ END SUBROUTINE h5pget_fill_time_f
 	and H5Pget_fill_time, respectively.
 
   
Parameters:
-    

-        
hid_t plist_id
-            
IN: Dataset creation property list identifier.
-        
hid_t type_id,
-            
IN: Datatype identifier for the value passed 
-	        via value.
-        
void *value
-            
OUT: Pointer to buffer to contain the returned fill value.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+            
+    
    hid_t plist_id    IN: Dataset creation property list identifier.
    hid_t type_id,IN: Datatype identifier for the value passed 
+	        via value.
    void *valueOUT: Pointer to buffer to contain the returned fill value.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -3171,24 +3456,32 @@ END SUBROUTINE h5pget_fill_value_f
         pipeline; plist must be a dataset creation property 
         list.
   
Parameters:
-    

-        
hid_t plist
-            
IN: Property list identifier.
-        
int filter_number
-            
IN: Sequence number within the filter pipeline of 
-                the filter for which information is sought.
-        
unsigned int *flags
-            
OUT: Bit vector specifying certain general properties
-                of the filter.
-        
size_t *cd_nelmts
-            
IN/OUT: Number of elements in cd_values.
-        
unsigned int *cd_values
-            
OUT: Auxiliary data for the filter.
-        
size_t namelen
-            
IN: Anticipated number of characters in name.
-        
char name[]
-            
OUT: Name of the filter.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plistIN: Property list identifier.
    int filter_numberIN: Sequence number within the filter pipeline of 
+                the filter for which information is sought.
    unsigned int *flagsOUT: Bit vector specifying certain general properties
+                of the filter.
    size_t *cd_nelmtsIN/OUT: Number of elements in cd_values.
    unsigned int *cd_values    OUT: Auxiliary data for the filter.
    size_t namelenIN: Anticipated number of characters in name.
    char name[]OUT: Name of the filter.

+
   
Returns:
     
Returns the filter identifier if successful:
          

@@ -3219,7 +3512,8 @@ END SUBROUTINE h5pget_fill_value_f
   
Fortran90 Interface: h5pget_filter_f
     

 	
-SUBROUTINE h5pget_filter_f(prp_id, filter_number, flags, cd_nelmts, cd_values, namelen, name, filter_id, hdferr)
+SUBROUTINE h5pget_filter_f(prp_id, filter_number, flags, cd_nelmts, cd_values, 
+                           namelen, name, filter_id, hdferr)
   IMPLICIT NONE
   INTEGER(HID_T), INTENT(IN) :: prp_id    ! Property list identifier
   INTEGER, INTENT(IN) :: filter_number    ! Sequence number within the filter
@@ -3296,24 +3590,31 @@ END SUBROUTINE h5pget_filter_f
         set for the property list, an error will be returned
 	and H5Pget_filter_by_id will fail.
  
Parameters:
-    

-        
hid_t plist_id
-            
IN: Property list identifier.
-        
H5Z_filter_t filter
-            
IN: Filter identifier.
-        
unsigned int flags
-            
OUT:  Bit vector specifying certain general properties
-                of the filter.
-        
size_t cd_nelmts
-            
IN/OUT: Number of elements in cd_values.
-        
const unsigned int cd_values[]
-            
OUT: Auxiliary data for the filter.
-        
size_t namelen
-            
IN/OUT: Length of filter name and 
-	        number of elements in name[].
-        
char *name[]
-            
OUT: Name of filter.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plist_idIN: Property list identifier.
    H5Z_filter_t filterIN: Filter identifier.
    unsigned int flagsOUT:  Bit vector specifying certain general properties
+                of the filter.
    size_t cd_nelmtsIN/OUT: Number of elements in cd_values.
    const unsigned int cd_values[]    OUT: Auxiliary data for the filter.
    size_t namelenIN/OUT: Length of filter name and 
+	        number of elements in name[].
    char *name[]OUT: Name of filter.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -3324,7 +3625,9 @@ 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
-  INTEGER, INTENT(IN)        :: filter_id   ! Filter identifier
+  INTEGER, INTENT(IN)        :: filter_id   ! Filter identifier

+
+
   INTEGER(SIZE_T), INTENT(INOUT)     :: cd_nelmts  
                                             ! Number of elements in cd_values
   INTEGER, DIMENSION(*), INTENT(OUT) :: cd_values  
@@ -3365,15 +3668,17 @@ END SUBROUTINE h5pget_filter_by_id_f
         The garbage collection references property is set 
         by H5Pset_gc_references.
   
Parameters:
-    

-        
hid_t plist
-            
IN: File access property list identifier.
-        
unsigned gc_ref
-            
OUT: Flag returning the state of reference garbage collection.
+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plistIN: File access property list identifier.
    unsigned gc_ref    OUT: Flag returning the state of reference garbage collection.
                 A returned value of 1 indicates that 
                 garbage collection is on while 
-                0 indicates that garbage collection is off.
-    
+                0 indicates that garbage collection is off.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -3422,12 +3727,14 @@ END SUBROUTINE h5pget_gc_references_f
 	was previously set with a call to 
 	H5Pset_hyper_vector_size.
   
Parameters:
-    

-        
hid_t dxpl_id
-            
IN: Dataset transfer property list identifier.
-        
size_t *vector_size
-            
OUT: Number of I/O vectors to accumulate in memory for I/O operations. 
-    

+    
    
+        
+		    
+            
+        
+		    
+             
+    
    hid_t dxpl_idIN: Dataset transfer property list identifier.
    size_t *vector_size    OUT: Number of I/O vectors to accumulate in memory for I/O operations.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -3471,12 +3778,14 @@ END SUBROUTINE h5pget_hyper_vector_size_f
             

             See H5Pset_istore_k for details.
   
Parameters:
-    

-        
hid_t plist
-            
IN: Identifier of property list to query.
-        
int * ik
-            
OUT: Pointer to location to return the chunked storage B-tree 1/2 rank.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plist    IN: Identifier of property list to query.
    int * ikOUT: Pointer to location to return the chunked storage B-tree 1/2 rank.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -3520,10 +3829,11 @@ END SUBROUTINE h5pget_istore_k_f
         documentation for details.
 	
   
Parameters:
-    

-        
hid_t plist
-            
IN: Identifier for property list to query.
-    

+    
    
+        
+		    
+            
+    
    hid_t plist    IN: Identifier for property list to query.

   
Returns:
     
Returns the layout type (a non-negative value)  
         of a dataset creation property list if successful.  
@@ -3587,12 +3897,14 @@ END SUBROUTINE h5pget_layout_f
         and is retrieved from the file access property list
         fapl_id. 
   
Parameters:
-    

-        
hid_t fapl_id
-            
IN: File access property list identifier.
-        
hsize_t *size
-            
OUT: Minimum size, in bytes, of metadata block allocations.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t fapl_id    IN: File access property list identifier.
    hsize_t *sizeOUT: Minimum size, in bytes, of metadata block allocations.

   
Returns:
     
Returns a non-negative value if successful.
         Otherwise returns a negative value.
@@ -3650,12 +3962,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 MULTI file driver.
   
Parameters:
-    

-        
hid_t fapl_id
-            
IN: File access property list or data transfer property list identifier.
-        
H5FD_mem_t *type
-            
OUT: Type of data.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t fapl_idIN: File access property list or data transfer property list identifier.
    H5FD_mem_t *type    OUT: Type of data.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -3703,10 +4017,11 @@ SUBROUTINE
         pipeline; plist_id must be a dataset creation 
         property list.
   
Parameters:
-    

-        
hid_t plist
-            
IN: Property list identifier.
-    

+    
    
+        
+		    
+            
+    
    hid_t plist    IN: Property list identifier.

   
Returns:
     
Returns the number of filters in the pipeline if successful;
         otherwise returns a negative value.
@@ -3761,7 +4076,7 @@ END SUBROUTINE h5pget_nfilters_f
         hid_t id
         IN: Identifier of property object to query
     
-        size_t *nprops
+        size_t *nprops    
         OUT: Number of properties in object
     
 
@@ -3802,10 +4117,11 @@ END SUBROUTINE h5pget_nprops_f
     
H5Pget_preserve checks the status of the 
         dataset transfer property list.
   
Parameters:
-    

-        
hid_t plist
-            
IN: Identifier for the dataset transfer property list.
-    

+    
    
+        
+		    
+            
+    
    hid_t plist    IN: Identifier for the dataset transfer property list.

   
Returns:
     
Returns TRUE or FALSE if successful;
         otherwise returns a negative value.
@@ -3841,8 +4157,6 @@ END SUBROUTINE h5pget_preserve_f
                      hid_t fapl_id,
                      hsize_t *size
     )
-

-

   
Purpose:
     
 Returns maximum data sieve buffer size.
   
Description:
@@ -3854,12 +4168,14 @@ END SUBROUTINE h5pget_preserve_f
         and is retrieved from the file access property list
         fapl_id. 
   
Parameters:
-    

-        
hid_t fapl_id
-            
IN: File access property list identifier.
-        
hsize_t *size
-            
IN: Maximum size, in bytes, of data sieve buffer.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t fapl_id    IN: File access property list identifier.
    hsize_t *sizeIN: Maximum size, in bytes, of data sieve buffer.

   
Returns:
     
Returns a non-negative value if successful.
         Otherwise returns a negative value.
@@ -3915,7 +4231,7 @@ END SUBROUTINE h5pget_sieve_buf_size_f
         hid_t id
         IN: Identifier of property object to query
     
-        const char *name
+        const char *name    
         IN: Name of property to query
     
         size_t *size
@@ -3964,14 +4280,17 @@ END SUBROUTINE h5pget_size_f
             and lengths used in an HDF5 file.  
             This function is only valid for file creation property lists.
   
Parameters:
-    

-        
hid_t plist
-            
IN: Identifier of property list to query.
-        
size_t * size
-            
OUT: Pointer to location to return offset size in bytes.
-        
size_t * size
-            
OUT: Pointer to location to return length size in bytes.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plistIN: Identifier of property list to query.
    size_t * size    OUT: Pointer to location to return offset size in bytes.
    size_t * sizeOUT: Pointer to location to return length size in bytes.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -4016,12 +4335,14 @@ END SUBROUTINE h5pget_sizes_f
         If the returned value is zero (0), the small data 
         block mechanism has been disabled for the file.
   
Parameters:
-    

-        
hid_t fapl_id
-            
IN: File access property list identifier .
-        
hsize_t *size
-            
OUT: Maximum size, in bytes, of the small data block.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t fapl_id    IN: File access property list identifier.
    hsize_t *sizeOUT: Maximum size, in bytes, of the small data block.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise a negative value.
@@ -4068,14 +4389,17 @@ END SUBROUTINE h5pget_small_data_block_size_f
             H5Pset_sym_k for more 
             information.  
   
Parameters:
-    

-        
hid_t plist
-            
IN: Property list to query.
-        
int * ik
-            
OUT: Pointer to location to return the symbol table's B-tree 1/2 rank.
-        
int * size
-            
OUT: Pointer to location to return the symbol table's leaf node 1/2 size.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plist    IN: Property list to query.
    int * ikOUT: Pointer to location to return the symbol table's B-tree 1/2 rank.
    int * sizeOUT: Pointer to location to return the symbol table's leaf node 1/2 size.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -4115,12 +4439,14 @@ END SUBROUTINE h5pget_sym_k_f
         
H5Pget_userblock retrieves the size of a user block 
             in a file creation property list.
   
Parameters:
-    

-        
hid_t plist
-            
IN: Identifier for property list to query.
-        
hsize_t * size
-            
OUT: Pointer to location to return user-block size.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plistIN: Identifier for property list to query.
    hsize_t * size    OUT: Pointer to location to return user-block size.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -4165,25 +4491,30 @@ END SUBROUTINE h5pget_userblock_f
             for a file creation property list.  Any pointer parameters which are
             passed as NULL are not queried.
   
Parameters:
-    

-        
hid_t plist
-            
IN: Identifier of the file creation property list.
-        
int * super
-            
OUT: Pointer to location to return super block version number.
-        
int * freelist
-            
OUT: Pointer to location to return global freelist version number.
-        
int * stab
-            
OUT: Pointer to location to return symbol table version number.
-        
int * shhdr
-            
OUT: Pointer to location to return shared object header version number.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plistIN: Identifier of the file creation property list.
    int * superOUT: Pointer to location to return super block version number.
    int * freelist    OUT: Pointer to location to return global freelist version number.
    int * stabOUT: Pointer to location to return symbol table version number.
    int * shhdrOUT: Pointer to location to return shared object header version number.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
   
Fortran90 Interface: h5pget_version_f
     

 	
-SUBROUTINE h5pget_version_f(prp_id, boot, freelist, &
+SUBROUTINE h5pget_version_f(prp_id, boot, freelist, & 
                             stab, shhdr, hdferr)
   IMPLICIT NONE
   INTEGER(HID_T), INTENT(IN) :: prp_id         ! Property list identifier
@@ -4229,26 +4560,31 @@ END SUBROUTINE h5pget_version_f
         H5Pset_vlen_mem_manager, returning the parameters
         set by that function.
   
Parameters:
-    

-        
hid_t plist
-            
IN: Identifier for the dataset transfer property list.
-        
H5MM_allocate_t alloc
-            
OUT: User's allocate routine, or    NULL 
-                for system    malloc. 
-        
void *alloc_info
-            
OUT: Extra parameter for user's allocation routine.  
+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+             
+        
+		    
+            
+    
    hid_t plistIN: Identifier for the dataset transfer property list.
    H5MM_allocate_t alloc    OUT: User's allocate routine, or    NULL 
+                for system    malloc.
    void *alloc_infoOUT: Extra parameter for user's allocation routine.  
                 
    
                 Contents are ignored if preceding parameter is   
-                 NULL.
-        
    H5MM_free_t free
-            
    OUT: User's free routine, or    NULL for 
-                system free. 
-        
    void *free_info
-            
    OUT: Extra parameter for user's free routine.  
+                 NULL.
    H5MM_free_t freeOUT: User's free routine, or    NULL for 
+                system free.
    void *free_infoOUT: Extra parameter for user's free routine.  
                 
    
                 Contents are ignored if preceding parameter is   
-                 NULL.
-    
+                 NULL.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -4520,6 +4856,7 @@ SUBROUTINE
     list objects; the initial value is assumed to have any necessary setup 
     already performed on it.
 
+
   
Parameters:
     
    
@@ -4544,7 +4881,7 @@ SUBROUTINE
         
-        
+        
@@ -4613,7 +4950,7 @@ END SUBROUTINE h5pinsert_f
         
-        
+        
    
     
    IN: Callback routine called when a property value is retrieved 
                 from the property
    
     
    H5P_prp_delete_func_t deleteH5P_prp_delete_func_t delete    
         IN: Callback routine called when a property is deleted from
                 a property list
    
     
    hid_t plist
         IN: Identifier of the property list
    
     
    hid_t pclasshid_t pclass    
         IN: Identifier of the property class
    
     

 
@@ -4735,7 +5072,7 @@ END SUBROUTINE h5pisa_class_f
         int * idx
         IN/OUT: Index of the property to begin with
     
-        H5P_iterate_t iter_func
+        H5P_iterate_t iter_func    
         IN: Function pointer to function to be called with each 
                 property iterated over
     
@@ -4795,19 +5132,24 @@ SUBROUTINE
         pipeline; plist_id must be a dataset creation 
         property list.
   
Parameters:
-    

-        
hid_t plist_id
-            
IN: Property list identifier.
-        
H5Z_filter_t filter
-            
IN: Filter to be modified.
-        
unsigned int flags
-            
IN:  Bit vector specifying certain general properties
-                of the filter.
-        
size_t cd_nelmts
-            
IN: Number of elements in cd_values.
-        
const unsigned int cd_values[]
-            
IN: Auxiliary data for the filter.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plist_idIN: Property list identifier.
    H5Z_filter_t filterIN: Filter to be modified.
    unsigned int flagsIN:  Bit vector specifying certain general properties
+                of the filter.
    size_t cd_nelmtsIN: Number of elements in cd_values.
    const unsigned int cd_values[]    IN: Auxiliary data for the filter.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -4815,7 +5157,7 @@ SUBROUTINE
     
Fortran90 Interface: h5pmodify_filter_f
     

 	
-SUBROUTINE h5pmodify_filter_f(prp_id, filter, flags, cd_nelmts, &
+SUBROUTINE h5pmodify_filter_f(prp_id, filter, flags, cd_nelmts, & 
                               cd_values, hdferr) 
   IMPLICIT NONE
   INTEGER(HID_T), INTENT(IN) :: prp_id      ! Property list identifier
@@ -4953,7 +5295,7 @@ END SUBROUTINE h5pmodify_filter_f
     to range check the value being set for the property 
     or may perform some tranformation or translation of the
     value set.  The get callback would then 
-    reverse the transformation or translation.  
+    reverse the transformation or translation.  
     A single get or set callback 
     could handle multiple properties by 
     performing different actions based on the
@@ -5119,36 +5461,46 @@ END SUBROUTINE h5pmodify_filter_f
     

 	
 
Parameters:
-    
    
-      
    hid_t class
-        
    IN: Property list class to register permanent property 
-		    within
-      
    const char * name
-        
    IN: Name of property to register
-      
    size_t size
-        
    IN: Size of property in bytes
-      
    void * default
-        
    IN: Default value for property in newly created property 
-		    lists
-      
    H5P_prp_create_func_t create
-        
    IN: Callback routine called when a property list is being 
-            created and the property value will be initialized
-      
    H5P_prp_set_func_t set
-        
    IN: Callback routine called before a new value is copied 
-            into the property's value
-      
    H5P_prp_get_func_t get
-        
    IN: Callback routine called when a property value is 
-            retrieved from the property
-      
    H5P_prp_delete_func_t delete
-        
    IN: Callback routine called when a property is deleted from
-            a property list
-      
    H5P_prp_copy_func_t copy
-        
    IN: Callback routine called when a property is copied from
-            a property list
-      
    H5P_prp_close_func_t close
-        
    IN: Callback routine called when a property list is being 
-            closed and the property value will be disposed of
-    

+    
    
+      
+	    
+        
+      
+	    
+        
+      
+	    
+        
+      
+	    
+        
+      
+	    
+        
+      
+	    
+        
+      
+	    
+        
+      
+	    
+        
+      
+	    
+        
+      
+	    
+        
+    
    hid_t classIN: Property list class to register permanent property 
+		    within
    const char * nameIN: Name of property to register
    size_t sizeIN: Size of property in bytes
    void * defaultIN: Default value for property in newly created property 
+		    lists
    H5P_prp_create_func_t create    IN: Callback routine called when a property list is being 
+            created and the property value will be initialized
    H5P_prp_set_func_t setIN: Callback routine called before a new value is copied 
+            into the property's value
    H5P_prp_get_func_t getIN: Callback routine called when a property value is 
+            retrieved from the property
    H5P_prp_delete_func_t deleteIN: Callback routine called when a property is deleted from
+            a property list
    H5P_prp_copy_func_t copyIN: Callback routine called when a property is copied from
+            a property list
    H5P_prp_close_func_t closeIN: Callback routine called when a property list is being 
+            closed and the property value will be disposed of

 
 
Returns:
     
Success: a non-negative value
@@ -5218,7 +5570,7 @@ END SUBROUTINE h5pregister_f
         hid_t plid
         IN: Identifier of the property list to modify
     
-        const char *name
+        const char *name    
         IN: Name of property to remove
     
 
@@ -5290,7 +5642,7 @@ END SUBROUTINE h5premove_f
         hid_t plid;
         IN: Property list identifier to modify
     
-        const char *name;
+        const char *name;    
         IN: Name of property to modify
     
         void *value;
@@ -5357,19 +5709,22 @@ END SUBROUTINE h5pset_f
         For MPI-IO and other parallel systems, choose an alignment
         which is a multiple of the disk block size.   
   
Parameters:
-    

-        
hid_t plist
-            
IN: Identifier for a file access property list.
-        
hsize_t threshold
-            
IN: Threshold value.  
+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plistIN: Identifier for a file access property list.
    hsize_t threshold    IN: Threshold value.  
                 Must be non-negative.
                 Note that setting the threshold value to 0 (zero) has 
                 the effect of a special case, forcing everything 
-                to be aligned.
-        
    hsize_t alignment
-            
    IN: Alignment value.  
-                Must be a positive value.
-    
+                to be aligned.
    hsize_t alignmentIN: Alignment value.  
+                Must be a positive value.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -5454,12 +5809,14 @@ END SUBROUTINE h5pset_alignment_f
 	See H5Dcreate for 
 	further cross-references.
   
Parameters:
-    

-        
hid_t plist_id
-            
IN: Dataset creation property list identifier.
-        
H5D_alloc_time_t alloc_time
-            
IN: When to allocate dataset storage space.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plist_idIN: Dataset creation property list identifier.
    H5D_alloc_time_t alloc_time    IN: When to allocate dataset storage space.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -5476,7 +5833,9 @@ SUBROUTINE h5pset_alloc_time_f(plist_id, flag, hdferr)
                                           !    H5D_ALLOC_TIME_DEFAULT_F
                                           !    H5D_ALLOC_TIME_EARLY_F
                                           !    H5D_ALLOC_TIME_LATE_F
-                                          !    H5D_ALLOC_TIME_INCR_F
+                                          !    H5D_ALLOC_TIME_INCR_F

+
+
   INTEGER, INTENT(OUT)       :: hdferr    ! Error code
                                           ! 0 on success and -1 on failure
 END SUBROUTINE h5pset_alloc_time_f
@@ -5519,16 +5878,20 @@ END SUBROUTINE h5pset_alloc_time_f
         

         All ratios are real numbers between 0 and 1, inclusive. 
   
Parameters:
-    

-        
hid_t plist
-            
IN: The dataset transfer property list identifier.
-        
double left
-            
IN: The B-tree split ratio for left-most nodes.
-        
double right
-            
IN: The B-tree split ratio for right-most nodes and lone nodes.
-        
double middle
-            
IN: The B-tree split ratio for all other nodes.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plistIN: The dataset transfer property list identifier.
    double leftIN: The B-tree split ratio for left-most nodes.
    double rightIN: The B-tree split ratio for right-most nodes and lone nodes.
    double middle    IN: The B-tree split ratio for all other nodes.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -5594,16 +5957,20 @@ END SUBROUTINE h5pset_btree_ratios_f
          

          The default value for the maximum buffer is 1 Mb.
   
Parameters:
-    

-        
hid_t plist
-            
IN: Identifier for the dataset transfer property list.
-        
hsize_t size
-            
IN: Size, in bytes, of the type conversion and background buffers.
-        
void tconv
-            
IN: Pointer to application-allocated type conversion buffer.
-        
void bkg
-            
IN: Pointer to application-allocated background buffer.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plistIN: Identifier for the dataset transfer property list.
    hsize_t size    IN: Size, in bytes, of the type conversion and background buffers.
    void tconvIN: Pointer to application-allocated type conversion buffer.
    void bkgIN: Pointer to application-allocated background buffer.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -5665,18 +6032,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. 
   
Parameters:
-    

-        
hid_t plist_id
-            
IN: Identifier of the file access property list.
-        
int mdc_nelmts
-            
IN: Number of elements (objects) in the meta data cache.
-        
int rdcc_nelmts
-            
IN: Number of elements (objects) in the raw data chunk cache.
-        
size_t rdcc_nbytes
-            
IN: Total size of the raw data chunk cache, in bytes.
-        
double rdcc_w0
-            
IN: Preemption policy.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plist_idIN: Identifier of the file access property list.
    int mdc_nelmtsIN: Number of elements (objects) in the meta data cache.
    int rdcc_nelmtsIN: Number of elements (objects) in the raw data chunk cache.
    size_t rdcc_nbytes    IN: Total size of the raw data chunk cache, in bytes.
    double rdcc_w0IN: Preemption policy.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -5728,14 +6100,17 @@ END SUBROUTINE h5pset_cache_f
         As a side-effect, the layout of the dataset is changed to 
         H5D_CHUNKED, if it is not already.
   
Parameters:
-    

-        
hid_t plist
-            
IN: Identifier for property list to query.
-        
int ndims
-            
IN: The number of dimensions of each chunk.
-        
const hsize_t * dim
-            
IN: An array containing the size of each chunk.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plistIN: Identifier for property list to query.
    int ndimsIN: The number of dimensions of each chunk.
    const hsize_t * dim    IN: An array containing the size of each chunk.

 
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -5781,12 +6156,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.
   
Parameters:
-    

-        
hid_t plist
-            
IN: Identifier for the dataset creation property list.
-        
int level
-            
IN: Compression level.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plist    IN: Identifier for the dataset creation property list.
    int levelIN: Compression level.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -5885,12 +6262,14 @@ END SUBROUTINE h5pset_deflate_f
         

         

   
Parameters:
-    

-        
hid_t dxpl_id
-            
IN: Data transfer property list identifier.
-        
H5FD_mpio_xfer_t xfer_mode
-            
IN: Transfer mode.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t dxpl_idIN: Data transfer property list identifier.
    H5FD_mpio_xfer_t xfer_mode    IN: Transfer mode.

   
Returns:
     
Returns a non-negative value if successful.
         Otherwise returns a negative value.
@@ -5937,12 +6316,14 @@ END SUBROUTINE h5pset_dxpl_mpio_f
         H5Pset_dxpl_multi can only be used after 
         the member map has been set with H5Pset_fapl_multi.
   
Parameters:
-    

-        
hid_t dxpl_id,
-            
IN: Data transfer property list identifier.
-        
const hid_t *memb_dxpl
-            
IN: Array of data access property lists.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t dxpl_id,IN: Data transfer property list identifier.
    const hid_t *memb_dxpl    IN: Array of data access property lists.

   
Returns:
     
Returns a non-negative value if successful.
         Otherwise returns a negative value.
@@ -5997,13 +6378,15 @@ SUBROUTINE
     
The initial error detection implementation, Fletcher32 checksum, 
         supports error detection for chunked datasets only.
   
Parameters:
-    

-        
hid_t plist
-            
IN: Dataset transfer property list identifier.
-        
H5Z_EDC_t check
-            
IN: Specifies whether error checking is enabled or disabled 
-	        for dataset read operations.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plistIN: Dataset transfer property list identifier.
    H5Z_EDC_t check    IN: Specifies whether error checking is enabled or disabled 
+	        for dataset read operations.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -6061,17 +6444,21 @@ END SUBROUTINE h5pset_edc_check_f
         external file can be of unlimited size and no more files can be added to
         the external files list.
   
Parameters:
-    

-        
hid_t plist
-            
IN: Identifier of a dataset creation property list.
-        
const char *name
-            
IN: Name of an external file.
-        
off_t offset
-            
IN: Offset, in bytes, from the beginning of the file
-                to the location in the file where the data starts.
-        
hsize_t size
-            
IN: Number of bytes reserved in the file for the data.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plistIN: Identifier of a dataset creation property list.
    const char *name    IN: Name of an external file.
    off_t offsetIN: Offset, in bytes, from the beginning of the file
+                to the location in the file where the data starts.
    hsize_t sizeIN: Number of bytes reserved in the file for the data.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -6132,12 +6519,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 FAMILY file driver.
   
Parameters:
-    

-        
hid_t fapl_id
-            
IN: File access property list identifier.
-        
hsize_t offset
-            
IN: Offset in bytes within the HDF5 file.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t fapl_idIN: File access property list identifier.
    hsize_t offset    IN: Offset in bytes within the HDF5 file.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -6197,15 +6586,18 @@ END SUBROUTINE h5pset_family_offset_f
     
There is currently no means for reading a file from disk then
         using the H5FD_CORE driver to manipulate the file.
   
Parameters:
-    

-        
hid_t fapl_id
-            
IN: File access property list identifier.
-        
size_t increment
-            
IN: Size, in bytes, of memory increments.
-        
hbool_t backing_store
-            
IN: Boolean flag indicating whether to write the file
-                contents to disk when the file is closed.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t fapl_idIN: File access property list identifier.
    size_t incrementIN: Size, in bytes, of memory increments.
    hbool_t backing_store    IN: Boolean flag indicating whether to write the file
+                contents to disk when the file is closed.

   
Returns:
     
Returns a non-negative value if successful.
         Otherwise returns a negative value.
@@ -6256,15 +6648,18 @@ END SUBROUTINE h5pset_fapl_core_f
         memb_fapl_id is the identifier of the 
         file access property list to be used for each family member. 
   
Parameters:
-    

-        
hid_t fapl_id
-            
IN: File access property list identifier.
-        
 hsize_t memb_size
-            
IN: Size in bytes of each file member.
-        
hid_t memb_fapl_id
-            
IN: Identifier of file access property list for each 
-                    family member.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t fapl_idIN: File access property list identifier.
     hsize_t memb_sizeIN: Size in bytes of each file member.
    hid_t memb_fapl_id    IN: Identifier of file access property list for each 
+                    family member.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -6324,12 +6719,14 @@ END SUBROUTINE h5pset_fapl_family_f
         For further information, see 
         http//www.globus.org/.
   
Parameters:
-    

-        
hid_t fapl_id,
-            
IN: File access property list identifier.
-        
GASS_Info info
-            
IN: Pointer to the GASS information structure.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t fapl_id,IN: File access property list identifier.
    GASS_Info info    IN: Pointer to the GASS information structure.

   
Returns:
     
Returns a non-negative value if successful.
         Otherwise returns a negative value.
@@ -6494,6 +6891,7 @@ SUBROUTINE
             (H5FD_LOG_NUM_READ | H5FD_LOG_NUM_WRITE | H5FD_LOG_NUM_SEEK)
         
 	
+
 	
             

             H5FD_LOG_TIME_OPEN 
@@ -6593,16 +6991,20 @@ SUBROUTINE
 	which must be at least the size in bytes of the file to be logged.
  
   
Parameters:
-    

-        
hid_t fapl_id
-            
IN: File access property list identifier.
-        
char *logfile
-            
IN: Name of the log file.
-        
unsigned int flags
-            
IN: Flags specifying the types of logging activity.
-        
size_t buf_size
-            
IN: The size of the logging buffer.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t fapl_idIN: File access property list identifier.
    char *logfileIN: Name of the log file.
    unsigned int flags    IN: Flags specifying the types of logging activity.
    size_t buf_sizeIN: The size of the logging buffer.

   
Returns:
     
Returns non-negative if successful.
         Otherwise returns negative.
@@ -6661,14 +7063,17 @@ SUBROUTINE
         Users should not modify the info while it is defined 
         in a property list.
   
Parameters:
-    

-        
hid_t fapl_id
-            
IN: File access property list identifier.
-        
MPI_Comm comm
-            
IN: MPI-2 communicator.
-        
MPI_Info info
-            
IN: MPI-2 info object.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t fapl_idIN: File access property list identifier.
    MPI_Comm comm    IN: MPI-2 communicator.
    MPI_Info infoIN: MPI-2 info object.

   
Returns:
     
Returns a non-negative value if successful.
         Otherwise returns a negative value.
@@ -6727,12 +7132,14 @@ END SUBROUTINE h5pset_fapl_mpio_f
         Users should not modify the communicator while it is defined 
         in a property list.
   
Parameters:
-    

-        
hid_t fapl_id
-            
IN: File access property list identifier.
-        
MPI_Comm comm
-            
IN: MPI-2 communicator.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t fapl_idIN: File access property list identifier.
    MPI_Comm comm    IN: MPI-2 communicator.

   
Returns:
     
Returns a non-negative value if successful.
         Otherwise returns a negative value.
@@ -6841,29 +7248,36 @@ END SUBROUTINE h5pset_fapl_mpiposix_f
                   l    for H5FD_MEM_LHEAP
                   

                   o    for H5FD_MEM_OHDR
-              
+              

+
           
memb_addr
             
The default value is HADDR_UNDEF for each element.
         
         
   
Parameters:
-    

-        
hid_t fapl_id
-            
IN: File access property list identifier.
-        
const H5FD_mem_t *memb_map
-            
IN: Maps memory usage types to other memory usage types.
-        
const hid_t *memb_fapl
-            
IN: Property list for each memory usage type.
-        
const char **memb_name
-            
IN: Name generator for names of member files.
-        
const haddr_t *memb_addr
-            
IN: The offsets within the virtual address space, 
+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t fapl_idIN: File access property list identifier.
    const H5FD_mem_t *memb_map    IN: Maps memory usage types to other memory usage types.
    const hid_t *memb_faplIN: Property list for each memory usage type.
    const char **memb_nameIN: Name generator for names of member files.
    const haddr_t *memb_addrIN: The offsets within the virtual address space, 
                 from 0 (zero) to HADDR_MAX, 
-                at which each type of data storage begins.
-        
    hbool_t relax
-            
    IN: Allows read-only access to incomplete file sets 
-                when TRUE.
-    
+                at which each type of data storage begins.
    hbool_t relaxIN: Allows read-only access to incomplete file sets 
+                when TRUE.

   
Returns:
     
Returns a non-negative value if successful.
         Otherwise returns a negative value.
@@ -6907,7 +7321,9 @@ SUBROUTINE h5pset_fapl_multi_f(prp_id, memb_map, memb_fapl, memb_name, &
 
   INTEGER,DIMENSION(0:H5FD_MEM_NTYPES_F-1),INTENT(IN)          :: memb_map
   INTEGER(HID_T),DIMENSION(0:H5FD_MEM_NTYPES_F-1),INTENT(IN)   :: memb_fapl
-  CHARACTER(LEN=*),DIMENSION(0:H5FD_MEM_NTYPES_F-1),INTENT(IN) :: memb_name
+  CHARACTER(LEN=*),DIMENSION(0:H5FD_MEM_NTYPES_F-1),INTENT(IN) :: memb_name

+
+
   REAL, DIMENSION(0:H5FD_MEM_NTYPES_F-1), INTENT(IN)           :: memb_addr
               ! Numbers in the interval [0,1) (e.g. 0.0 0.1 0.5 0.2 0.3 0.4)
               ! real address in the file will be calculated as X*HADDR_MAX 
@@ -6941,10 +7357,11 @@ END SUBROUTINE h5pset_fapl_multi_f
     
H5Pset_fapl_sec2 modifies the file access property list 
         to use the H5FD_SEC2 driver.
   
Parameters:
-    

-        
hid_t fapl_id
-            
IN: File access property list identifier.
-    

+    
    
+        
+		    
+            
+    
    hid_t fapl_id    IN: File access property list identifier.

   
Returns:
     
Returns a non-negative value if successful.
         Otherwise returns a negative value.
@@ -7018,19 +7435,23 @@ END SUBROUTINE h5pset_fapl_sec2_f
         HDF5 provides no mechanism to determine whether it was called
         as the special case invoked by H5Pset_fapl_split.
   
Parameters:
-    

-        

-        
hid_t fapl_id,
-            
IN: File access property list identifier.
-        
const char *meta_ext,
-            
IN: Metadata filename extension.
-        
hid_t meta_plist_id,
-            
IN: File access property list identifier for the metadata file.
-        
const char *raw_ext,
-            
IN: Raw data filename extension.
-        
hid_t raw_plist_id
-            
IN: File access property list identifier for the raw data file.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t fapl_id,IN: File access property list identifier.
    const char *meta_ext,    IN: Metadata filename extension.
    hid_t meta_plist_id,IN: File access property list identifier for the metadata file.
    const char *raw_ext,IN: Raw data filename extension.
    hid_t raw_plist_idIN: File access property list identifier for the raw data file.

   
Returns:
     
Returns a non-negative value if successful.
         Otherwise returns a negative value.
@@ -7109,12 +7530,14 @@ END SUBROUTINE h5pset_fapl_split_f
         Storage Resource Broker (SRB).  For further information, see 
         http//www.npaci.edu/Research/DI/srb/.
   
Parameters:
-    

-        
hid_t fapl_id
-            
IN: File access property list identifier.
-        
SRB_Info info
-            
IN: Pointer to the SRB information structure.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t fapl_id    IN: File access property list identifier.
    SRB_Info infoIN: Pointer to the SRB information structure.

   
Returns:
     
Returns a non-negative value if successful.
         Otherwise returns a negative value.
@@ -7149,10 +7572,11 @@ SUBROUTINE
     
H5Pset_fapl_stdio modifies the file access property list 
         to use the standard I/O driver, H5FD_STDIO.
   
Parameters:
-    

-        
hid_t fapl_id
-            
IN: File access property list identifier.
-    

+    
    
+        
+		    
+            
+    
    hid_t fapl_id    IN: File access property list identifier.

   
Returns:
     
Returns a non-negative value if successful.
         Otherwise returns a negative value.
@@ -7237,12 +7661,14 @@ END SUBROUTINE h5pset_fapl_stdio_f
         H5Pset_fapl_stream and H5Pget_fapl_stream 
         are not intended for use in a parallel environment.
   
Parameters:
-    

-        
hid_t fapl_id
-            
IN: File access property list identifier.
-        
H5FD_stream_fapl_t *fapl
-            
IN: The streaming I/O file access property list.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t fapl_idIN: File access property list identifier.
    H5FD_stream_fapl_t *fapl    IN: The streaming I/O file access property list.

   
Returns:
     
Returns a non-negative value if successful.
         Otherwise returns a negative value.
@@ -7315,13 +7741,15 @@ SUBROUTINE
       
     
   
Parameters: 
-    

-      
hid_t fapl_id 
-      
IN: File access property list identifier. 
-      
H5F_close_degree_t fc_degree 
-      
IN: Pointer to a location containing the file close degree property, 
-        the value of fc_degree.
-    

+    
    
+      
+	      
+          
+      
+	       
+          
+    
    hid_t fapl_idIN: File access property list identifier.
    H5F_close_degree_t fc_degree    IN: Pointer to a location containing the file close degree property, 
+        the value of fc_degree.

   
Returns: 
   
Returns a non-negative value if successful. Otherwise returns a negative 
     value. 
@@ -7350,7 +7778,6 @@ END SUBROUTINE h5pset_fclose_degree_f
         -->
 
 
-
 
 

 

@@ -7393,12 +7820,14 @@ END SUBROUTINE h5pset_fclose_degree_f
 	See H5Dcreate for 
 	further cross-references.
   
Parameters:
-    

-        
hid_t plist_id
-            
IN: Dataset creation property list identifier.
-        
H5D_fill_time_t fill_time
-            
IN: When to write fill values to a dataset.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plist_idIN: Dataset creation property list identifier.
    H5D_fill_time_t fill_time    IN: When to write fill values to a dataset.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -7484,14 +7913,17 @@ END SUBROUTINE h5pset_fill_time_f
 	See H5Dcreate for 
 	further cross-references.
   
Parameters:
-    

-        
hid_t plist_id
-            
IN: Dataset creation property list identifier.
-        
hid_t type_id,
-            
IN: Datatype of value.
-        
const void *value
-            
IN: Pointer to buffer containing value to use as fill value.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plist_idIN: Dataset creation property list identifier.
    hid_t type_id,IN: Datatype of value.
    const void *value    IN: Pointer to buffer containing value to use as fill value.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -7611,19 +8043,24 @@ 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.
   
Parameters:
-    

-        
hid_t plist
-            
IN: Property list identifier.
-        
H5Z_filter_t filter
-            
IN: Filter to be added to the pipeline.
-        
unsigned int flags
-            
IN:  Bit vector specifying certain general properties
-                of the filter.
-        
size_t cd_nelmts
-            
IN: Number of elements in cd_values.
-        
const unsigned int cd_values[]
-            
IN: Auxiliary data for the filter.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plistIN: Property list identifier.
    H5Z_filter_t filterIN: Filter to be added to the pipeline.
    unsigned int flagsIN:  Bit vector specifying certain general properties
+                of the filter.
    size_t cd_nelmtsIN: Number of elements in cd_values.
    const unsigned int cd_values[]    IN: Auxiliary data for the filter.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -7693,14 +8130,17 @@ END SUBROUTINE h5pset_filter_f
 	Valid callback function return values are 
 	H5Z_CB_FAIL and H5Z_CB_CONT.  
   
Parameters:
-    

-        
hid_t plist
-            
IN: Dataset transfer property list identifier.
-        
H5Z_filter_func_t func
-            
IN: User-defined filter callback function.
-        
void *op_data
-            
IN: User-defined input data for the callback function.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plistIN: Dataset transfer property list identifier.
    H5Z_filter_func_t func    IN: User-defined filter callback function.
    void *op_dataIN: User-defined input data for the callback function.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -7736,10 +8176,11 @@ SUBROUTINE
     
The initial error detection implementation supports 
         error detection for chunked datasets only.
   
Parameters:
-    

-        
hid_t plist
-            
IN: Dataset creation property list identifier.
-    

+    
    
+        
+		    
+            
+    
    hid_t plist    IN: Dataset creation property list identifier.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -7790,13 +8231,15 @@ END SUBROUTINE h5pset_fletcher32_f
         

         The default value for garbage collecting references is off.
   
Parameters:
-    

-        
hid_t plist
-            
IN: File access property list identifier.
-        
unsigned gc_ref
-            
IN: Flag setting reference garbage collection to 
-                on (1) or off (0).
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plistIN: File access property list identifier.
    unsigned gc_ref    IN: Flag setting reference garbage collection to 
+                on (1) or off (0).

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -7851,14 +8294,15 @@ END SUBROUTINE h5pset_gc_references_f
 	but the library will use more memory during hyperslab I/O.  
 	The default value of vector_size is 1024.
   
Parameters:
-    

-        
hid_t dxpl_id
-            
IN: Dataset transfer property list identifier.
-        
size_t vector_size
-            
IN: Number of I/O vectors to accumulate in memory for I/O operations. 
-                Must be greater than 1 (one).
-		Default value: 1024.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t dxpl_idIN: Dataset transfer property list identifier.
    size_t vector_size    IN: Number of I/O vectors to accumulate in memory for I/O operations. 
+                Must be greater than 1 (one). Default value: 1024.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -7905,12 +8349,14 @@ END SUBROUTINE h5pset_hyper_vector_size_f
             or have an average rank of 1.5 times the value of 
             ik.
   
Parameters:
-    

-        
hid_t plist
-            
IN: Identifier of property list to query.
-        
int ik
-            
IN: 1/2 rank of chunked storage B-tree.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plist    IN: Identifier of property list to query.
    int ikIN: 1/2 rank of chunked storage B-tree.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -7970,12 +8416,14 @@ END SUBROUTINE h5pset_istore_k_f
 	H5Dwrite
         documentation for details.
   
Parameters:
-    

-        
hid_t plist
-            
IN: Identifier of property list to query.
-        
H5D_layout_t layout
-            
IN: Type of storage layout for raw data.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plistIN: Identifier of property list to query.
    H5D_layout_t layout    IN: Type of storage layout for raw data.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -8037,12 +8485,14 @@ END SUBROUTINE h5pset_layout_f
         potentially significantly improving library and application 
         performance.
   
Parameters:
-    

-        
hid_t fapl_id
-            
IN: File access property list identifier.
-        
hsize_t size
-            
IN: Minimum size, in bytes, of metadata block allocations.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t fapl_id    IN: File access property list identifier.
    hsize_t sizeIN: Minimum size, in bytes, of metadata block allocations.

   
Returns:
     
Returns a non-negative value if successful.
         Otherwise returns a negative value.
@@ -8134,12 +8584,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 MULTI file driver.
   
Parameters:
-    

-        
hid_t fapl_id
-            
IN: File access property list or data transfer property list identifier.
-        
H5FD_mem_t type
-            
OUT: Type of data.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t fapl_idIN: File access property list or data transfer property list identifier.
    H5FD_mem_t type    OUT: Type of data.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -8180,13 +8632,15 @@ SUBROUTINE
         property to TRUE.  Otherwise the I/O pipeline treats the
         destination datapoints as completely uninitialized.
   
Parameters:
-    

-        
hid_t plist
-            
IN: Identifier for the dataset transfer property list.
-        
hbool_t status
-            
IN: Status of for the dataset transfer property list 
-                (TRUE/FALSE).
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plistIN: Identifier for the dataset transfer property list.
    hbool_t status    IN: Status of for the dataset transfer property list 
+                (TRUE/FALSE).

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -8243,10 +8697,11 @@ END SUBROUTINE h5pset_preserve_f
 	This filter is designed to be used in combination with 
 	a compression filter.
   
Parameters:
-    

-        
hid_t plist_id
-            
IN: Dataset creation property list identifier.
-    

+    
    
+        
+		    
+            
+    
    hid_t plist_id    IN: Dataset creation property list identifier.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -8296,12 +8751,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. 
   
Parameters:
-    

-        
hid_t fapl_id
-            
IN: File access property list identifier.
-        
hsize_t size
-            
IN: Maximum size, in bytes, of data sieve buffer.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t fapl_id    IN: File access property list identifier.
    hsize_t sizeIN: Maximum size, in bytes, of data sieve buffer.

   
Returns:
     
Returns a non-negative value if successful.
         Otherwise returns a negative value.
@@ -8349,14 +8806,17 @@ END SUBROUTINE h5pset_sieve_buf_size_f
             sizeof(hsize_t) in the library (normally 8 bytes).  
             Valid values currently are 2, 4, 8 and 16.
   
Parameters:
-    

-        
hid_t plist
-            
IN: Identifier of property list to modify.
-        
size_t sizeof_addr
-            
IN: Size of an object offset in bytes.
-        
size_t sizeof_size
-            
IN: Size of an object length in bytes.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plistIN: Identifier of property list to modify.
    size_t sizeof_addr    IN: Size of an object offset in bytes.
    size_t sizeof_sizeIN: Size of an object length in bytes.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -8422,14 +8882,16 @@ END SUBROUTINE h5pset_sizes_f
         Setting size to zero (0) disables the
         small data block mechanism.
   
Parameters:
-    

-        
hid_t fapl_id
-            
IN: File access property list identifier .
-        
hsize_t size
-            
IN: Maximum size, in bytes, of the small data block.
+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t fapl_id    IN: File access property list identifier.
    hsize_t sizeIN: Maximum size, in bytes, of the small data block.
                 
    
-                The default size is 2048.
-    
+                The default size is 2048.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise a negative value.
@@ -8485,14 +8947,17 @@ END SUBROUTINE h5pset_small_data_block_size_f
             contain 1.5 times the number of symbols specified by 
             lk.
   
Parameters:
-    

-        
hid_t plist
-            
IN: Identifier for property list to query.
-        
int ik
-            
IN: Symbol table tree rank.
-        
int lk
-            
IN: Symbol table node size.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plist    IN: Identifier for property list to query.
    int ikIN: Symbol table tree rank.
    int lkIN: Symbol table node size.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -8652,15 +9117,18 @@ END LIBRARY-SET OPTION TAGS -->
 	and for a list of SZIP-related references.
 
   
Parameters:
-    

-        
hid_t plist
-            
IN: Dataset creation or dataset transfer property list 
-                identifier.
-        
unsigned int options_mask
-            
IN: A bit-mask conveying the desired SZIP options.
-        
unsigned int pixels_per_block
-            
IN: The number of pixels or data elements in each data block.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plistIN: Dataset creation or dataset transfer property list 
+                identifier.
    unsigned int options_maskIN: A bit-mask conveying the desired SZIP options.
    unsigned int pixels_per_block    IN: The number of pixels or data elements in each data block.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -8771,12 +9239,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.).
   
Parameters:
-    

-        
hid_t plist
-            
IN: Identifier of property list to modify.
-        
hsize_t size
-            
IN: Size of the user-block in bytes.
-    

+    
    
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plistIN: Identifier of property list to modify.
    hsize_t size    IN: Size of the user-block in bytes.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -8855,26 +9325,31 @@ END SUBROUTINE h5pset_userblock_f
         and the  alloc_info and free_info 
         parameters are ignored.
   
Parameters:
-    

-        
hid_t plist
-            
IN: Identifier for the dataset transfer property list.
-        
H5MM_allocate_t alloc
-            
IN: User's allocate routine, or    NULL 
-                for system    malloc. 
-        
void *alloc_info
-            
IN: Extra parameter for user's allocation routine.  
+    
    
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
    hid_t plistIN: Identifier for the dataset transfer property list.
    H5MM_allocate_t alloc    IN: User's allocate routine, or    NULL 
+                for system    malloc.
    void *alloc_infoIN: Extra parameter for user's allocation routine.  
                 
    
                 Contents are ignored if preceding parameter is   
-                 NULL.
-        
    H5MM_free_t free
-            
    IN: User's free routine, or    NULL 
-                for system free. 
-        
    void *free_info
-            
    IN: Extra parameter for user's free routine.  
+                 NULL.
    H5MM_free_t freeIN: User's free routine, or    NULL 
+                for system free.
    void *free_infoIN: Extra parameter for user's free routine.  
                 
    
                 Contents are ignored if preceding parameter is   
-                 NULL.
-    
+                 NULL.

   
Returns:
     
Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -8921,7 +9396,7 @@ SUBROUTINE
   
Parameters:
     
    
-        
+        
@@ -9202,14 +9677,13 @@ And in this document, the
 
    
     
    H5P_class_t classH5P_class_t class    
         IN: Property list class from which to remove 
 	        permanent property
    
     
    
 
    
 

-

-

+

 HDF Help Desk 
 

 Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0
 

  
diff --git a/doc/html/RM_H5R.html b/doc/html/RM_H5R.html
index 1443e11..5c93eb9 100644
--- a/doc/html/RM_H5R.html
+++ b/doc/html/RM_H5R.html
@@ -61,8 +61,7 @@ And in this document, the
-
-
+

H5R: Reference Interface

@@ -195,27 +194,32 @@ as the corresponding C function. to be pointed to for a dataset region reference. This parameter is unused with object references.
Parameters: -
-
void *ref -
OUT: Reference created by the function call. -
hid_t loc_id -
IN: Location identifier used to locate the object being - pointed to. -
const char *name -
IN: Name of object at location loc_id. -
H5R_type_t ref_type -
IN: Type of reference. -
hid_t space_id -
IN: Dataspace identifier with selection. - Used for dataset region references. -
+
    + + + + + + + + + + + + + + + +
    void *refOUT: Reference created by the function call.
    hid_t loc_idIN: Location identifier used to locate the object being + pointed to.
    const char *nameIN: Name of object at location loc_id.
    H5R_type_t ref_type    IN: Type of reference.
    hid_t space_idIN: Dataspace identifier with selection. + Used for dataset region references.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Fortran90 Interface: h5rcreate_f -

To create an object reference -

+

To create an object reference + 

 SUBROUTINE h5rcreate_f(loc_id, name, ref, hdferr) 
   IMPLICIT NONE
@@ -227,9 +231,10 @@ SUBROUTINE h5rcreate_f(loc_id, name, ref, hdferr)
 
 END SUBROUTINE h5rcreate_f
+ + +
To create a region reference -
To create a region reference - 
 SUBROUTINE h5rcreate_f(loc_id, name, space_id, ref, hdferr) 
   IMPLICIT NONE
@@ -275,14 +280,17 @@ END SUBROUTINE h5rcreate_f
         
  • H5R_DATASET_REGION  (1)
         
 
    Parameters:
-    
    
-        
    hid_t dataset
-            
    IN: Dataset containing reference object.
-        
    H5R_type_t ref_type
-            
    IN: The reference type of ref.
-        
    void *ref
-            
    IN: Reference to open.
-    
    
+    
      
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
      hid_t datasetIN: Dataset containing reference object.
      H5R_type_t ref_type    IN: The reference type of ref.
      void *refIN: Reference to open.
    
 
    Returns:
     
    Returns valid identifier if successful;
         otherwise returns a negative value.
@@ -374,16 +382,19 @@ END SUBROUTINE h5rdereference_f
 	
 	
 
    Parameters:
-    
    
-        
    hid_t id,
-            
    IN: The dataset containing the reference object or 
+    
      
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
      hid_t id,IN: The dataset containing the reference object or 
                 the location identifier of the object that the 
-                dataset is located within.
-        
      H5R_type_t ref_type
-            
      IN: Type of reference to query.
-        
      void *ref
-            
      IN: Reference to query.
-    
+                dataset is located within.
      H5R_type_t ref_type    IN: Type of reference to query.
      void *refIN: Reference to query.
    
 
    Returns:
     
    Returns an object type as defined in H5Gpublic.h if successful;
         otherwise returns H5G_UNKNOWN.
@@ -439,14 +450,17 @@ END SUBROUTINE h5rget_object_type_f
         
  • H5R_DATASET_REGION  (1)
         
 
    Parameters:
-    
    
-        
    hid_t dataset,
-            
    IN: Dataset containing reference object.
-        
    H5R_type_t ref_type,
-            
    IN: The reference type of ref.
-        
    void *ref
-            
    IN: Reference to open.
-    
    
+    
      
+        
+		    
+            
+        
+		    
+            
+        
+		    
+            
+    
      hid_t datasetIN: Dataset containing reference object.
      H5R_type_t ref_type    IN: The reference type of ref.
      void *refIN: Reference to open.
    
 
    Returns:
     
    Returns a valid identifier if successful;
         otherwise returns a negative value.
@@ -504,14 +518,13 @@ And in this document, the
    • -
    -
    +
    HDF Help Desk
    Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0
    diff --git a/doc/html/RM_H5S.html b/doc/html/RM_H5S.html index b977c0b..ba530a1 100644 --- a/doc/html/RM_H5S.html +++ b/doc/html/RM_H5S.html @@ -61,8 +61,7 @@ And in this document, the -
    -
    +

    H5S: Dataspace Interface

    @@ -251,10 +250,11 @@ of the HDF5 User's Guide.. Failure to release a dataspace with this call will result in resource leaks.
    Parameters: -
    -
    hid_t space_id -
    Identifier of dataspace to release. -
    +
      + + + +
      hid_t space_id    Identifier of dataspace to release.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -293,10 +293,11 @@ END SUBROUTINE h5sclose_f The dataspace identifier returned from this function should be released with H5Sclose or resource leaks will occur.
    Parameters: -
    -
    hid_t space_id -
    Identifier of dataspace to copy. -
    +
      + + + +
      hid_t space_id    Identifier of dataspace to copy.
    Returns:
    Returns a dataspace identifier if successful; otherwise returns a negative value. @@ -336,10 +337,11 @@ END SUBROUTINE h5scopy_f H5S_SIMPLE; others are planned to be added later.
    Parameters: -
    -
    H5S_class_t type -
    The type of dataspace to be created. -
    +
      + + + +
      H5S_class_t type    The type of dataspace to be created.
    Returns:
    Returns a dataspace identifier if successful; otherwise returns a negative value. @@ -402,14 +404,17 @@ END SUBROUTINE h5screate_f The dataspace identifier returned from this function must be released with H5Sclose or resource leaks will occur.
    Parameters: -
    -
    int rank -
    Number of dimensions of dataspace. -
    const hsize_t * dims -
    An array of the size of each dimension. -
    const hsize_t * maxdims -
    An array of the maximum size of each dimension. -
    +
      + + + + + + + + + +
      int rankNumber of dimensions of dataspace.
      const hsize_t * dimsAn array of the size of each dimension.
      const hsize_t * maxdims    An array of the maximum size of each dimension.
    Returns:
    Returns a dataspace identifier if successful; otherwise returns a negative value. @@ -453,14 +458,16 @@ END SUBROUTINE h5screate_simple_f source_space_id to dest_space_id. This action may change the type of the dataspace.
    Parameters: -
    -
    hid_t dest_space_id -
    IN: The identifier for the dataspace to which - the extent is copied. -
    hid_t source_space_id -
    IN: The identifier for the dataspace from which - the extent is copied. -
    +
      + + + + + + +
      hid_t dest_space_idIN: The identifier for the dataspace to which + the extent is copied.
      hid_t source_space_id    IN: The identifier for the dataspace from which + the extent is copied.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -517,15 +524,18 @@ END SUBROUTINE h5sextent_copy_f Calling this function on a none selection will return FAIL.
    Parameters: -
    -
    hid_t space_id -
    IN: Identifier of dataspace to query. -
    hssize_t *start -
    OUT: Starting coordinates of the bounding box. -
    hssize_t *end -
    OUT: Ending coordinates of the bounding box, - i.e., the coordinates of the diagonally opposite corner. -
    +
      + + + + + + + + + +
      hid_t space_id    IN: Identifier of dataspace to query.
      hssize_t *startOUT: Starting coordinates of the bounding box.
      hssize_t *endOUT: Ending coordinates of the bounding box, + i.e., the coordinates of the diagonally opposite corner.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -559,10 +569,11 @@ END SUBROUTINE h5sextent_copy_f
    H5Sget_select_elem_npoints returns the number of element points in the current dataspace selection.
    Parameters: -
    -
    hid_t space_id -
    IN: Identifier of dataspace to query. -
    +
      + + + +
      hid_t space_id    IN: Identifier of dataspace to query.
    Returns:
    Returns the number of element points in the current dataspace selection if successful. Otherwise returns a negative value. @@ -623,16 +634,20 @@ 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.
    Parameters: -
    -
    hid_t space_id -
    IN: Dataspace identifier of selection to query. -
    hsize_t startpoint -
    IN: Element point to start with. -
    hsize_t numpoints -
    IN: Number of element points to get. -
    hsize_t *buf -
    OUT: List of element points selected. -
    +
      + + + + + + + + + + + + +
      hid_t space_idIN: Dataspace identifier of selection to query.
      hsize_t startpoint    IN: Element point to start with.
      hsize_t numpointsIN: Number of element points to get.
      hsize_t *bufOUT: List of element points selected.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -698,16 +713,20 @@ END SUBROUTINE h5sget_select_elem_pointlist_f

    No guarantee is implied as the order in which blocks are listed.

    Parameters: -
    -
    hid_t space_id -
    IN: Dataspace identifier of selection to query. -
    hsize_t startblock -
    IN: Hyperslab block to start with. -
    hsize_t numblocks -
    IN: Number of hyperslab blocks to get. -
    hsize_t *buf -
    OUT: List of hyperslab blocks selected. -
    +
      + + + + + + + + + + + + +
      hid_t space_idIN: Dataspace identifier of selection to query.
      hsize_t startblock    IN: Hyperslab block to start with.
      hsize_t numblocksIN: Number of hyperslab blocks to get.
      hsize_t *bufOUT: List of hyperslab blocks selected.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -750,10 +769,11 @@ END SUBROUTINE h5sget_select_hyper_blocklist_f
    H5Sget_select_hyper_nblocks returns the number of hyperslab blocks in the current dataspace selection.
    Parameters: -
    -
    hid_t space_id -
    IN: Identifier of dataspace to query. -
    +
      + + + +
      hid_t space_id    IN: Identifier of dataspace to query.
    Returns:
    Returns the number of hyperslab blocks in the current dataspace selection if successful. @@ -791,10 +811,11 @@ END SUBROUTINE h5sget_select_hyper_nblocks_f
    H5Sget_select_npoints determines the number of elements in the current selection of a dataspace.
    Parameters: -
    -
    hid_t space_id -
    Dataspace identifier. -
    +
      + + + +
      hid_t space_id    Dataspace identifier.
    Returns:
    Returns the number of elements in the selection if successful; otherwise returns a negative value. @@ -833,10 +854,11 @@ END SUBROUTINE h5sget_select_npoints_f type of selection currently defined for the dataspace space_id.
    Parameters: -
    -
    hid_t space_id -
    Dataspace identifier. -
    +
      + + + +
      hid_t space_id    Dataspace identifier.
    Returns:
    Returns the dataspace selection type, a value of the enumerated datatype H5S_sel_type, @@ -913,14 +935,17 @@ END SUBROUTINE h5sget_select_type_f H5S_UNLIMITED (-1), the maximum size of that dimension is unlimited.
    Parameters: -
    -
    hid_t space_id -
    IN: Identifier of the dataspace object to query -
    hsize_t *dims -
    OUT: Pointer to array to store the size of each dimension. -
    hsize_t *maxdims -
    OUT: Pointer to array to store the maximum size of each dimension. -
    +
      + + + + + + + + + +
      hid_t space_idIN: Identifier of the dataspace object to query
      hsize_t *dimsOUT: Pointer to array to store the size of each dimension.
      hsize_t *maxdims    OUT: Pointer to array to store the maximum size of each dimension.
    Returns:
    Returns the number of dimensions in the dataspace if successful; otherwise returns a negative value. @@ -961,10 +986,11 @@ END SUBROUTINE h5sget_simple_extent_dims_f
    H5Sget_simple_extent_ndims determines the dimensionality (or rank) of a dataspace.
    Parameters: -
    -
    hid_t space_id -
    Identifier of the dataspace -
    +
      + + + +
      hid_t space_id    Identifier of the dataspace
    Returns:
    Returns the number of dimensions in the dataspace if successful; otherwise returns a negative value. @@ -1002,10 +1028,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.
    Parameters: -
    -
    hid_t space_id -
    ID of the dataspace object to query -
    +
      + + + +
      hid_t space_id    ID of the dataspace object to query
    Returns:
    Returns the number of elements in the dataspace if successful; otherwise returns 0. @@ -1047,10 +1074,11 @@ END SUBROUTINE h5sget_simple_extent_npoints_f H5S_SIMPLE, or H5S_NONE.
    Parameters: -
    -
    hid_t space_id -
    Dataspace identifier. -
    +
      + + + +
      hid_t space_id    Dataspace identifier.
    Returns:
    Returns a dataspace class name if successful; otherwise H5S_NO_CLASS (-1). @@ -1092,10 +1120,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]
    Parameters: -
    -
    hid_t space_id -
    Identifier of the dataspace to query -
    +
      + + + +
      hid_t space_id    Identifier of the dataspace to query
    Returns:
    When successful, returns a positive value, for TRUE, or 0 (zero), for FALSE. @@ -1145,12 +1174,14 @@ END SUBROUTINE h5sis_simple_f to different locations within a dataspace without requiring it to be redefined.
    Parameters: -
    -
    hid_t space_id -
    IN: The identifier for the dataspace object to reset. -
    const hssize_t *offset -
    IN: The offset at which to position the selection. -
    +
      + + + + + + +
      hid_t space_idIN: The identifier for the dataspace object to reset.
      const hssize_t *offset    IN: The offset at which to position the selection.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -1194,11 +1225,12 @@ END SUBROUTINE h5soffset_simple_f space_id. H5S_SELECT_ALL selects the entire dataspace for any dataspace it is applied to.
    Parameters: -
    -
    hid_t space_id -
    IN: The identifier for the dataspace in which the - selection is being made. -
    +
      + + + +
      hid_t space_id    IN: The identifier for the dataspace in which the + selection is being made.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -1284,18 +1316,22 @@ END SUBROUTINE h5sselect_all_f the selection ordering is reset to C array ordering. -->
    Parameters: -
    -
    hid_t space_id -
    Identifier of the dataspace. -
    H5S_seloper_t op -
    Operator specifying how the new selection is to be - combined with the existing selection for the dataspace. -
    const size_t num_elements -
    Number of elements to be selected. -
    const hssize_t *coord[ ] -
    A 2-dimensional array of 0-based values specifying the - coordinates of the elements being selected. -
    +
      + + + + + + + + + + + + +
      hid_t space_idIdentifier of the dataspace.
      H5S_seloper_t opOperator specifying how the new selection is to be + combined with the existing selection for the dataspace.
      const size_t num_elements    Number of elements to be selected.
      const hssize_t *coord[ ]A 2-dimensional array of 0-based values specifying the + coordinates of the elements being selected.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -1313,7 +1349,9 @@ SUBROUTINE h5sselect_elements_f(space_id, operator, num_elements, & INTEGER(HSSIZE_T), DIMENSION(*,*), INTENT(IN) :: coord ! Array with the coordinates ! of the selected elements: - ! coord(num_elements, rank) + ! coord(num_elements, rank) + +
       INTEGER, INTENT(OUT) :: hdferr          ! Error code
                                           ! 0 on success and -1 on failure
 END SUBROUTINE h5sselect_elements_f
@@ -1438,20 +1476,26 @@ END SUBROUTINE h5sselect_elements_f
         Regions selected with this function call default to C order 
         iteration when I/O is performed.
 
    Parameters:
-    
     
-        
    hid_t space_id
-            
    IN: Identifier of dataspace selection to modify
-        
    H5S_seloper_t op
-            
    IN: Operation to perform on current selection.
-        
    const hssize_t *start
-            
    IN: Offset of start of hyperslab
-        
    const hsize_t *count
-            
    IN: Number of blocks included in hyperslab.
-        
    const hsize_t *stride
-            
    IN: Hyperslab stride.
-        
    const hsize_t *block
-            
    IN: Size of block in hyperslab.
-    
    
+    
      
+        
+		  
+          
+        
+		  
+          
+        
+		  
+          
+        
+		  
+          
+        
+		  
+          
+        
+		  
+          
+    
      hid_t space_idIN: Identifier of dataspace selection to modify
      H5S_seloper_t opIN: Operation to perform on current selection.
      const hssize_t *startIN: Offset of start of hyperslab
      const hsize_t *countIN: Number of blocks included in hyperslab.
      const hsize_t *stride    IN: Hyperslab stride.
      const hsize_t *blockIN: Size of block in hyperslab.
    
 
    Returns:
     
    Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -1501,11 +1545,12 @@ END SUBROUTINE h5sselect_hyperslab_f
     
    H5Sselect_none resets the selection region 
     for the dataspace space_id to include no elements.     
 
    Parameters:
-    
    
-        
    hid_t space_id
-            
    IN: The identifier for the dataspace in which the 
-                selection is being reset.
-    
    
+    
      
+        
+		  
+          
+    
      hid_t space_id    IN: The identifier for the dataspace in which the 
+                selection is being reset.
    
 
    Returns:
     
    Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -1542,10 +1587,11 @@ END SUBROUTINE h5sselect_none_f
     for the dataspace space_id is within the extent
     of the dataspace if the current offset for the dataspace is used.
 
    Parameters:
-    
    
-        
    hid_t space_id
-            
    The identifier for the dataspace being queried.
-    
    
+    
      
+        
+		  
+          
+    
      hid_t space_id    The identifier for the dataspace being queried.
    
 
    Returns:
     
    Returns a positive value, for TRUE, 
         if the selection is contained within the extent 
@@ -1587,11 +1633,12 @@ END SUBROUTINE h5sselect_valid_f
     
    H5Sset_extent_none removes the extent from 
     a dataspace and sets the type to H5S_NO_CLASS.
 
    Parameters:
-    
    
-        
    hid_t space_id
-            
    The identifier for the dataspace from which
-                the extent is to be removed.
-    
    
+    
      
+        
+		  
+          
+    
      hid_t space_id    The identifier for the dataspace from which
+                the extent is to be removed.
    
 
    Returns:
     
    Returns a non-negative value if successful;
         otherwise returns a negative value.
@@ -1644,16 +1691,20 @@ END SUBROUTINE h5sset_extent_none_f
         type is set to H5S_SIMPLE, and the extent is set as 
         specified.
 
    Parameters:
-    
    
-        
    hid_t space_id
-            
    Dataspace identifier.
-        
    int rank
-            
    Rank, or dimensionality, of the dataspace.
-        
    const hsize_t *current_size
-            
    Array containing current size of dataspace.
-        
    const hsize_t *maximum_size
-            
    Array containing maximum size of dataspace.
-    
    
+    
      
+        
+		  
+          
+        
+		  
+          
+        
+		  
+          
+        
+		  
+          
+    
      hid_t space_idDataspace identifier.
      int rankRank, or dimensionality, of the dataspace.
      const hsize_t *current_size    Array containing current size of dataspace.
      const hsize_t *maximum_sizeArray containing maximum size of dataspace.
    
 
    Returns:
     
    Returns a dataspace identifier if successful; 
         otherwise returns a negative value.
@@ -1800,14 +1851,13 @@ And in this document, the
    -
    -
    +
    HDF Help Desk
    Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0
    diff --git a/doc/html/RM_H5T.html b/doc/html/RM_H5T.html index 880faa9..6846776 100644 --- a/doc/html/RM_H5T.html +++ b/doc/html/RM_H5T.html @@ -61,8 +61,7 @@ And in this document, the -
    -
    +

    H5T: Datatype Interface

    @@ -409,20 +408,24 @@ in the HDF5 User's Guide for further information, including a compl permutation, i.e. C versus FORTRAN array order.   (The parameter perm is currently unused and is not yet implemented.) -

    +

    Parameters: -
    -
    hid_t base -
    IN: Datatype identifier for the array base datatype. -
    int rank -
    IN: Rank of the array. -
    const hsize_t dims[/*rank*/] -
    IN: Size of each array dimension. -
    const int perm[/*rank*/] -
    IN: Dimension permutation. +
      + + + + + + + + + + + + +
      hid_t baseIN: Datatype identifier for the array base datatype.
      int rankIN: Rank of the array.
      const hsize_t dims[/*rank*/]    IN: Size of each array dimension.
      const int perm[/*rank*/]IN: Dimension permutation.   - (Currently not implemented.) - + (Currently not implemented.)
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -463,10 +466,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.
    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to release. -
    +
      + + + +
      hid_t type_id    Identifier of datatype to release.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -508,14 +512,17 @@ END SUBROUTINE h5tclose_f which, when combined with name, refers to a new named datatype.
    Parameters: -
    -
    hid_t loc_id -
    IN: A file or group identifier. -
    const char * name -
    IN: A datatype name. -
    hid_t type -
    IN: A datatype identifier. -
    +
      + + + + + + + + + +
      hid_t loc_idIN: A file or group identifier.
      const char * name    IN: A datatype name.
      hid_t typeIN: A datatype identifier.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -558,10 +565,11 @@ END SUBROUTINE h5tcommit_f return committed datatypes with H5Dget_type() are able to share the datatype with other datasets in the same file.
    Parameters: -
    -
    hid_t type -
    IN: Datatype identifier. -
    +
      + + + +
      hid_t type    IN: Datatype identifier.
    Returns:
    When successful, returns a positive value, for TRUE, if the datatype has been committed, or 0 (zero), @@ -620,20 +628,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.
    Parameters: -
    -
    hid_t src_id -
    Identifier for the source datatype. -
    hid_t dst_id -
    Identifier for the destination datatype. -
    hsize_t nelmts -
    Size of array buf. -
    void *buf -
    Array containing pre- and post-conversion values. -
    void *background -
    Optional background buffer. -
    hid_t plist_id -
    Dataset transfer property list identifier. -
    +
      + + + + + + + + + + + + + + + + + + +
      hid_t src_idIdentifier for the source datatype.
      hid_t dst_idIdentifier for the destination datatype.
      hsize_t nelmtsSize of array buf.
      void *bufArray containing pre- and post-conversion values.
      void *background    Optional background buffer.
      hid_t plist_idDataset transfer property list identifier.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -730,12 +744,13 @@ SUBROUTINE
    -->
    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to copy. Can be a datatype +
      + + + +
      hid_t type_id    Identifier of datatype to copy. Can be a datatype identifier, a predefined datatype (defined in - H5Tpublic.h), or a dataset identifier. - + H5Tpublic.h), or a dataset identifier.
    Returns:
    Returns a datatype identifier if successful; otherwise returns a negative value @@ -786,12 +801,14 @@ END SUBROUTINE h5tcopy_f The datatype identifier returned from this function should be released with H5Tclose or resource leaks will result.
    Parameters: -
    -
    H5T_class_t class -
    Class of datatype to create. -
    size_t size -
    The number of bytes in the datatype to create. -
    +
      + + + + + + +
      H5T_class_t class    Class of datatype to create.
      size_t sizeThe number of bytes in the datatype to create.
    Returns:
    Returns datatype identifier if successful; otherwise returns a negative value. @@ -842,12 +859,14 @@ END SUBROUTINE h5tcreate_f Valid class identifiers are as defined in H5Tget_class.
    Parameters: -
    -
    hid_t dtype_id -
    Datatype identifier. -
    H5T_class_tdtype_class -
    Datatype class. -
    +
      + + + + + + +
      hid_t dtype_idDatatype identifier.
      H5T_class_t dtype_class    Datatype class.
    Returns:
    Returns TRUE or FALSE if successful; otherwise returns a negative value. @@ -883,10 +902,11 @@ SUBROUTINE based on the specified base datatype, parent_id, which must be an integer type.
    Parameters: -
    -
    hid_t parent_id -
    IN: Datatype identifier for the base datatype. -
    +
      + + + +
      hid_t parent_id    IN: Datatype identifier for the base datatype.
    Returns:
    Returns the datatype identifier for the new enumeration datatype if successful; otherwise returns a negative value. @@ -937,14 +957,17 @@ END SUBROUTINE h5tenum_create_f value points to data which is of the datatype defined when the enumeration datatype was created.
    Parameters: -
    -
    hid_t type -
    IN: Datatype identifier for the enumeration datatype. -
    const char *name -
    IN: Name of the new member. -
    void *value -
    IN: Pointer to the value of the new member. -
    +
      + + + + + + + + + +
      hid_t typeIN: Datatype identifier for the enumeration datatype.
      const char *name    IN: Name of the new member.
      void *valueIN: Pointer to the value of the new member.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -993,16 +1016,20 @@ END SUBROUTINE h5tenum_insert_f many characters as possible are copied (not null terminated) and the function fails.
    Parameters: -
    -
    hid_t type -
    IN: Enumeration datatype identifier. -
    void *value, -
    IN: Value of the enumeration datatype. -
    char *name, -
    OUT: Buffer for output of the symbol name. -
    size_t size -
    IN: Anticipated size of the symbol name, in bytes (characters). -
    +
      + + + + + + + + + + + + +
      hid_t typeIN: Enumeration datatype identifier.
      void *value,    IN: Value of the enumeration datatype.
      char *name,OUT: Buffer for output of the symbol name.
      size_t sizeIN: Anticipated size of the symbol name, in bytes (characters).
    Returns:
    Returns a non-negative value if successful. Otherwise returns a negative value @@ -1051,14 +1078,17 @@ END SUBROUTINE h5tenum_nameof_f as large as the value of H5Tget_size(type) in order to hold the result.
    Parameters: -
    -
    hid_t type -
    IN: Enumeration datatype identifier. -
    const char *name, -
    IN: Symbol name of the enumeration datatype. -
    void *value, -
    OUT: Buffer for output of the value of the enumeration datatype. -
    +
      + + + + + + + + + +
      hid_t typeIN: Enumeration datatype identifier.
      const char *name,    IN: Symbol name of the enumeration datatype.
      void *value,OUT: Buffer for output of the value of the enumeration datatype.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -1097,12 +1127,14 @@ END SUBROUTINE h5tenum_valueof_f
    H5Tequal determines whether two datatype identifiers refer to the same datatype.
    Parameters: -
    -
    hid_t type_id1 -
    Identifier of datatype to compare. -
    hid_t type_id2 -
    Identifier of datatype to compare. -
    +
      + + + + + + +
      hid_t type_id1    Identifier of datatype to compare.
      hid_t type_id2Identifier of datatype to compare.
    Returns:
    When successful, returns a positive value, for TRUE, if the datatype identifiers refer to the same datatype, @@ -1150,14 +1182,17 @@ END SUBROUTINE h5tequal_f by the soft type conversion function of this path when the conversion function was installed on the path.
    Parameters: -
    -
    hid_t src_id -
    IN: Identifier for the source datatype. -
    hid_t dst_id -
    IN: Identifier for the destination datatype. -
    H5T_cdata_t **pcdata -
    OUT: Pointer to type conversion data. -
    +
      + + + + + + + + + +
      hid_t src_idIN: Identifier for the source datatype.
      hid_t dst_idIN: Identifier for the destination datatype.
      H5T_cdata_t **pcdata    OUT: Pointer to type conversion data.
    Returns:
    Returns a pointer to a suitable conversion function if successful. Otherwise returns NULL. @@ -1198,14 +1233,17 @@ SUBROUTINE The dimension permutations, i.e., C versus FORTRAN array order, are returned in the array perm.
    Parameters: -
    -
    hid_t adtype_id -
    IN: Datatype identifier of array object. -
    hsize_t *dims[] -
    OUT: Sizes of array dimensions. -
    int *perm[] -
    OUT: Dimension permutations. -
    +
      + + + + + + + + + +
      hid_t adtype_id    IN: Datatype identifier of array object.
      hsize_t *dims[]OUT: Sizes of array dimensions.
      int *perm[]OUT: Dimension permutations.
    Returns:
    Returns the non-negative number of dimensions of the array type if successful; otherwise returns a negative value. @@ -1244,10 +1282,11 @@ END SUBROUTINE h5tget_array_dims_f
    H5Tget_array_ndims returns the rank, the number of dimensions, of an array datatype object.
    Parameters: -
    -
    hid_t adtype_id -
    IN: Datatype identifier of array object. -
    +
      + + + +
      hid_t adtype_id    IN: Datatype identifier of array object.
    Returns:
    Returns the rank of the array if successful; otherwise returns a negative value. @@ -1297,10 +1336,11 @@ END SUBROUTINE h5tget_array_ndims_f
  • H5T_ARRAY
    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to query. -
    +
      + + + +
      hid_t type_id    Identifier of datatype to query.
    Returns:
    Returns datatype class identifier if successful; otherwise H5T_NO_CLASS (-1). @@ -1347,15 +1387,16 @@ END SUBROUTINE h5tget_class_f
    Description:
    H5Tget_cset retrieves the character set type of a string datatype. Valid character set types are: -
      +
        H5T_CSET_ASCII (0)
        Character set is US ASCII -
    +
    • Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to query. -
    +
      + + + +
      hid_t type_id    Identifier of datatype to query.
    Returns:
    Returns a valid character set type if successful; otherwise H5T_CSET_ERROR (-1). @@ -1394,10 +1435,11 @@ END SUBROUTINE h5tget_cset_f
    Description:
    H5Tget_ebias retrieves the exponent bias of a floating-point type.
    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to query. -
    +
      + + + +
      hid_t type_id    Identifier of datatype to query.
    Returns:
    Returns the bias if successful; otherwise 0. @@ -1443,20 +1485,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.
    Parameters: -
    -
    hid_t type_id -
    IN: Identifier of datatype to query. -
    size_t *spos -
    OUT: Pointer to location to return floating-point sign bit. -
    size_t *epos -
    OUT: Pointer to location to return exponent bit-position. -
    size_t *esize -
    OUT: Pointer to location to return size of exponent in bits. -
    size_t *mpos -
    OUT: Pointer to location to return mantissa bit-position. -
    size_t *msize -
    OUT: Pointer to location to return size of mantissa in bits. -
    +
      + + + + + + + + + + + + + + + + + + +
      hid_t type_id    IN: Identifier of datatype to query.
      size_t *sposOUT: Pointer to location to return floating-point sign bit.
      size_t *eposOUT: Pointer to location to return exponent bit-position.
      size_t *esizeOUT: Pointer to location to return size of exponent in bits.
      size_t *mposOUT: Pointer to location to return mantissa bit-position.
      size_t *msizeOUT: Pointer to location to return size of mantissa in bits.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -1505,10 +1553,11 @@ END SUBROUTINE h5tget_fields_f
    Leave background alone.
    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to query. -
    +
      + + + +
      hid_t type_id    Identifier of datatype to query.
    Returns:
    Returns a valid padding type if successful; otherwise H5T_PAD_ERROR (-1). @@ -1553,12 +1602,14 @@ END SUBROUTINE h5tget_inpad_f H5Tget_member_class returns the datatype class of the compound datatype member specified by member_no.
    Parameters: -
    -
    hid_t cdtype_id -
    IN: Datatype identifier of compound object. -
    int member_no -
    IN: Compound object member number. -
    +
      + + + + + + +
      hid_t cdtype_id    IN: Datatype identifier of compound object.
      int member_noIN: Compound object member number.
    Returns:
    Returns the datatype class, a non-negative value, if successful; otherwise returns a negative value. @@ -1599,12 +1650,14 @@ END SUBROUTINE h5tget_inpad_f with index values of 0 through N-1, where N is the value returned by H5Tget_nmembers.
    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to query. -
    const char * field_name -
    Name of the field or member whose index is to be retrieved. -
    +
      + + + + + + +
      hid_t type_idIdentifier of datatype to query.
      const char * field_name    Name of the field or member whose index is to be retrieved.
    Returns:
    Returns a valid field or member index if successful; otherwise returns a negative value. @@ -1650,13 +1703,15 @@ END SUBROUTINE h5tget_inpad_f allocated with malloc() and the caller is responsible for freeing the memory used.
    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to query. -
    int field_idx -
    Zero-based index of the field or element whose name - is to be retrieved. -
    +
      + + + + + + +
      hid_t type_id    Identifier of datatype to query.
      int field_idxZero-based index of the field or element whose name + is to be retrieved.
    Returns:
    Returns a valid pointer to a string allocated with malloc() if successful; @@ -1701,12 +1756,14 @@ END SUBROUTINE h5tget_member_name_f compound datatype with respect to the beginning of the compound data type datum.
    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to query. -
    int memb_no -
    Number of the field whose offset is requested. -
    +
      + + + + + + +
      hid_t type_id    Identifier of datatype to query.
      int memb_noNumber of the field whose offset is requested.
    Returns:
    Returns the byte offset of the field if successful; otherwise returns 0 (zero). @@ -1750,12 +1807,14 @@ END SUBROUTINE h5tget_member_offset_f
    H5Tget_member_type returns the datatype of the specified member. The caller should invoke H5Tclose() to release resources associated with the type.
    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to query. -
    int field_idx -
    Field index (0-based) of the field type to retrieve. -
    +
      + + + + + + +
      hid_t type_id    Identifier of datatype to query.
      int field_idxField index (0-based) of the field type to retrieve.
    Returns:
    Returns the identifier of a copy of the datatype of the field if successful; @@ -1801,15 +1860,18 @@ END SUBROUTINE h5tget_member_type_f The member value is returned in a user-supplied buffer pointed to by value.
    Parameters: -
    -
    hid_t type -
    IN: Datatype identifier for the enumeration datatype. -
    int memb_no, -
    IN: Number of the enumeration datatype member. -
    void *value -
    OUT: Pointer to a buffer for output of the - value of the enumeration datatype member. -
    +
      + + + + + + + + + +
      hid_t typeIN: Datatype identifier for the enumeration datatype.
      int memb_no,IN: Number of the enumeration datatype member.
      void *value   OUT: Pointer to a buffer for output of the + value of the enumeration datatype member.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -1903,12 +1965,15 @@ END SUBROUTINE h5tget_member_value_f should eventually be closed by calling H5Tclose to release resources.
    Parameters: -
    -
    hid_t type_id -
    Datatype identifier for the dataset datatype. -
    H5T_direction_t direction -
    Direction of search. -
    +
      + + + + + + +
      hid_t type_idDatatype identifier for the dataset datatype.
      H5T_direction_t direction    Direction of search.
    +
    Returns:
    Returns the native datatype identifier for the specified dataset datatype if successful; @@ -1944,10 +2009,11 @@ SUBROUTINE the number of fields in a compound datatype or the number of members of an enumeration datatype.
    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to query. -
    +
      + + + +
      hid_t type_id    Identifier of datatype to query.
    Returns:
    Returns the number of elements if successful; otherwise returns a negative value. @@ -1993,10 +2059,11 @@ END SUBROUTINE h5tget_nmembers_f
    Mantissa is not normalized
    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to query. -
    +
      + + + +
      hid_t type_id    Identifier of datatype to query.
    Returns:
    Returns a valid normalization type if successful; otherwise H5T_NORM_ERROR (-1). @@ -2088,10 +2155,11 @@ END SUBROUTINE h5tget_norm_f
    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to query. -
    +
      + + + +
      hid_t type_id    Identifier of datatype to query.
    Returns:
    Returns an offset value if successful; otherwise returns a negative value. @@ -2139,10 +2207,11 @@ END SUBROUTINE h5tget_offset_f
    VAX mixed byte ordering (not currently supported).
    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to query. -
    +
      + + + +
      hid_t type_id    Identifier of datatype to query.
    Returns:
    Returns a byte order constant if successful; otherwise H5T_ORDER_ERROR (-1). @@ -2235,16 +2304,19 @@ SUBROUTINE
    Leave background alone.
    Parameters: -
    -
    hid_t type_id -
    IN: Identifier of datatype to query. -
    H5T_pad_t * lsb -
    OUT: Pointer to location to return least-significant - bit padding type. -
    H5T_pad_t * msb -
    OUT: Pointer to location to return most-significant - bit padding type. -
    +
      + + + + + + + + + +
      hid_t type_idIN: Identifier of datatype to query.
      H5T_pad_t * lsb    OUT: Pointer to location to return least-significant + bit padding type.
      H5T_pad_t * msbOUT: Pointer to location to return most-significant + bit padding type.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -2292,10 +2364,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().
    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to query. -
    +
      + + + +
      hid_t type_id    Identifier of datatype to query.
    Returns:
    Returns the number of significant bits if successful; otherwise 0. @@ -2338,10 +2411,11 @@ END SUBROUTINE h5tget_precision_f
    Two's complement signed integer type.
    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to query. -
    +
      + + + +
      hid_t type_id    Identifier of datatype to query.
    Returns:
    Returns a valid sign type if successful; otherwise H5T_SGN_ERROR (-1). @@ -2385,10 +2459,11 @@ END SUBROUTINE h5tget_sign_f
    Description:
    H5Tget_size returns the size of a datatype in bytes.
    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to query. -
    +
      + + + +
      hid_t type_id    Identifier of datatype to query.
    Returns:
    Returns the size of the datatype in bytes if successful; otherwise 0. @@ -2427,10 +2502,11 @@ END SUBROUTINE h5tget_size_f for a string datatype, as defined in H5Tset_strpad.
    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to query. -
    +
      + + + +
      hid_t type_id    Identifier of datatype to query.
    Returns:
    Returns a valid string storage mechanism if successful; otherwise H5T_STR_ERROR (-1). @@ -2475,10 +2551,11 @@ END SUBROUTINE h5tget_strpad_f

    In the case of an enumeration type, the return value is an integer type.

    Parameters: -
    -
    hid_t type -
    Datatype identifier for the derived datatype. -
    +
      + + + +
      hid_t type    Datatype identifier for the derived datatype.
    Returns:
    Returns the datatype identifier for the base datatype if successful; otherwise returns a negative value. @@ -2518,10 +2595,11 @@ END SUBROUTINE h5tget_super_f The tag is returned via a pointer to an allocated string, which the caller must free.
    Parameters: -
    -
    hid_t type_id -
    Datatype identifier for the opaque datatype. -
    +
      + + + +
      hid_t type_id    Datatype identifier for the opaque datatype.
    Returns:
    Returns a pointer to an allocated string if successful; otherwise returns NULL. @@ -2570,16 +2648,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.
    Parameters: -
    -
    hid_t type_id -
    Identifier of compound datatype to modify. -
    const char * name -
    Name of the field to insert. -
    size_t offset -
    Offset in memory structure of the field to insert. -
    hid_t field_id -
    Datatype identifier of the field to insert. -
    +
      + + + + + + + + + + + + +
      hid_t type_idIdentifier of compound datatype to modify.
      const char * name    Name of the field to insert.
      size_t offsetOffset in memory structure of the field to insert.
      hid_t field_idDatatype identifier of the field to insert.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -2623,10 +2705,11 @@ END SUBROUTINE h5tinsert_f This function can be used to distinguish between fixed and variable-length string datatypes.
    Parameters: -
    -
    hid_t dtype_id -
    Datatype identifier. -
    +
      + + + +
      hid_t dtype_id    Datatype identifier.
    Returns:
    Returns TRUE or FALSE if successful; otherwise returns a negative value. @@ -2670,10 +2753,11 @@ END SUBROUTINE h5tis_variable_str_f inadvertently change or delete a predefined type. Once a datatype is locked it can never be unlocked.
    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to lock. -
    +
      + + + +
      hid_t type_id    Identifier of datatype to lock.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -2711,12 +2795,15 @@ SUBROUTINE group identifier. The identifier should eventually be closed by calling H5Tclose to release resources.
    Parameters: -
    -
    hid_t loc_id -
    IN: A file or group identifier. -
    const char * name -
    IN: A datatype name, defined within the file or group identified by loc_id. -
    +
      + + + + + + +
      hid_t loc_idIN: A file or group identifier.
      const char * name    IN: A datatype name, defined within the file + or group identified by loc_id.
    Returns:
    Returns a named datatype identifier if successful; otherwise returns a negative value. @@ -2756,10 +2843,11 @@ END SUBROUTINE h5topen_f
    H5Tpack recursively removes padding from within a compound datatype to make it more efficient (space-wise) to store that data.
    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to modify. -
    +
      + + + +
      hid_t type_id    Identifier of datatype to modify.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -2853,19 +2941,24 @@ END SUBROUTINE h5tpack_f section of  “The Datatype Interface (H5T)” in the HDF5 User's Guide.
    Parameters: -
    -
    H5T_pers_t pers -
    H5T_PERS_HARD for hard conversion functions; - H5T_PERS_SOFT for soft conversion functions. -
    const char * name -
    Name displayed in diagnostic output. -
    hid_t src_id -
    Identifier of source datatype. -
    hid_t dst_id -
    Identifier of destination datatype. -
    H5T_conv_t func -
    Function to convert between source and destination datatypes. -
    +
      + + + + + + + + + + + + + + + +
      H5T_pers_t persH5T_PERS_HARD for hard conversion functions; + H5T_PERS_SOFT for soft conversion functions.
      const char * nameName displayed in diagnostic output.
      hid_t src_idIdentifier of source datatype.
      hid_t dst_idIdentifier of destination datatype.
      H5T_conv_t func    Function to convert between source and destination datatypes.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -2907,12 +3000,14 @@ SUBROUTINE
    Character set is US ASCII.
    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to modify. -
    H5T_cset_t cset -
    Character set type. -
    +
      + + + + + + +
      hid_t type_idIdentifier of datatype to modify.
      H5T_cset_t cset    Character set type.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -2952,12 +3047,14 @@ END SUBROUTINE h5tset_cset_f
    Description:
    H5Tset_ebias sets the exponent bias of a floating-point type.
    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to set. -
    size_t ebias -
    Exponent bias value. -
    +
      + + + + + + +
      hid_t type_id    Identifier of datatype to set.
      size_t ebiasExponent bias value.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -3006,21 +3103,27 @@ END SUBROUTINE h5tset_ebias_f

    Fields are not allowed to extend beyond the number of bits of precision, nor are they allowed to overlap with one another.

    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to set. -
    size_t spos -
    Sign position, i.e., the bit offset of the floating-point - sign bit. -
    size_t epos -
    Exponent bit position. -
    size_t esize -
    Size of exponent in bits. -
    size_t mpos -
    Mantissa bit position. -
    size_t msize -
    Size of mantissa in bits. -
    +
      + + + + + + + + + + + + + + + + + + +
      hid_t type_id    Identifier of datatype to set.
      size_t sposSign position, i.e., the bit offset of the floating-point + sign bit.
      size_t eposExponent bit position.
      size_t esizeSize of exponent in bits.
      size_t mposMantissa bit position.
      size_t msizeSize of mantissa in bits.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -3072,12 +3175,14 @@ END SUBROUTINE h5tset_fields_f
    Leave background alone.
    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to modify. -
    H5T_pad_t pad -
    Padding type. -
    +
      + + + + + + +
      hid_t type_idIdentifier of datatype to modify.
      H5T_pad_t pad    Padding type.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -3129,12 +3234,14 @@ END SUBROUTINE h5tset_inpad_f
    Mantissa is not normalized
    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to set. -
    H5T_norm_t norm -
    Mantissa normalization type. -
    +
      + + + + + + +
      hid_t type_idIdentifier of datatype to set.
      H5T_norm_t norm    Mantissa normalization type.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -3234,12 +3341,14 @@ the value from hanging over the edge of the datatype.

    The offset of an H5T_STRING cannot be set to anything but zero.

    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to set. -
    size_t offset -
    Offset of first significant bit. -
    +
      + + + + + + +
      hid_t type_id    Identifier of datatype to set.
      size_t offsetOffset of first significant bit.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -3286,12 +3395,14 @@ END SUBROUTINE h5tset_offset_f
    VAX mixed byte ordering (not currently supported).
    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to set. -
    H5T_order_t order -
    Byte ordering constant. -
    +
      + + + + + + +
      hid_t type_idIdentifier of datatype to set.
      H5T_order_t order    Byte ordering constant.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -3344,10 +3455,11 @@ END SUBROUTINE h5tset_order_f

    The NULL pointer may be passed to remove the overflow handler.

    Parameters: -
    -
    H5T_overflow_t func -
    Overflow function. -
    +
      + + + +
      H5T_overflow_t func    Overflow function.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -3381,23 +3493,26 @@ SUBROUTINE
    Sets the least and most-significant bits padding types.
    Description:
    H5Tset_pad sets the least and most-significant bits padding types. -
      +
        H5T_PAD_ZERO (0)
        Set background to zeros.
        H5T_PAD_ONE (1)
        Set background to ones.
        H5T_PAD_BACKGROUND (2)
        Leave background alone. -
    +
    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to set. -
    H5T_pad_t lsb -
    Padding type for least-significant bits. -
    H5T_pad_t msb -
    Padding type for most-significant bits. -
    +
      + + + + + + + + + +
      hid_t type_idIdentifier of datatype to set.
      H5T_pad_t lsb    Padding type for least-significant bits.
      H5T_pad_t msbPadding type for most-significant bits.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -3454,12 +3569,14 @@ END SUBROUTINE h5tset_pad_f locations and sizes of the sign, mantissa, and exponent fields first.
    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to set. -
    size_t precision -
    Number of bits of precision for datatype. -
    +
      + + + + + + +
      hid_t type_idIdentifier of datatype to set.
      size_t precision    Number of bits of precision for datatype.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -3502,12 +3619,14 @@ END SUBROUTINE h5tset_precision_f
    Two's complement signed integer type.
    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to set. -
    H5T_sign_t sign -
    Sign type. -
    +
      + + + + + + +
      hid_t type_idIdentifier of datatype to set.
      H5T_sign_t sign    Sign type.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -3563,12 +3682,14 @@ END SUBROUTINE h5tset_sign_f to 8*size. A compound datatype may increase in size, but may not shrink. All datatypes must have a positive size.
    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to change size. -
    size_t size -
    Size in bytes to modify datatype. -
    +
      + + + + + + +
      hid_t type_id    Identifier of datatype to change size.
      size_t sizeSize in bytes to modify datatype.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -3635,12 +3756,14 @@ END SUBROUTINE h5tset_size_f
    Parameters: -
    -
    hid_t type_id -
    Identifier of datatype to modify. -
    H5T_str_t strpad -
    String padding type. -
    +
      + + + + + + +
      hid_t type_idIdentifier of datatype to modify.
      H5T_str_t strpad    String padding type.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -3684,13 +3807,15 @@ END SUBROUTINE h5tset_strpad_f
    H5Tset_tag tags an opaque datatype type_id with a descriptive ASCII identifier, tag.
    Parameters: -
    -
    hid_t type_id -
    IN: Datatype identifier for the opaque datatype to be tagged. -
    const char *tag -
    IN: Descriptive ASCII string with which the - opaque datatype is to be tagged. -
    +
      + + + + + + +
      hid_t type_idIN: Datatype identifier for the opaque datatype to be tagged.
      const char *tag    IN: Descriptive ASCII string with which the + opaque datatype is to be tagged.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -3730,10 +3855,11 @@ END SUBROUTINE h5tset_tag_f The conversion function pointer type declaration is described in H5Tregister.
    Parameters: -
    -
    H5T_conv_t func -
    Function to remove from conversion paths. -
    +
      + + + +
      H5T_conv_t func    Function to remove from conversion paths.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -3777,10 +3903,11 @@ SUBROUTINE The datatype identifier returned from this function should be released with H5Tclose or resource leaks will result.
    Parameters: -
    -
    hid_t base_type_id -
    Base type of datatype to create. -
    +
      + + + +
      hid_t base_type_id    Base type of datatype to create.
    See Also:
    H5Dget_vlen_buf_size
    H5Dvlen_reclaim @@ -3840,14 +3967,13 @@ And in this document, the
    -
    -
    +
    HDF Help Desk
    Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0
    diff --git a/doc/html/RM_H5Z.html b/doc/html/RM_H5Z.html index b6c758b..58f14a8 100644 --- a/doc/html/RM_H5Z.html +++ b/doc/html/RM_H5Z.html @@ -62,8 +62,7 @@ And in this document, the -
    -
    +

    H5Z: Filter and Compression Interface

    @@ -158,10 +157,11 @@ data compression.
    H5Zfilter_avail determines whether the filter specified in filter is available to the application.
    Parameters: -
    -
    H5Z_filter_t filter -
    IN: Filter identifier. -
    +
      + + + +
      H5Z_filter_t filter    IN: Filter identifier.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -380,10 +380,11 @@ END SUBROUTINE h5zfilter_avail_f the set local and can apply callback functions first appeared in HDF5 Release 1.6.
    Parameters: -
    -
    const H5Z_class_t filter_class -
    IN: Struct containing filter-definition information. -
    +
      + + + +
      const H5Z_class_t filter_class    IN: Struct containing filter-definition information.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -420,10 +421,11 @@ END SUBROUTINE h5zfilter_avail_f specified in filter will no longer be available to the application.
    Parameters: -
    -
    H5Z_filter_t filter -
    IN: Identifier of the filter to be unregistered. -
    +
      + + + +
      H5Z_filter_t filter    IN: Identifier of the filter to be unregistered.
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value. @@ -483,14 +485,13 @@ And in this document, the
    -
    -
    +
    HDF Help Desk
    Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0
    diff --git a/doc/html/Tools.html b/doc/html/Tools.html index 8ee8382..767eab8 100644 --- a/doc/html/Tools.html +++ b/doc/html/Tools.html @@ -60,8 +60,7 @@ And in this document, the -
    -
    +

    HDF5 Tools

    @@ -171,9 +170,10 @@ installed with HDF5. --> + +

    -

    Tool Name: h5dump @@ -263,6 +263,7 @@ installed with HDF5. in opening the file.

    +
    XML Output:
    With the --xml option, h5dump generates XML output. This output contains a complete description of the file, @@ -342,7 +343,8 @@ installed with HDF5.
    Offset of start of subsetting selection.
    Default: the beginning of the dataset.
    -
    -S L   or   + +
    -S L   or   --stride=L
    Hyperslab stride.
    @@ -421,7 +423,8 @@ installed with HDF5.
    h5dump --xml bobo.h5 > bobo.h5.xml
    -
  • Dumping a subset of the dataset /GroupFoo/databar/ + +
  • Dumping a subset of the dataset /GroupFoo/databar/ in the file quux.h5
    h5dump -d /GroupFoo/databar --start="1,1" --stride="2,3" @@ -507,7 +510,7 @@ installed with HDF5.
    • - +
    Tool Name: h5ls @@ -584,7 +587,7 @@ installed with HDF5. -->
    - +
    Tool Name: h5diff    (Beta version) @@ -680,7 +683,7 @@ installed with HDF5. -->
    - +
    Tool Name: h5repart @@ -730,7 +733,7 @@ installed with HDF5. -->
    - +
    Tool Name: h5import @@ -1007,7 +1010,8 @@ installed with HDF5. Example:   4 3 4 38   for a 38x4x3x4 dataset. - + +
    PATH
    Path of the output dataset. @@ -1113,7 +1117,8 @@ installed with HDF5. (Default: 32) - + +
    OUTPUT-CLASS  
    A string denoting the type of output data. @@ -1201,7 +1206,8 @@ installed with HDF5. Little-endian. - + +
    The following options are disabled by default, making the default storage properties no chunking, no compression, no external storage, and no extensible dimensions. @@ -1283,7 +1289,8 @@ installed with HDF5.
    -

    + +

    The help option:
    The help option, expressed as one of @@ -1448,9 +1455,7 @@ installed with HDF5. --> - - - +
    Tool Name: gif2h5 @@ -1478,7 +1483,7 @@ installed with HDF5. -->
    - +
    Tool Name: h52gif @@ -1526,7 +1531,7 @@ installed with HDF5. -->
    - +
    Tool Name: h5toh4 @@ -1615,7 +1620,7 @@ installed with HDF5. Floating point datatypes are converted to IEEE format.
    Note: -
    The h5toh4 and h4toh5 utilities +
    The h5toh4 and h4toh5 utilities are no longer part of the HDF5 product; they are distributed separately through the page @@ -1641,7 +1646,7 @@ installed with HDF5. -->
    - +
    Tool Name: h4toh5 @@ -1737,7 +1742,7 @@ installed with HDF5.

    Note: -
    The h4toh5 and h5toh4 utilities +
    The h4toh5 and h5toh4 utilities are no longer part of the HDF5 product; they are distributed separately through the page @@ -1764,7 +1769,7 @@ installed with HDF5. -->
    - +
    Tool Name: h5perf @@ -1856,7 +1861,9 @@ installed with HDF5. (Default: All APIs)

    Example, --api=mpiio,phdf5 specifies that the MPI I/O and parallel HDf5 APIs are to be monitored.

    -
    -B size, --block-size=size + + +
    -B size, --block-size=size
    Specifies the block size within the transfer buffer. (Default: 128K)

    Block size versus transfer buffer size: @@ -1922,6 +1929,7 @@ installed with HDF5.
    -I, --interleaved
    Sets interleaved block I/O.
    (Default: Contiguous block I/O)

    + Interleaved vs. Contiguous blocks in a parallel environment:
    When contiguous blocks are written to a dataset, @@ -1986,7 +1994,7 @@ installed with HDF5. -->
    - +
    Tool Name: h5redeploy @@ -2037,7 +2045,7 @@ installed with HDF5. -->
    - +
    Tool Name: h5cc @@ -2193,7 +2201,7 @@ installed with HDF5. -->
    - +
    Tool Name: h5c++ @@ -2346,14 +2354,15 @@ And in this document, the -
    -
    +
    HDF Help Desk
    Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0 -
    - -Last modified: 30 October 2003 +
    -- cgit v0.12