diff options
author | Scot Breitenfeld <brtnfld@hdfgroup.org> | 2015-07-14 15:31:15 (GMT) |
---|---|---|
committer | Scot Breitenfeld <brtnfld@hdfgroup.org> | 2015-07-14 15:31:15 (GMT) |
commit | 50c000fb49a34be4b5e600be9c4fc7bdea298860 (patch) | |
tree | de34af2939f89a53fea6e7d9d07461f4d8b60b09 /fortran/src | |
parent | f50c602b01c0c40ce0bf3725f230b87e6826f967 (diff) | |
download | hdf5-50c000fb49a34be4b5e600be9c4fc7bdea298860.zip hdf5-50c000fb49a34be4b5e600be9c4fc7bdea298860.tar.gz hdf5-50c000fb49a34be4b5e600be9c4fc7bdea298860.tar.bz2 |
[svn-r27377] Cleaned-up comment formatting:
sed -e 's/^ \*[ ]*\([A-Z]\)\([a-z]\)/ * \1\2/g' H5Zf.c | sed -e 's/^ \*[ ]*\([a-z]\)/ * \1/g' | sed -e 's/^ \*[ ]*\([0-9]\)/ * \1/g'
Diffstat (limited to 'fortran/src')
-rw-r--r-- | fortran/src/H5Af.c | 436 | ||||
-rw-r--r-- | fortran/src/H5Df.c | 280 | ||||
-rw-r--r-- | fortran/src/H5Ef.c | 16 | ||||
-rw-r--r-- | fortran/src/H5Ff.c | 208 | ||||
-rw-r--r-- | fortran/src/H5Gf.c | 340 | ||||
-rw-r--r-- | fortran/src/H5If.c | 90 | ||||
-rw-r--r-- | fortran/src/H5Lf.c | 294 | ||||
-rw-r--r-- | fortran/src/H5Of.c | 60 | ||||
-rw-r--r-- | fortran/src/H5Pf.c | 1810 | ||||
-rw-r--r-- | fortran/src/H5Rf.c | 74 | ||||
-rw-r--r-- | fortran/src/H5Sf.c | 488 | ||||
-rw-r--r-- | fortran/src/H5Tf.c | 560 | ||||
-rw-r--r-- | fortran/src/H5Zf.c | 14 | ||||
-rw-r--r-- | fortran/src/H5_f.c | 126 | ||||
-rw-r--r-- | fortran/src/H5f90kit.c | 32 |
15 files changed, 2414 insertions, 2414 deletions
diff --git a/fortran/src/H5Af.c b/fortran/src/H5Af.c index d0ed250f..0fa84a3 100644 --- a/fortran/src/H5Af.c +++ b/fortran/src/H5Af.c @@ -1,6 +1,6 @@ /****h* H5Af/H5Af * PURPOSE - * This file contains C stubs for H5A Fortran APIs + * This file contains C stubs for H5A Fortran APIs * * COPYRIGHT * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * @@ -26,23 +26,23 @@ /****if* H5Af/h5acreate_c * NAME - * h5acreate_c + * h5acreate_c * PURPOSE - * Call H5Acreate2 to create an attribute + * Call H5Acreate2 to create an attribute * INPUTS - * obj_id - object identifier - * name - name of the attribute - * namelen - name length - * type_id - datatype identifier - * space_id - dataspace identifier - * crt_pr - identifier of creation property list + * obj_id - object identifier + * name - name of the attribute + * namelen - name length + * type_id - datatype identifier + * space_id - dataspace identifier + * crt_pr - identifier of creation property list * OUTPUTS - * attr_id - attribute identifier + * attr_id - attribute identifier * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Thursday, August 12, 1999 + * Thursday, August 12, 1999 * HISTORY * * SOURCE @@ -75,18 +75,18 @@ done: /****if* H5Af/h5adelete_c * NAME - * h5adelete_c + * h5adelete_c * PURPOSE - * Call H5Adelete to delete an attribute + * Call H5Adelete to delete an attribute * INPUTS - * obj_id - object identifier - * name - name of the attribute - * namelen - name length + * obj_id - object identifier + * name - name of the attribute + * namelen - name length * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Thursday, August 12, 1999 + * Thursday, August 12, 1999 * HISTORY * * SOURCE @@ -120,19 +120,19 @@ done: /****if* H5Af/h5aopen_idx_c * NAME - * h5aopen_idx_c + * h5aopen_idx_c * PURPOSE - * Call H5Aopen_by_idx to open an attribute + * Call H5Aopen_by_idx to open an attribute * INPUTS - * obj_id - object identifier - * idx - attribute index ( zero based) + * obj_id - object identifier + * idx - attribute index ( zero based) * OUTPUTS - * attr_id - attribute identifier + * attr_id - attribute identifier * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Thursday, August 12, 1999 + * Thursday, August 12, 1999 * HISTORY * * SOURCE @@ -156,18 +156,18 @@ done: /****if* H5Af/h5aget_space_c * NAME - * h5aget_space_c + * h5aget_space_c * PURPOSE - * Call H5Aget_space to get attribute's dataspace + * Call H5Aget_space to get attribute's dataspace * INPUTS - * attr_id - attribute identifier + * attr_id - attribute identifier * OUTPUTS - * space_id - dataspace identifier + * space_id - dataspace identifier * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Thursday, August 12, 1999 + * Thursday, August 12, 1999 * HISTORY * * SOURCE @@ -190,18 +190,18 @@ done: /****if* H5Af/h5aget_type_c * NAME - * h5aget_type_c + * h5aget_type_c * PURPOSE - * Call H5Aget_space to get attribute's datatype + * Call H5Aget_space to get attribute's datatype * INPUTS - * attr_id - attribute identifier + * attr_id - attribute identifier * OUTPUTS - * type_id - datatype identifier + * type_id - datatype identifier * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Thursday, August 12, 1999 + * Thursday, August 12, 1999 * HISTORY * * SOURCE @@ -224,18 +224,18 @@ done: /****if* H5Af/h5aget_num_attrs_c * NAME - * h5aget_num_attrs_c + * h5aget_num_attrs_c * PURPOSE - * Call H5Oget_info to determine number of - * attributes of an object + * Call H5Oget_info to determine number of + * attributes of an object * INPUTS - * obj_id - object identifier - * attr_num - number of attributes + * obj_id - object identifier + * attr_num - number of attributes * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Thursday, August 12, 1999 + * Thursday, August 12, 1999 * HISTORY * * SOURCE @@ -262,19 +262,19 @@ done: /****if* H5Af/h5aget_name_c * NAME - * h5aget_name_c + * h5aget_name_c * PURPOSE - * Call H5Aget_name to get attribute's name + * Call H5Aget_name to get attribute's name * INPUTS - * attr_id - attribute identifier - * bufsize - size of the buffer + * attr_id - attribute identifier + * bufsize - size of the buffer * OUTPUTS - * buf - buffer to hold the name + * buf - buffer to hold the name * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Thursday, August 12, 1999 + * Thursday, August 12, 1999 * HISTORY * * SOURCE @@ -313,18 +313,18 @@ done: /****if* H5Af/h5aget_storage_size_c * NAME - * h5aget_storage_size_c + * h5aget_storage_size_c * PURPOSE - * Call H5Aget_storage_size + * Call H5Aget_storage_size * INPUTS - * attr_id - identifier of an attribute + * attr_id - identifier of an attribute * OUTPUTS - * size - attributes storage requirements + * size - attributes storage requirements * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * January, 2008 + * January, 2008 * HISTORY * N/A * SOURCE @@ -345,18 +345,18 @@ done: /****if* H5Af/h5aget_create_plist_c * NAME - * h5aget_create_plist_c + * h5aget_create_plist_c * PURPOSE - * Call H5Aget_create_plist + * Call H5Aget_create_plist * INPUTS - * attr_id - identifier of an attribute + * attr_id - identifier of an attribute * OUTPUTS - * creation_prop_id - Identifier for the attribute’s creation property + * creation_prop_id - Identifier for the attribute’s creation property * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * January, 2008 + * January, 2008 * HISTORY * N/A * SOURCE @@ -377,26 +377,26 @@ done: /****if* H5Af/h5arename_by_name_c * NAME - * h5arename_by_name_c + * h5arename_by_name_c * PURPOSE - * Calls H5Arename_by_name + * Calls H5Arename_by_name * INPUTS - * loc_id - Object identifier - * obj_name - Name of object, relative to location, - * whose attribute is to be renamed - * obj_name_len - Object name length - * old_attr_name - Prior attribute name - * old_attr_name_len - Prior attribute name length - * new_attr_name - New attribute name - * new_attr_name_len - New attribute name length - * lapl_id - Link access property list identifier + * loc_id - Object identifier + * obj_name - Name of object, relative to location, + * whose attribute is to be renamed + * obj_name_len - Object name length + * old_attr_name - Prior attribute name + * old_attr_name_len - Prior attribute name length + * new_attr_name - New attribute name + * new_attr_name_len - New attribute name length + * lapl_id - Link access property list identifier * OUTPUTS * N/A * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * January, 2008 + * January, 2008 * HISTORY * N/A * SOURCE @@ -438,21 +438,21 @@ done: /****if* H5Af/h5aopen_c * NAME - * h5aopen_c + * h5aopen_c * PURPOSE - * Call H5Aopen to open an attribute + * Call H5Aopen to open an attribute * INPUTS - * obj_id - Identifer for object to which attribute is attached + * obj_id - Identifer for object to which attribute is attached * attr_name - Attribute access property list - * attr_namelen - size of attr_name - * aapl_id - Link access property list + * attr_namelen - size of attr_name + * aapl_id - Link access property list * OUTPUTS - * attr_id - dataset identifier + * attr_id - dataset identifier * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * January, 2008 + * January, 2008 * HISTORY * * SOURCE @@ -483,24 +483,24 @@ done: } /****if* H5Af/h5adelete_by_name_c * NAME - * h5adelete_by_name_c + * h5adelete_by_name_c * PURPOSE - * Call h5adelete_by_name to remove an attribute from a specified location + * Call h5adelete_by_name to remove an attribute from a specified location * INPUTS - * loc_id - identifer for object to which attribute is attached - * obj_name - object identifier - * obj_namelen - name length - * attr_name - name of the attribute - * attr_namelen - name length - * lapl_id - link access property list + * loc_id - identifer for object to which attribute is attached + * obj_name - object identifier + * obj_namelen - name length + * attr_name - name of the attribute + * attr_namelen - name length + * lapl_id - link access property list * * OUTPUTS * N/A * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * January, 2008 + * January, 2008 * HISTORY * N/A * SOURCE @@ -536,24 +536,24 @@ done: } /****if* H5Af/h5adelete_by_idx_c * NAME - * h5adelete_by_idx_c + * h5adelete_by_idx_c * PURPOSE - * Call h5adelete_by_idx + * Call h5adelete_by_idx * INPUTS - * loc_id - Location or object identifier; may be dataset or group - * obj_name - object identifier - * obj_namelen - name length - * attr_name - name of the attribute - * attr_namelen - name length - * lapl_id - link access property list + * loc_id - Location or object identifier; may be dataset or group + * obj_name - object identifier + * obj_namelen - name length + * attr_name - name of the attribute + * attr_namelen - name length + * lapl_id - link access property list * * OUTPUTS * N/A * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * January, 2008 + * January, 2008 * HISTORY * N/A * SOURCE @@ -586,44 +586,44 @@ done: } /****if* H5Af/h5aget_name_by_idx_c * NAME - * h5aget_name_by_idx_c + * h5aget_name_by_idx_c * PURPOSE - * Call h5aget_name_by_idx + * Call h5aget_name_by_idx * INPUTS * * - * loc_id - Identifer for object to which attribute is attached - * obj_name - Name of object, relative to location, - * from which attribute is to be removed *TEST* check NULL - * idx_type - Type of index; Possible values are: + * loc_id - Identifer for object to which attribute is attached + * obj_name - Name of object, relative to location, + * from which attribute is to be removed *TEST* check NULL + * idx_type - Type of index; Possible values are: * H5_INDEX_UNKNOWN - Unknown index type * H5_INDEX_NAME - Index on names * H5_INDEX_CRT_ORDER - Index on creation order * H5_INDEX_N - Number of indices defined * - * order - Order in which to iterate over index; Possible values are: + * order - Order in which to iterate over index; Possible values are: * H5_ITER_UNKNOWN - Unknown order * H5_ITER_INC - Increasing order * H5_ITER_DEC - Decreasing order * H5_ITER_NATIVE - No particular order, whatever is fastest * H5_ITER_N - Number of iteration orders * - * n - Attribute’s position in index - * attr_id - Attribute identifier - * size - Buffer size ! *TEST* check for 0 value *CHECK* should this return the correct value + * n - Attribute’s position in index + * attr_id - Attribute identifier + * size - Buffer size ! *TEST* check for 0 value *CHECK* should this return the correct value * - * lapl_id - Link access property list - * hdferr - Error code: - * Returns attribute name size, -1 if fail + * lapl_id - Link access property list + * hdferr - Error code: + * Returns attribute name size, -1 if fail * * OUTPUTS - * name - Attribute name + * name - Attribute name * * RETURNS - * Size of buffer on success, -1 on failure + * Size of buffer on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * January, 2008 + * January, 2008 * HISTORY * N/A * SOURCE @@ -677,36 +677,36 @@ done: /****if* H5Af/h5aopen_by_idx_c * NAME - * h5aopen_by_idx_c + * h5aopen_by_idx_c * PURPOSE - * Call H5Aopen_by_idx + * Call H5Aopen_by_idx * INPUTS - * loc_id - Object identifier - * obj_name - Name of object to which attribute is attached - * obj_namelen - name length - * idx_type - Type of index; Possible values are: + * loc_id - Object identifier + * obj_name - Name of object to which attribute is attached + * obj_namelen - name length + * idx_type - Type of index; Possible values are: * H5_INDEX_UNKNOWN - Unknown index type * H5_INDEX_NAME - Index on names * H5_INDEX_CRT_ORDER - Index on creation order * H5_INDEX_N - Number of indices defined * - * order - Order in which to iterate over index; Possible values are: + * order - Order in which to iterate over index; Possible values are: * H5_ITER_UNKNOWN - Unknown order * H5_ITER_INC - Increasing order * H5_ITER_DEC - Decreasing order * H5_ITER_NATIVE - No particular order, whatever is fastest * H5_ITER_N - Number of iteration orders * - * n - Attribute’s position in index - * aapl_id - Attribute access property list - * lapl_id - Link access property list + * n - Attribute’s position in index + * aapl_id - Attribute access property list + * lapl_id - Link access property list * OUTPUTS - * attr_id - attribute identifer + * attr_id - attribute identifer * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * January, 2008 + * January, 2008 * HISTORY * N/A * SOURCE @@ -740,23 +740,23 @@ done: /****if* H5Af/h5aget_info_c * NAME - * h5aget_info_c + * h5aget_info_c * PURPOSE - * Call H5Aget_info + * Call H5Aget_info * INPUTS - * loc_id - Object identifier + * loc_id - Object identifier * OUTPUTS * - * corder_valid - Indicates whether the the creation order data is valid for this attribute - * corder - Is a positive integer containing the creation order of the attribute - * cset - Indicates the character set used for the attribute’s name - * data_size - indicates the size, in the number of characters, of the attribute + * corder_valid - Indicates whether the the creation order data is valid for this attribute + * corder - Is a positive integer containing the creation order of the attribute + * cset - Indicates the character set used for the attribute’s name + * data_size - indicates the size, in the number of characters, of the attribute * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * January, 2008 + * January, 2008 * HISTORY * N/A * SOURCE @@ -792,40 +792,40 @@ done: /****if* H5Af/h5aget_info_by_idx_c * NAME - * h5aget_info_by_idx_c + * h5aget_info_by_idx_c * PURPOSE - * Call H5Aget_info_by_idx + * Call H5Aget_info_by_idx * INPUTS - * loc_id - Object identifier - * obj_name - Name of object to which attribute is attached - * obj_namelen - name length - * idx_type - Type of index; Possible values are: + * loc_id - Object identifier + * obj_name - Name of object to which attribute is attached + * obj_namelen - name length + * idx_type - Type of index; Possible values are: * H5_INDEX_UNKNOWN - Unknown index type * H5_INDEX_NAME - Index on names * H5_INDEX_CRT_ORDER - Index on creation order * H5_INDEX_N - Number of indices defined * - * order - Order in which to iterate over index; Possible values are: + * order - Order in which to iterate over index; Possible values are: * H5_ITER_UNKNOWN - Unknown order * H5_ITER_INC - Increasing order * H5_ITER_DEC - Decreasing order * H5_ITER_NATIVE - No particular order, whatever is fastest * H5_ITER_N - Number of iteration orders * - * n - Attribute’s position in index - * lapl_id - Link access property list + * n - Attribute’s position in index + * lapl_id - Link access property list * OUTPUTS * - * corder_valid - Indicates whether the the creation order data is valid for this attribute - * corder - Is a positive integer containing the creation order of the attribute - * cset - Indicates the character set used for the attribute’s name - * data_size - indicates the size, in the number of characters, of the attribute + * corder_valid - Indicates whether the the creation order data is valid for this attribute + * corder - Is a positive integer containing the creation order of the attribute + * cset - Indicates the character set used for the attribute’s name + * data_size - indicates the size, in the number of characters, of the attribute * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * January, 2008 + * January, 2008 * HISTORY * N/A * SOURCE @@ -871,28 +871,28 @@ done: /****if* H5Af/h5aget_info_by_name_c * NAME - * h5aget_info_by_name_c + * h5aget_info_by_name_c * PURPOSE - * Call H5Aget_info_by_name + * Call H5Aget_info_by_name * INPUTS - * loc_id - Object identifier - * obj_name - Name of object to which attribute is attached - * obj_namelen - name length - * attr_name - Attribute name - * attr_namelen - attribute name length - * lapl_id - Link access property list + * loc_id - Object identifier + * obj_name - Name of object to which attribute is attached + * obj_namelen - name length + * attr_name - Attribute name + * attr_namelen - attribute name length + * lapl_id - Link access property list * OUTPUTS * - * corder_valid - Indicates whether the the creation order data is valid for this attribute - * corder - Is a positive integer containing the creation order of the attribute - * cset - Indicates the character set used for the attribute’s name - * data_size - indicates the size, in the number of characters, of the attribute + * corder_valid - Indicates whether the the creation order data is valid for this attribute + * corder - Is a positive integer containing the creation order of the attribute + * cset - Indicates the character set used for the attribute’s name + * data_size - indicates the size, in the number of characters, of the attribute * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * January, 2008 + * January, 2008 * HISTORY * N/A * SOURCE @@ -942,32 +942,32 @@ done: /****if* H5Af/h5acreate_by_name_c * NAME - * h5acreate_by_name_c + * h5acreate_by_name_c * PURPOSE - * Call h5acreate_by_name + * Call h5acreate_by_name * INPUTS * - * loc_id - Object identifier - * obj_name - Name of object to which attribute is attached - * obj_namelen - name length - * attr_name - Attribute name - * attr_namelen - attribute name length - * type_id - Attribute datatype identifier - * space_id - Attribute dataspace identifier - * acpl_id - Attribute creation property list identifier (Currently not used.) - * aapl_id - Attribute access property list identifier (Currently not used.) - * lapl_id - Link access property list + * loc_id - Object identifier + * obj_name - Name of object to which attribute is attached + * obj_namelen - name length + * attr_name - Attribute name + * attr_namelen - attribute name length + * type_id - Attribute datatype identifier + * space_id - Attribute dataspace identifier + * acpl_id - Attribute creation property list identifier (Currently not used.) + * aapl_id - Attribute access property list identifier (Currently not used.) + * lapl_id - Link access property list * * OUTPUTS * - * attr - an attribute identifier + * attr - an attribute identifier * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * February, 2008 + * February, 2008 * HISTORY * N/A * SOURCE @@ -1008,21 +1008,21 @@ done: /****if* H5Af/h5aexists_c * NAME - * h5aexists_c + * h5aexists_c * PURPOSE * CAll h5aexists * INPUTS * - * obj_id - Object identifier - * attr_name - Attribute name + * obj_id - Object identifier + * attr_name - Attribute name * OUTPUTS * - * attr_exists_c - returns a positive value, for TRUE, or 0 (zero), for FALSE. + * attr_exists_c - returns a positive value, for TRUE, or 0 (zero), for FALSE. * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * February, 2008 + * February, 2008 * HISTORY * * SOURCE @@ -1054,23 +1054,23 @@ done: /****if* H5Af/h5aexists_by_name_c * NAME - * h5aexists_by_name_c + * h5aexists_by_name_c * PURPOSE * CAll H5Aexists_by_name * INPUTS * - * loc_id - Location identifier - * obj_name - Object name either relative to loc_id, absolute from the file’s root group, or '.' (a dot) + * loc_id - Location identifier + * obj_name - Object name either relative to loc_id, absolute from the file’s root group, or '.' (a dot) * attr_name - Attribute name - * lapl_id - Link access property list identifier + * lapl_id - Link access property list identifier * OUTPUTS * - * attr_exists_c - returns a positive value, for TRUE, or 0 (zero), for FALSE. + * attr_exists_c - returns a positive value, for TRUE, or 0 (zero), for FALSE. * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * February, 2008 + * February, 2008 * HISTORY * * SOURCE @@ -1108,24 +1108,24 @@ done: /****if* H5Af/h5aopen_by_name_c * NAME - * h5aopen_by_name_c + * h5aopen_by_name_c * PURPOSE - * Call H5Aopen_by_name + * Call H5Aopen_by_name * INPUTS * - * loc_id - Location identifier - * obj_name - Object name either relative to loc_id, absolute from the file’s root group, or '.' (a dot) + * loc_id - Location identifier + * obj_name - Object name either relative to loc_id, absolute from the file’s root group, or '.' (a dot) * attr_name - Attribute name - * aapl_id - Attribute access property list (Currently unused; should be passed in as H5P_DEFAULT.) - * lapl_id - Link access property list identifier + * aapl_id - Attribute access property list (Currently unused; should be passed in as H5P_DEFAULT.) + * lapl_id - Link access property list identifier * OUTPUTS * - * attr_id - attribute identifier + * attr_id - attribute identifier * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * February, 2008 + * February, 2008 * HISTORY * * SOURCE @@ -1163,22 +1163,22 @@ h5aopen_by_name_c (hid_t_f *loc_id, _fcd obj_name, size_t_f *obj_namelen, _fcd a /****if* H5Af/h5arename_c * NAME - * h5arename_c + * h5arename_c * PURPOSE - * Calls H5Arename + * Calls H5Arename * INPUTS - * loc_id - Object identifier - * old_attr_name - Prior attribute name - * old_attr_name_len - Prior attribute name length - * new_attr_name - New attribute name - * new_attr_name_len - New attribute name length + * loc_id - Object identifier + * old_attr_name - Prior attribute name + * old_attr_name_len - Prior attribute name length + * new_attr_name - New attribute name + * new_attr_name_len - New attribute name length * OUTPUTS * N/A * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * January, 2008 + * January, 2008 * HISTORY * N/A * SOURCE diff --git a/fortran/src/H5Df.c b/fortran/src/H5Df.c index 050d7e0..57b4d4d 100644 --- a/fortran/src/H5Df.c +++ b/fortran/src/H5Df.c @@ -1,6 +1,6 @@ /****h* H5Df/H5Df * PURPOSE - * This file contains C stubs for H5D Fortran APIs + * This file contains C stubs for H5D Fortran APIs * * COPYRIGHT * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * @@ -84,19 +84,19 @@ DONE: * PURPOSE * Call H5Dopen2 to open a dataset * INPUTS - * loc_id - file or group identifier - * name - name of the dataset - * namelen - name length - * dapl_id - Dataset access property list + * loc_id - file or group identifier + * name - name of the dataset + * namelen - name length + * dapl_id - Dataset access property list * OUTPUTS - * dset_id - dataset identifier + * dset_id - dataset identifier * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, August 4, 1999 + * Wednesday, August 4, 1999 * HISTORY - * Added 1.8 parameter: dapl_id + * Added 1.8 parameter: dapl_id * SOURCE */ int_f @@ -204,21 +204,21 @@ h5dwrite_ref_reg_c (hid_t_f *dset_id, hid_t_f *mem_type_id, hid_t_f *mem_space_i * PURPOSE * Call H5Dread to read a dataset of dataset region references * INPUTS - * dset_id - dataset identifier - * mem_type_id - memory datatype identifier - * mem_space_id - memory dataspace identifier - * file_space_id - memory dataspace identifier - * xfer_pr - identifier of transfer property list - * buf - data buffer to store references to the objects. - * n - number of references to be stored. + * dset_id - dataset identifier + * mem_type_id - memory datatype identifier + * mem_space_id - memory dataspace identifier + * file_space_id - memory dataspace identifier + * xfer_pr - identifier of transfer property list + * buf - data buffer to store references to the objects. + * n - number of references to be stored. * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, May 15, 2002 + * Wednesday, May 15, 2002 * HISTORY - * This function was added to accomodate h5dread_f subroutine - * with the dims parameter being of INTEGER(HSIZE_T_F) size. + * This function was added to accomodate h5dread_f subroutine + * with the dims parameter being of INTEGER(HSIZE_T_F) size. * SOURCE */ int_f @@ -274,12 +274,12 @@ h5dread_ref_reg_c (hid_t_f *dset_id, hid_t_f *mem_type_id, hid_t_f *mem_space_id * PURPOSE * Call H5Dclose to close a dataset * INPUTS - * dset_id - identifier of the dataset to be closed + * dset_id - identifier of the dataset to be closed * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, August 4, 1999 + * Wednesday, August 4, 1999 * HISTORY * * SOURCE @@ -302,14 +302,14 @@ h5dclose_c ( hid_t_f *dset_id ) * PURPOSE * Call H5Dget_space to obtain dataspace of a dataset * INPUTS - * dset_id - identifier of the dataset + * dset_id - identifier of the dataset * OUTPUTS - * space_id - identifier of the dataset's dataspace + * space_id - identifier of the dataset's dataspace * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Thursday, August 19, 1999 + * Thursday, August 19, 1999 * HISTORY * * SOURCE @@ -337,14 +337,14 @@ h5dget_space_c ( hid_t_f *dset_id , hid_t_f *space_id) * PURPOSE * Call H5Dget_type to obtain datatype of a dataset * INPUTS - * dset_id - identifier of the dataset + * dset_id - identifier of the dataset * OUTPUTS - * type_id - identifier of the dataset's datatype + * type_id - identifier of the dataset's datatype * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Thursday, August 19, 1999 + * Thursday, August 19, 1999 * HISTORY * * SOURCE @@ -373,16 +373,16 @@ h5dget_type_c ( hid_t_f *dset_id , hid_t_f *type_id) * h5dget_create_plist_c * PURPOSE * Call H5Dget_create_plist to obtain creation property list - * of a dataset + * of a dataset * INPUTS - * dset_id - identifier of the dataset + * dset_id - identifier of the dataset * OUTPUTS - * plist_id - identifier of he dataset creation property list + * plist_id - identifier of he dataset creation property list * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Thursday, August 19, 1999 + * Thursday, August 19, 1999 * HISTORY * * SOURCE @@ -413,18 +413,18 @@ h5dget_create_plist_c ( hid_t_f *dset_id , hid_t_f *plist_id) * PURPOSE * Call H5Dset_extent to extend dataset with unlimited dimensions * INPUTS - * dset_id - identifier of the dataset + * dset_id - identifier of the dataset * OUTPUTS - * dims - array with the dimension sizes + * dims - array with the dimension sizes * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Thursday, August 19, 1999 + * Thursday, August 19, 1999 * * HISTORY - * Changed name from the now obsolete h5dextend - * to h5dset_extent in order to match new fortran interface. + * Changed name from the now obsolete h5dextend + * to h5dset_extent in order to match new fortran interface. * -MSB- March 14, 2008 * SOURCE */ @@ -465,16 +465,16 @@ h5dset_extent_c ( hid_t_f *dset_id , hsize_t_f *dims) * h5dget_storage_size_c * PURPOSE * Call H5Dget_storage_size to return the amount of storage - * required for a dataset + * required for a dataset * INPUTS - * dset_id - identifier of the dataset + * dset_id - identifier of the dataset * OUTPUTS - * size - the amount of storage required for a dataset + * size - the amount of storage required for a dataset * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Tuesday, October 22, 2002 + * Tuesday, October 22, 2002 * HISTORY * * SOURCE @@ -502,16 +502,16 @@ h5dget_storage_size_c ( hid_t_f *dset_id , hsize_t_f *size) * PURPOSE * Get the maximum size of the VL dataset element * INPUTS - * dset_id - identifier of the dataset - * type_id - datatype identifier - * space_id - dataspace identifier + * dset_id - identifier of the dataset + * type_id - datatype identifier + * space_id - dataspace identifier * OUTPUTS - * len - maximum length of the VL dataset element + * len - maximum length of the VL dataset element * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Tuesday, October 22, 2002 + * Tuesday, October 22, 2002 * HISTORY * * SOURCE @@ -560,21 +560,21 @@ DONE: * PURPOSE * Write variable length dataset * INPUTS - * dset_id - identifier of the dataset - * mem_type_id - datatype identifier - * mem_space_id - dataspace identifier - * file_space_id - file dataspace identifier - * xfer - file transfer property - * buf - data buffer - * dims - one-demnsional array of size 2 - * dims[0] = MAXLENGTH - * dims[1] = number of elements of VL type - * len - array element lenghts + * dset_id - identifier of the dataset + * mem_type_id - datatype identifier + * mem_space_id - dataspace identifier + * file_space_id - file dataspace identifier + * xfer - file transfer property + * buf - data buffer + * dims - one-demnsional array of size 2 + * dims[0] = MAXLENGTH + * dims[1] = number of elements of VL type + * len - array element lenghts * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, October 23, 2002 + * Wednesday, October 23, 2002 * HISTORY * * SOURCE @@ -633,22 +633,22 @@ DONE: * PURPOSE * Read variable length dataset * INPUTS - * dset_id - identifier of the dataset - * mem_type_id - datatype identifier - * mem_space_id - dataspace identifier - * file_space_id - file dataspace identifier - * xfer - file transfer property - * dims - one-demnsional array of size 2 - * dims[0] = MAXLENGTH - * dims[1] = number of elements of VL type + * dset_id - identifier of the dataset + * mem_type_id - datatype identifier + * mem_space_id - dataspace identifier + * file_space_id - file dataspace identifier + * xfer - file transfer property + * dims - one-demnsional array of size 2 + * dims[0] = MAXLENGTH + * dims[1] = number of elements of VL type * OUTPUTS - * buf - data buffer - * len - array element lenghts + * buf - data buffer + * len - array element lenghts * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, October 24, 2002 + * Wednesday, October 24, 2002 * HISTORY * * SOURCE @@ -705,20 +705,20 @@ DONE: * PURPOSE * Write variable length strings from Fortran program * INPUTS - * dset_id - identifier of the dataset - * mem_type_id - datatype identifier - * mem_space_id - dataspace identifier - * file_space_id - file dataspace identifier - * xfer - file transfer property - * buf - data buffer - * dims - one-demnsional array of size 2 - * dims[0] = number of strings of size max_len - * len - array of strings lengths + * dset_id - identifier of the dataset + * mem_type_id - datatype identifier + * mem_space_id - dataspace identifier + * file_space_id - file dataspace identifier + * xfer - file transfer property + * buf - data buffer + * dims - one-demnsional array of size 2 + * dims[0] = number of strings of size max_len + * len - array of strings lengths * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Monday, October 28, 2002 + * Monday, October 28, 2002 * HISTORY * * SOURCE @@ -792,20 +792,20 @@ DONE: * PURPOSE * Read variable length strings from Fortran program * INPUTS - * dset_id - identifier of the dataset - * mem_type_id - datatype identifier - * mem_space_id - dataspace identifier - * file_space_id - file dataspace identifier - * xfer - file transfer property - * dims - one-demnsional array of size 2 - * dims[0] = number of strings of size max_len - * Output: buf - data buffer - * len - array of strings lengths + * dset_id - identifier of the dataset + * mem_type_id - datatype identifier + * mem_space_id - dataspace identifier + * file_space_id - file dataspace identifier + * xfer - file transfer property + * dims - one-demnsional array of size 2 + * dims[0] = number of strings of size max_len + * Output: buf - data buffer + * len - array of strings lengths * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Friday, November 1, 2002 + * Friday, November 1, 2002 * HISTORY * * SOURCE @@ -875,21 +875,21 @@ h5dread_vl_string_c( hid_t_f *dset_id , hid_t_f *mem_type_id, hid_t_f *mem_spac * PURPOSE * Write variable length dataset * INPUTS - * dset_id - identifier of the dataset - * mem_type_id - datatype identifier - * mem_space_id - dataspace identifier - * file_space_id - file dataspace identifier - * xfer - file transfer property - * buf - data buffer - * dims - one-demnsional array of size 2 - * dims[0] = MAXLENGTH - * dims[1] = number of elements of VL type - * len - array element lenghts + * dset_id - identifier of the dataset + * mem_type_id - datatype identifier + * mem_space_id - dataspace identifier + * file_space_id - file dataspace identifier + * xfer - file transfer property + * buf - data buffer + * dims - one-demnsional array of size 2 + * dims[0] = MAXLENGTH + * dims[1] = number of elements of VL type + * len - array element lenghts * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Monday, November 11, 2002 + * Monday, November 11, 2002 * HISTORY * * SOURCE @@ -948,22 +948,22 @@ DONE: * PURPOSE * Read variable length dataset * INPUTS - * dset_id - identifier of the dataset - * mem_type_id - datatype identifier - * mem_space_id - dataspace identifier - * file_space_id - file dataspace identifier - * xfer - file transfer property - * dims - one-demnsional array of size 2 - * dims[0] = MAXLENGTH - * dims[1] = number of elements of VL type + * dset_id - identifier of the dataset + * mem_type_id - datatype identifier + * mem_space_id - dataspace identifier + * file_space_id - file dataspace identifier + * xfer - file transfer property + * dims - one-demnsional array of size 2 + * dims[0] = MAXLENGTH + * dims[1] = number of elements of VL type * OUTPUTS - * buf - data buffer - * len - array element lenghts + * buf - data buffer + * len - array element lenghts * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Monday, November 11, 2002 + * Monday, November 11, 2002 * HISTORY * * SOURCE @@ -1065,14 +1065,14 @@ h5dfill_c (void * fill_value, hid_t_f *fill_type_id, hid_t_f *space_id, void * b * PURPOSE * Call H5Dget_space_status to request dataspace allocation status * INPUTS - * dset_id - dataset identifier + * dset_id - dataset identifier * OUTPUTS - * flag - status flag + * flag - status flag * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, March 12, 2003 + * Wednesday, March 12, 2003 * HISTORY * * SOURCE @@ -1108,17 +1108,17 @@ h5dget_space_status_c ( hid_t_f *dset_id, int_f *flag) * loc_id - Identifier of the file or group within which to create the dataset. * type_id - Identifier of the datatype to use when creating the dataset. * space_id - Identifier of the dataspace to use when creating the dataset. - * dcpl_id - Dataset creation property list identifier. - * dapl_id - Dataset access property list identifier. + * dcpl_id - Dataset creation property list identifier. + * dapl_id - Dataset access property list identifier. * OUTPUTS * - * dset_id - dataset identifier + * dset_id - dataset identifier * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * February, 2008 + * February, 2008 * SOURCE */ int_f @@ -1207,8 +1207,8 @@ h5dwrite_f_c (hid_t_f *dset_id, hid_t_f *mem_type_id, hid_t_f *mem_space_id, * file_space_id - file dataspace identifier * xfer - file transfer property * dims - one-demnsional array of size 2 - * dims[0] = MAXLENGTH - * dims[1] = number of elements of VL type + * dims[0] = MAXLENGTH + * dims[1] = number of elements of VL type * OUTPUTS * buf - data buffer * len - array element lenghts @@ -1288,16 +1288,16 @@ h5dget_access_plist_c (hid_t_f *dset_id, hid_t_f *plist_id) * PURPOSE * Call H5Dvlen_reclaim * INPUTS - * type_id - Identifier of the datatype. - * space_id - Identifier of the dataspace. - * plist_id - Identifier of the property list used to create the buffer. - * buf - Pointer to the buffer to be reclaimed. + * type_id - Identifier of the datatype. + * space_id - Identifier of the dataspace. + * plist_id - Identifier of the property list used to create the buffer. + * buf - Pointer to the buffer to be reclaimed. * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * January 15, 2011 + * January 15, 2011 * * SOURCE */ diff --git a/fortran/src/H5Ef.c b/fortran/src/H5Ef.c index 4cba955..bba0157 100644 --- a/fortran/src/H5Ef.c +++ b/fortran/src/H5Ef.c @@ -1,6 +1,6 @@ /****h* H5Ef/H5Ef * PURPOSE - * This file contains C stubs for H5E Fortran APIs + * This file contains C stubs for H5E Fortran APIs * * COPYRIGHT * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * @@ -274,19 +274,19 @@ done: /****if* H5Ef/h5eset_auto2_c * NAME - * h5eset_auto2_c + * h5eset_auto2_c * PURPOSE - * Calls H5Eset_auto2 + * Calls H5Eset_auto2 * INPUTS - * estack_id - Error stack identifier. - * func - Function to be called upon an error condition. - * client_data - Data passed to the error function. + * estack_id - Error stack identifier. + * func - Function to be called upon an error condition. + * client_data - Data passed to the error function. * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * July 22, 2009 + * July 22, 2009 * SOURCE */ /* int_f */ diff --git a/fortran/src/H5Ff.c b/fortran/src/H5Ff.c index 1de2164..c1cdb91 100644 --- a/fortran/src/H5Ff.c +++ b/fortran/src/H5Ff.c @@ -1,6 +1,6 @@ /****h* H5Ff/H5Ff * PURPOSE - * This file contains C stubs for H5F Fortran APIs + * This file contains C stubs for H5F Fortran APIs * * COPYRIGHT * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * @@ -26,22 +26,22 @@ /****if* H5Ff/h5fcreate_c * NAME - * h5fcreate_c + * h5fcreate_c * PURPOSE - * Call H5Fcreate to create the file + * Call H5Fcreate to create the file * INPUTS - * name - name of the file - * namelen - name length - * access_flags - file access flags - * crt_pr - identifier of creation property list - * acc_prp - identifier of access property list + * name - name of the file + * namelen - name length + * access_flags - file access flags + * crt_pr - identifier of creation property list + * acc_prp - identifier of access property list * OUTPUTS - * file_id - file identifier + * file_id - file identifier * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Monday, July 26, 1999 + * Monday, July 26, 1999 * SOURCE */ int_f @@ -95,19 +95,19 @@ h5fcreate_c(_fcd name, int_f *namelen, int_f *access_flags, hid_t_f* crt_prp, hi /****if* H5Ff/h5fflush_c * NAME - * h5fflush_c + * h5fflush_c * PURPOSE - * Call H5Fflush to flush the object + * Call H5Fflush to flush the object * INPUTS - * object_id - identifier of either a file, a dataset, - * a group, an attribute or a named data type - * scope - integer to specify the flushing action, either + * object_id - identifier of either a file, a dataset, + * a group, an attribute or a named data type + * scope - integer to specify the flushing action, either * H5F_SCOPE_GLOBAL or H5F_SCOPE_LOCAL * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Friday, November 5, 1999 + * Friday, November 5, 1999 * SOURCE */ int_f @@ -136,20 +136,20 @@ h5fflush_c (hid_t_f *object_id, int_f *scope) /****if* H5Ff/h5fmount_c * NAME - * h5fmount_c + * h5fmount_c * PURPOSE - * Call H5Fmount to mount the file + * Call H5Fmount to mount the file * INPUTS - * loc_id - Identifier for file or group - * dsetname - name of dataset - * namelen - dsetname length - * file_id - file identifier for the file to be mounted - * acc_prp - identifier of access property list + * loc_id - Identifier for file or group + * dsetname - name of dataset + * namelen - dsetname length + * file_id - file identifier for the file to be mounted + * acc_prp - identifier of access property list * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Monday, October 25, 1999 + * Monday, October 25, 1999 * HISTORY */ int_f @@ -194,18 +194,18 @@ h5fmount_c (hid_t_f *loc_id, _fcd dsetname, int_f *namelen, hid_t_f *file_id, hi /****if* H5Ff/h5funmount_c * NAME - * h5funmount_c + * h5funmount_c * PURPOSE - * Call H5Funmount to unmount the file + * Call H5Funmount to unmount the file * INPUTS - * loc_id - Identifier for file or group - * dsetname - name of dataset - * namelen - dsetname length + * loc_id - Identifier for file or group + * dsetname - name of dataset + * namelen - dsetname length * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Monday, October 25, 1999 + * Monday, October 25, 1999 * SOURCE */ int_f @@ -242,21 +242,21 @@ h5funmount_c (hid_t_f *loc_id, _fcd dsetname, int_f *namelen) /****if* H5Ff/h5fopen_c * NAME - * h5fopen_c + * h5fopen_c * PURPOSE - * Call H5Fopen to open the file + * Call H5Fopen to open the file * INPUTS - * name - name of the file - * namelen - name length - * access_flags - file access flags - * acc_prp - identifier of access property list + * name - name of the file + * namelen - name length + * access_flags - file access flags + * acc_prp - identifier of access property list * OUTPUTS - * file_id - file identifier + * file_id - file identifier * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Tuesday, August 3, 1999 + * Tuesday, August 3, 1999 * SOURCE */ int_f @@ -305,18 +305,18 @@ h5fopen_c (_fcd name, int_f *namelen, int_f *access_flags, hid_t_f *acc_prp, hid /****if* H5Ff/h5freopen_c * NAME - * h5freopen_c + * h5freopen_c * PURPOSE - * Call H5Freopen to open the file + * Call H5Freopen to open the file * INPUTS - * file_id1 - file identifier + * file_id1 - file identifier * OUTPUTS - * file_id2 - file identifier + * file_id2 - file identifier * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Wednesday, November 3, 1999 + * Wednesday, November 3, 1999 * SOURCE */ int_f @@ -338,18 +338,18 @@ h5freopen_c (hid_t_f *file_id1, hid_t_f *file_id2) /****if* H5Ff/h5fget_create_plist_c * NAME - * h5fget_create_plist_c + * h5fget_create_plist_c * PURPOSE - * Call H5Fget_create_plist to get the file creation property list + * Call H5Fget_create_plist to get the file creation property list * INPUTS - * file_id - file identifier + * file_id - file identifier * OUTPUTS - * prop_id - creation property list identifier + * prop_id - creation property list identifier * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal, Xiangyang Su - * Wednesday, November 3, 1999 + * Wednesday, November 3, 1999 * SOURCE */ int_f @@ -371,18 +371,18 @@ h5fget_create_plist_c (hid_t_f *file_id, hid_t_f *prop_id) /****if* H5Ff/h5fget_access_plist_c * NAME - * h5fget_access_plist_c + * h5fget_access_plist_c * PURPOSE - * Call H5Fget_access_plist to get the file access property list + * Call H5Fget_access_plist to get the file access property list * INPUTS - * file_id - file identifier + * file_id - file identifier * OUTPUTS - * access_id - access property list identifier + * access_id - access property list identifier * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Monday, September 30, 2002 + * Monday, September 30, 2002 * HISTORY * * SOURCE @@ -406,20 +406,20 @@ h5fget_access_plist_c (hid_t_f *file_id, hid_t_f *access_id) /****if* H5Ff/h5fis_hdf5_c * NAME - * h5fis_hdf5_c + * h5fis_hdf5_c * PURPOSE - * Call H5Fis_hdf5 to determone if the file is an HDF5 file + * Call H5Fis_hdf5 to determone if the file is an HDF5 file * INPUTS - * name - name of the file - * namelen - name length + * name - name of the file + * namelen - name length * OUTPUTS - * flag - 0 if file is not HDF5 file , positive if a file - * is an HDF5 file, and negative on failure. + * flag - 0 if file is not HDF5 file , positive if a file + * is an HDF5 file, and negative on failure. * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Tuesday, August 3, 1999 + * Tuesday, August 3, 1999 * HISTORY * * SOURCE @@ -452,16 +452,16 @@ h5fis_hdf5_c (_fcd name, int_f *namelen, int_f *flag) } /****if* H5Ff/h5fclose_c * NAME - * h5fclose_c + * h5fclose_c * PURPOSE - * Call H5Fclose to close the file + * Call H5Fclose to close the file * INPUTS - * file_id - identifier of the file to be closed + * file_id - identifier of the file to be closed * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Monday, July 26, 1999 + * Monday, July 26, 1999 * HISTORY * * SOURCE @@ -480,22 +480,22 @@ h5fclose_c ( hid_t_f *file_id ) } /****if* H5Ff/h5fget_obj_count_c * NAME - * h5fget_obj_count_c + * h5fget_obj_count_c * PURPOSE - * Call H5Fget_obj_count to get number of open objects within a file + * Call H5Fget_obj_count to get number of open objects within a file * INPUTS - * file_id - identifier of the file to be closed - * obj_type - type of the object + * file_id - identifier of the file to be closed + * obj_type - type of the object * RETURNS - * obj_count - number of objects - * 0 on success, -1 on failure + * obj_count - number of objects + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Monday, September 30, 2002 + * Monday, September 30, 2002 * HISTORY * - * Changed type of obj_count to size_t_f - * Thursday, September 25, 2008 + * Changed type of obj_count to size_t_f + * Thursday, September 25, 2008 * SOURCE */ @@ -525,7 +525,7 @@ h5fget_obj_count_c ( hid_t_f *file_id , int_f *obj_type, size_t_f * obj_count) * obj_type - type of the object * RETURNS * obj_ids - iarray of open objects identifiers - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal * Monday, September 30, 2002 @@ -569,17 +569,17 @@ h5fget_obj_ids_c ( hid_t_f *file_id , int_f *obj_type, size_t_f *max_objs, /****if* H5Ff/h5fget_freespace_c * NAME - * h5fget_freespace_c + * h5fget_freespace_c * PURPOSE - * Call H5Fget_freespace to get amount of free space within a file + * Call H5Fget_freespace to get amount of free space within a file * INPUTS - * file_id - identifier of the file to query + * file_id - identifier of the file to query * RETURNS - * free_space - amount of free space in file - * 0 on success, -1 on failure + * free_space - amount of free space in file + * 0 on success, -1 on failure * AUTHOR * Quincey Koziol - * Tuesday, October 7, 2003 + * Tuesday, October 7, 2003 * SOURCE */ @@ -599,20 +599,20 @@ h5fget_freespace_c ( hid_t_f *file_id , hssize_t_f *free_space) /****if* H5Ff/h5fget_name_c * NAME - * h5fget_name_c + * h5fget_name_c * PURPOSE - * Call H5Fget_name to get file's name + * Call H5Fget_name to get file's name * INPUTS - * obj_id - object identifier - * buflen -size of the buffer + * obj_id - object identifier + * buflen -size of the buffer * OUTPUTS - * buf - buffer to hold the name - * size - size of the file's name + * buf - buffer to hold the name + * size - size of the file's name * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Tuesday, July 6, 2004 + * Tuesday, July 6, 2004 * SOURCE */ int_f @@ -648,18 +648,18 @@ done: /****if* H5Ff/h5fget_filesize_c * NAME - * h5fget_filesize_c + * h5fget_filesize_c * PURPOSE - * Call H5Fget_filesize to get file size + * Call H5Fget_filesize to get file size * INPUTS - * file_id - file identifier + * file_id - file identifier * OUTPUTS - * size - size of the file + * size - size of the file * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, July 7, 2004 + * Wednesday, July 7, 2004 * SOURCE */ int_f diff --git a/fortran/src/H5Gf.c b/fortran/src/H5Gf.c index 1a6b41b..6d85b9a 100644 --- a/fortran/src/H5Gf.c +++ b/fortran/src/H5Gf.c @@ -1,6 +1,6 @@ /****h* H5Gf/H5Gf * PURPOSE - * This file contains C stubs for H5G Fortran APIs + * This file contains C stubs for H5G Fortran APIs * * COPYRIGHT * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * @@ -26,24 +26,24 @@ /****if* H5Gf/h5gcreate_c * NAME - * h5gcreate_c + * h5gcreate_c * PURPOSE - * Call H5Gcreate to create a group + * Call H5Gcreate to create a group * INPUTS - * loc_id - file or group identifier - * name - name of the group - * namelen - name length - * size_hint - length of names in the group + * loc_id - file or group identifier + * name - name of the group + * namelen - name length + * size_hint - length of names in the group * OUTPUTS - * grp_id - group identifier + * grp_id - group identifier * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, August 5, 1999 + * Wednesday, August 5, 1999 * HISTORY * - * Changed to call H5Gcreate2 because H5Gcreate flip-flops and + * Changed to call H5Gcreate2 because H5Gcreate flip-flops and * H5Gcreate1 can be compiled out of the library * QAK - 2007/08/23 * SOURCE @@ -98,21 +98,21 @@ DONE: /****if* H5Gf/h5gopen_c * NAME - * h5gopen_c + * h5gopen_c * PURPOSE - * Call H5Gopen to open a dataset + * Call H5Gopen to open a dataset * INPUTS - * loc_id - file or group identifier - * name - name of the group - * namelen - name length - * gapl_id - Group access property list identifier + * loc_id - file or group identifier + * name - name of the group + * namelen - name length + * gapl_id - Group access property list identifier * OUTPUTS - * grp_id - group identifier + * grp_id - group identifier * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, August 5, 1999 + * Wednesday, August 5, 1999 * * SOURCE */ @@ -148,24 +148,24 @@ DONE: /****if* H5Gf/h5gget_obj_info_idx_c * NAME - * h5gget_obj_info_idx_c + * h5gget_obj_info_idx_c * PURPOSE - * Call H5Gget_obj_info to return name and the type of group - * member + * Call H5Gget_obj_info to return name and the type of group + * member * INPUTS - * loc_id - file or group identifier - * name - name of the group - * namelen - name length - * idx - index of the group member + * loc_id - file or group identifier + * name - name of the group + * namelen - name length + * idx - index of the group member * OUTPUTS - * obj_name - buffer to store member's name - * obj_namelen - length of the buffer - * obj_type - type of the object + * obj_name - buffer to store member's name + * obj_namelen - length of the buffer + * obj_type - type of the object * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, August 5, 1999 + * Wednesday, August 5, 1999 * SOURCE */ int_f @@ -207,7 +207,7 @@ h5gget_obj_info_idx_c(hid_t_f *loc_id, _fcd name, int_f *namelen, int_f *idx, goto DONE; /* XXX: Switch from using H5Gget_objtype_by_idx() means that this routine won't - * work on non-hard links - QAK + * work on non-hard links - QAK */ *obj_type = oinfo.type; @@ -231,20 +231,20 @@ DONE: /****if* H5Gf/h5gn_members_c * NAME - * h5gn_members_c + * h5gn_members_c * PURPOSE - * Call H5Gget_info_by_name to find number of objects in the group + * Call H5Gget_info_by_name to find number of objects in the group * INPUTS - * loc_id - file or group identifier - * name - name of the group - * namelen - name length + * loc_id - file or group identifier + * name - name of the group + * namelen - name length * OUTPUTS - * nmemebers - number of members + * nmemebers - number of members * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, August 5, 1999 + * Wednesday, August 5, 1999 * SOURCE */ int_f @@ -276,16 +276,16 @@ DONE: /****if* H5Gf/h5gclose_c * NAME - * h5gclose_c + * h5gclose_c * PURPOSE - * Call H5Gclose to close the group + * Call H5Gclose to close the group * INPUTS - * grp_id - identifier of the group to be closed + * grp_id - identifier of the group to be closed * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, August 5, 1999 + * Wednesday, August 5, 1999 * SOURCE */ @@ -303,19 +303,19 @@ h5gclose_c(hid_t_f *grp_id) /****if* H5Gf/h5glink_c * NAME - * h5glink_c + * h5glink_c * PURPOSE - * Call H5Glink to link the specified type + * Call H5Glink to link the specified type * INPUTS - * loc_id - identifier of file or group - * link_type - link type - * current_name - name of the existing object for hard link, - * anything for the soft link - * current_namelen - current name lenghth - * new_name - new name for the object - * new_namelen - new_name lenghth + * loc_id - identifier of file or group + * link_type - link type + * current_name - name of the existing object for hard link, + * anything for the soft link + * current_namelen - current name lenghth + * new_name - new name for the object + * new_namelen - new_name lenghth * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Mingshi Chen * Friday, August 6, 1999 @@ -385,25 +385,25 @@ DONE: /****if* H5Gf/h5glink2_c * NAME - * h5glink2_c + * h5glink2_c * PURPOSE - * Call H5Glink2 to link the specified type + * Call H5Glink2 to link the specified type * INPUTS - * cur_loc_id - identifier of file or group - * cur_name - name of the existing object for hard link releative - * to cur_loc_id location, - * anything for the soft link - * current_namelen - current name lenghth - * link_type - link type - * new_loc_id - location identifier - * new_name - new name for the object releative to the new_loc_id - * location - * new_namelen - new_name lenghth + * cur_loc_id - identifier of file or group + * cur_name - name of the existing object for hard link releative + * to cur_loc_id location, + * anything for the soft link + * current_namelen - current name lenghth + * link_type - link type + * new_loc_id - location identifier + * new_name - new name for the object releative to the new_loc_id + * location + * new_namelen - new_name lenghth * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, September 25, 2002 + * Wednesday, September 25, 2002 * HISTORY * * SOURCE @@ -470,14 +470,14 @@ DONE: /****if* H5Gf/h5gunlink_c * NAME - * h5gunlink_c + * h5gunlink_c * PURPOSE - * Call H5Gunlink to remove the specified name + * Call H5Gunlink to remove the specified name * INPUTS - * loc_id - identifier of file or group - * name - name of the object to unlink + * loc_id - identifier of file or group + * name - name of the object to unlink * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Mingshi Chen * Friday, August 6, 1999 @@ -512,17 +512,17 @@ DONE: /****if* H5Gf/h5gmove_c * NAME - * h5gmove_c + * h5gmove_c * PURPOSE - * Call H5Gmove to rename an object within an HDF5 file + * Call H5Gmove to rename an object within an HDF5 file * INPUTS - * loc_id - identifier of file or group - * src_name - name of the original object - * src_namelen - original name lenghth - * dst_name - new name for the object - * dst_namelen - new name lenghth + * loc_id - identifier of file or group + * src_name - name of the original object + * src_namelen - original name lenghth + * dst_name - new name for the object + * dst_namelen - new name lenghth * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Mingshi Chen * Friday, August 6, 1999 @@ -562,18 +562,18 @@ DONE: /****if* H5Gf/h5gmove2_c * NAME - * h5gmove2_c + * h5gmove2_c * PURPOSE - * Call H5Gmove2 to rename an object within an HDF5 file + * Call H5Gmove2 to rename an object within an HDF5 file * INPUTS - * src_loc_id - identifier of file or group - * src_name - name of the original object relative to src_loc_id - * src_namelen - original name lenghth - * dst_loc_id - new location identifier - * dst_name - new name for the object relative to dst_loc_id - * dst_namelen - new name lenghth + * src_loc_id - identifier of file or group + * src_name - name of the original object relative to src_loc_id + * src_namelen - original name lenghth + * dst_loc_id - new location identifier + * dst_name - new name for the object relative to dst_loc_id + * dst_namelen - new name lenghth * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal * Wednesday, September 25, 2002 @@ -614,18 +614,18 @@ DONE: /****if* H5Gf/h5gget_linkval_c * NAME - * h5gget_linkval_c + * h5gget_linkval_c * PURPOSE - * Call H5Gget_linkval to return the name of object + * Call H5Gget_linkval to return the name of object * INPUTS - * loc_id - identifier of file or group - * name - name of the object that symbolic link points to - * namelen - the name lenghth - * size - lenghth of retrurned value + * loc_id - identifier of file or group + * name - name of the object that symbolic link points to + * namelen - the name lenghth + * size - lenghth of retrurned value * OUTPUTS - * value - name to be returned + * value - name to be returned * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Mingshi Chen * Friday, August 6, 1999 @@ -678,22 +678,22 @@ DONE: /****if* H5Gf/h5gset_comment_c * NAME - * h5gset_comment_c + * h5gset_comment_c * PURPOSE - * Call H5Oset_comment_by_name to set comments for the specified object + * Call H5Oset_comment_by_name to set comments for the specified object * INPUTS - * loc_id - identifier of file or group - * name - name of object whose comment is to be set or reset - * namelen - the name lenghth - * comment - the new comment - * commentlen - new comment lenghth + * loc_id - identifier of file or group + * name - name of object whose comment is to be set or reset + * namelen - the name lenghth + * comment - the new comment + * commentlen - new comment lenghth * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Mingshi Chen - * Friday, August 6, 1999 + * Friday, August 6, 1999 * HISTORY - * Elena Pourmal + * Elena Pourmal * SOURCE */ int_f @@ -729,20 +729,20 @@ DONE: /****if* H5Gf/h5gget_comment_c * NAME - * h5gget_comment_c + * h5gget_comment_c * PURPOSE - * Call H5Oget_comment_by_name to retrieve comments for the specified object + * Call H5Oget_comment_by_name to retrieve comments for the specified object * INPUTS - * loc_id - identifier of file or group - * name - name of object whose comment is to be set or reset - * namelen - the name lenghth - * bufsize - at most bufsize characters - * comment - the new comment + * loc_id - identifier of file or group + * name - name of object whose comment is to be set or reset + * namelen - the name lenghth + * bufsize - at most bufsize characters + * comment - the new comment * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Mingshi Chen - * Friday, August 6, 1999 + * Friday, August 6, 1999 * SOURCE */ int_f @@ -791,19 +791,19 @@ DONE: /****if* H5Gf/h5gcreate_anon_c * NAME - * h5gcreate_anon_c + * h5gcreate_anon_c * PURPOSE - * Call H5Gcreate_anon + * Call H5Gcreate_anon * INPUTS * - * loc_id - Location identifier - * gcpl_id - Group creation property list identifier - * gapl_id - Group access property list identifier + * loc_id - Location identifier + * gcpl_id - Group creation property list identifier + * gapl_id - Group access property list identifier * * OUTPUTS - * grp_id - group identifier + * grp_id - group identifier * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld * February 15, 2008 @@ -825,17 +825,17 @@ done: /****if* H5Gf/h5gget_create_plist_c * NAME - * h5gget_create_plist_c + * h5gget_create_plist_c * PURPOSE - * Call H5Gget_create_plist + * Call H5Gget_create_plist * INPUTS * - * grp_id - group identifier + * grp_id - group identifier * * OUTPUTS - * gcpl_id - Group creation property list identifier + * gcpl_id - Group creation property list identifier * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld * February 15, 2008 @@ -857,32 +857,32 @@ done: /****if* H5Gf/h5gget_info_c * NAME - * h5gget_info_c + * h5gget_info_c * PURPOSE - * Call H5Gget_info + * Call H5Gget_info * INPUTS - * group_id - Group identifier + * group_id - Group identifier * OUTPUTS * - * storage_type - Type of storage for links in group: + * storage_type - Type of storage for links in group: * H5G_STORAGE_TYPE_COMPACT: Compact storage * H5G_STORAGE_TYPE_DENSE: Indexed storage * H5G_STORAGE_TYPE_SYMBOL_TABLE: Symbol tables, the original HDF5 structure * - * nlinks - Number of links in group - * max_corder - Current maximum creation order value for group - * mounted - Whether group has a file mounted on it (0 = false, 1 = true) + * nlinks - Number of links in group + * max_corder - Current maximum creation order value for group + * mounted - Whether group has a file mounted on it (0 = false, 1 = true) * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * February 15, 2008 + * February 15, 2008 * HISTORY * * - Added 'mounted' paramater * M. Scot Breitenfeld - * July 16, 2008 + * July 16, 2008 * SOURCE */ int_f @@ -914,39 +914,39 @@ done: /****if* H5Gf/h5gget_info_by_idx_c * NAME - * h5gget_info_by_idx_c + * h5gget_info_by_idx_c * PURPOSE - * Call H5Gget_info_by_idx + * Call H5Gget_info_by_idx * INPUTS * - * loc_id - File or group identifier - * group_name - Name of group containing group for which information is to be retrieved - * group_namelen - name length - * index_type - Index type - * order - Order of the count in the index - * n - Position in the index of the group for which information is retrieved - * lapl_id - Link access property list + * loc_id - File or group identifier + * group_name - Name of group containing group for which information is to be retrieved + * group_namelen - name length + * index_type - Index type + * order - Order of the count in the index + * n - Position in the index of the group for which information is retrieved + * lapl_id - Link access property list * OUTPUTS * - * storage_type - Type of storage for links in group: + * storage_type - Type of storage for links in group: * H5G_STORAGE_TYPE_COMPACT: Compact storage * H5G_STORAGE_TYPE_DENSE: Indexed storage * H5G_STORAGE_TYPE_SYMBOL_TABLE: Symbol tables, the original HDF5 structure * - * nlinks - Number of links in group - * max_corder - Current maximum creation order value for group - * mounted - Whether group has a file mounted on it (0 = false, 1 = true) + * nlinks - Number of links in group + * max_corder - Current maximum creation order value for group + * mounted - Whether group has a file mounted on it (0 = false, 1 = true) * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * February 18, 2008 + * February 18, 2008 * HISTORY * * - Added 'mounted' paramater * M. Scot Breitenfeld - * July 16, 2008 + * July 16, 2008 * SOURCE */ int_f @@ -987,36 +987,36 @@ h5gget_info_by_idx_c(hid_t_f *loc_id, _fcd group_name, size_t_f *group_namelen, /****if* H5Gf/h5gget_info_by_name_c * NAME - * h5gget_info_by_name_c + * h5gget_info_by_name_c * PURPOSE - * Call H5Gget_info_by_name + * Call H5Gget_info_by_name * INPUTS * - * loc_id - File or group identifier - * group_name - Name of group containing group for which information is to be retrieved - * group_namelen - name length - * lapl_id - Link access property list + * loc_id - File or group identifier + * group_name - Name of group containing group for which information is to be retrieved + * group_namelen - name length + * lapl_id - Link access property list * OUTPUTS * - * storage_type - Type of storage for links in group: + * storage_type - Type of storage for links in group: * H5G_STORAGE_TYPE_COMPACT: Compact storage * H5G_STORAGE_TYPE_DENSE: Indexed storage * H5G_STORAGE_TYPE_SYMBOL_TABLE: Symbol tables, the original HDF5 structure * - * nlinks - Number of links in group - * max_corder - Current maximum creation order value for group - * mounted - Whether group has a file mounted on it (0 = false, 1 = true) + * nlinks - Number of links in group + * max_corder - Current maximum creation order value for group + * mounted - Whether group has a file mounted on it (0 = false, 1 = true) * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * February 18, 2008 + * February 18, 2008 * HISTORY * * - Added 'mounted' paramater * M. Scot Breitenfeld - * July 16, 2008 + * July 16, 2008 * SOURCE */ int_f diff --git a/fortran/src/H5If.c b/fortran/src/H5If.c index da8b482..fdab0b6 100644 --- a/fortran/src/H5If.c +++ b/fortran/src/H5If.c @@ -1,6 +1,6 @@ /****h* H5If/H5If * PURPOSE - * This file contains C stubs for H5I Fortran APIs + * This file contains C stubs for H5I Fortran APIs * * COPYRIGHT * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * @@ -25,15 +25,15 @@ /****if* H5If/h5iget_type_c * NAME - * h5iget_type_c + * h5iget_type_c * PURPOSE - * Call H5Iget_type to get the type of an object + * Call H5Iget_type to get the type of an object * INPUTS - * obj_id - object identifier + * obj_id - object identifier * OUTPUTS - * type - object type + * type - object type * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su * Thursday, March 24, 2000 @@ -61,24 +61,24 @@ h5iget_type_c (hid_t_f *obj_id, int_f *type) } /****if* H5If/h5iget_name_c * NAME - * h5iget_name_c + * h5iget_name_c * PURPOSE - * Call H5Iget_name to get object's name + * Call H5Iget_name to get object's name * INPUTS - * obj_id - object identifier - * buf_size - size of the buffer + * obj_id - object identifier + * buf_size - size of the buffer * OUTPUTS - * buf - buffer to hold the name + * buf - buffer to hold the name * RETURNS - * length of the name on success, -1 on failure + * length of the name on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, March 12, 2003 + * Wednesday, March 12, 2003 * HISTORY * - * Changed the size of c_buf_size to c_buf_size + 1, which - * fixes the problem of truncating the string by 1 if the - * exact size of the string (buf_size) is passed in. + * Changed the size of c_buf_size to c_buf_size + 1, which + * fixes the problem of truncating the string by 1 if the + * exact size of the string (buf_size) is passed in. * M. Scot Breitenfeld, April 21, 2008 * SOURCE */ @@ -120,15 +120,15 @@ DONE: /****if* H5If/h5iinc_ref_c * NAME - * h5iinc_ref_c + * h5iinc_ref_c * PURPOSE - * Call H5Iinc_ref to increment object's reference count + * Call H5Iinc_ref to increment object's reference count * INPUTS - * obj_id - object identifier + * obj_id - object identifier * OUTPUTS - * ref_count - Reference count of ID + * ref_count - Reference count of ID * RETURNS - * current reference count on success, -1 on failure + * current reference count on success, -1 on failure * AUTHOR * Quincey Koziol * Tuesday, December 9, 2003 @@ -156,18 +156,18 @@ done: /****if* H5If/h5idec_ref_c * NAME - * h5idec_ref_c + * h5idec_ref_c * PURPOSE - * Call H5Idec_ref to decrement object's reference count + * Call H5Idec_ref to decrement object's reference count * INPUTS - * obj_id - object identifier + * obj_id - object identifier * OUTPUTS - * ref_count - Reference count of ID + * ref_count - Reference count of ID * RETURNS - * current reference count on success, -1 on failure + * current reference count on success, -1 on failure * AUTHOR * Quincey Koziol - * Tuesday, December 9, 2003 + * Tuesday, December 9, 2003 * SOURCE */ int_f @@ -192,15 +192,15 @@ done: /****if* H5If/h5iget_ref_c * NAME - * h5iget_ref_c + * h5iget_ref_c * PURPOSE - * Call H5Iget_ref to retrieve object's reference count + * Call H5Iget_ref to retrieve object's reference count * INPUTS - * obj_id - object identifier + * obj_id - object identifier * OUTPUTS - * ref_count - Reference count of ID + * ref_count - Reference count of ID * RETURNS - * current reference count on success, -1 on failure + * current reference count on success, -1 on failure * AUTHOR * Quincey Koziol * Tuesday, December 9, 2003 @@ -229,15 +229,15 @@ done: /****if* H5If/h5iget_file_id_c * NAME - * h5iget_file_id_c + * h5iget_file_id_c * PURPOSE - * Call H5Iget_file_id to obtain file identifier from object identifier + * Call H5Iget_file_id to obtain file identifier from object identifier * INPUTS - * obj_id - object identifier + * obj_id - object identifier * OUTPUTS - * file_id - file identifier + * file_id - file identifier * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal * Tuesday, August 24, 2004 @@ -266,14 +266,14 @@ done: } /*---------------------------------------------------------------------------- - * Name: h5iis_valid_c - * Purpose: Calls H5Iis_valid - * Inputs: obj_id - object identifier - * Outputs: 0 = false, 1 = true - * Returns: 0 on success, -1 on failure - * Programmer: Elena Pourmal - * Tuesday, August 24, 2004 - * Modifications: + * Name: h5iis_valid_c + * Purpose: Calls H5Iis_valid + * Inputs: obj_id - object identifier + * Outputs: 0 = false, 1 = true + * Returns: 0 on success, -1 on failure + * Programmer: Elena Pourmal + * Tuesday, August 24, 2004 + * Modifications: *---------------------------------------------------------------------------*/ int_f h5iis_valid_c(hid_t_f *obj_id, int_f *c_valid) diff --git a/fortran/src/H5Lf.c b/fortran/src/H5Lf.c index f4ad1d4..0d3aac2 100644 --- a/fortran/src/H5Lf.c +++ b/fortran/src/H5Lf.c @@ -1,6 +1,6 @@ /****h* H5Lf/H5Lf * PURPOSE - * This file contains C stubs for H5L Fortran APIs + * This file contains C stubs for H5L Fortran APIs * * COPYRIGHT * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * @@ -26,27 +26,27 @@ /****if* H5Lf/h5lcopy_c * NAME - * h5lcopy_c + * h5lcopy_c * PURPOSE - * Call H5Lcopy + * Call H5Lcopy * INPUTS * - * src_loc_id - Location identifier of the source link - * src_name - Name of the link to be copied - * src_namelen - length of the name - * dest_loc_id - Location identifier specifying the destination of the copy - * dest_name - Name to be assigned to the NEW copy - * dest_namelen - Length of the name - * loc_id - Identifier of the file or group containing the object - * name - Name of the link to delete - * lcpl_id - Link creation property list identifier - * lapl_id - Link access property list identifier + * src_loc_id - Location identifier of the source link + * src_name - Name of the link to be copied + * src_namelen - length of the name + * dest_loc_id - Location identifier specifying the destination of the copy + * dest_name - Name to be assigned to the NEW copy + * dest_namelen - Length of the name + * loc_id - Identifier of the file or group containing the object + * name - Name of the link to delete + * lcpl_id - Link creation property list identifier + * lapl_id - Link access property list identifier * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * January, 2008 + * January, 2008 * HISTORY * * SOURCE @@ -88,21 +88,21 @@ done: /****if* H5Lf/h5lcreate_external_c * NAME - * h5lcreate_external_c + * h5lcreate_external_c * PURPOSE - * Call H5Lcreate_external_c + * Call H5Lcreate_external_c * INPUTS * - * file_name - Name of the file containing the target object. Neither the file nor the target object is - * required to exist. May be the file the link is being created in. - * obj_name - Path within the target file to the target object. + * file_name - Name of the file containing the target object. Neither the file nor the target object is + * required to exist. May be the file the link is being created in. + * obj_name - Path within the target file to the target object. * link_loc_id - The file or group identifier for the new link. - * link_name - The name of the new link. - * lcpl_id - Link creation property list identifier. - * lapl_id - Link access property list identifier. + * link_name - The name of the new link. + * lcpl_id - Link creation property list identifier. + * lapl_id - Link access property list identifier. * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld * February 29, 2008 @@ -150,22 +150,22 @@ done: /****if* H5Lf/h5ldelete_c * NAME - * h5ldelete_c + * h5ldelete_c * PURPOSE - * Call H5Ldelete + * Call H5Ldelete * INPUTS * * - * loc_id - Identifier of the file or group containing the object - * name - Name of the link to delete - * lapl_id - Link access property list identifier - * namelen - length of name + * loc_id - Identifier of the file or group containing the object + * name - Name of the link to delete + * lapl_id - Link access property list identifier + * namelen - length of name * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * January, 2008 + * January, 2008 * SOURCE */ @@ -197,23 +197,23 @@ done: /****if* H5Lf/h5lcreate_soft_c * NAME - * h5lcreate_soft_c + * h5lcreate_soft_c * PURPOSE - * Call H5Lcreate_soft + * Call H5Lcreate_soft * INPUTS * * - * target_path - Path to the target object, which is not required to exist. - * link_loc_id - The file or group identifier for the new link. - * link_name - The name of the new link. - * lcpl_id - Link creation property list identifier. - * lapl_id - Link access property list identifier. + * target_path - Path to the target object, which is not required to exist. + * link_loc_id - The file or group identifier for the new link. + * link_name - The name of the new link. + * lcpl_id - Link creation property list identifier. + * lapl_id - Link access property list identifier. * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * February 20, 2008 + * February 20, 2008 * SOURCE */ @@ -253,22 +253,22 @@ h5lcreate_soft_c(_fcd target_path, size_t_f *target_path_len, /****if* H5Lf/h5lcreate_hard_c * NAME - * h5lcreate_hard_c + * h5lcreate_hard_c * PURPOSE - * Call H5Lcreate_hard + * Call H5Lcreate_hard * INPUTS * - * obj_loc_id - The file or group identifier for the target object. - * obj_name - Name of the target object, which must already exist. - * obj_namelen - Name length - * link_loc_id - The file or group identifier for the new link. - * link_name - The name of the new link. - * link_namelen- Name length - * lcpl_id - Link creation property list identifier. - * lapl_id - Link access property list identifier. + * obj_loc_id - The file or group identifier for the target object. + * obj_name - Name of the target object, which must already exist. + * obj_namelen - Name length + * link_loc_id - The file or group identifier for the new link. + * link_name - The name of the new link. + * link_namelen- Name length + * lcpl_id - Link creation property list identifier. + * lapl_id - Link access property list identifier. * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld * February 27, 2008 @@ -310,35 +310,35 @@ h5lcreate_hard_c(hid_t_f *obj_loc_id, _fcd obj_name, size_t_f *obj_namelen, /****if* H5Lf/h5ldelete_by_idx_c * NAME - * h5ldelete_by_idx_c + * h5ldelete_by_idx_c * PURPOSE - * Calls h5ldelete_by_idx + * Calls h5ldelete_by_idx * INPUTS * - * loc_id - File or group identifier specifying location of subject group - * group_name - Name of subject group - * group_namelen - Name length - * index_field - Type of index; Possible values are: + * loc_id - File or group identifier specifying location of subject group + * group_name - Name of subject group + * group_namelen - Name length + * index_field - Type of index; Possible values are: * H5_INDEX_UNKNOWN_F = -1 - Unknown index type * H5_INDEX_NAME_F - Index on names * H5_INDEX_CRT_ORDER_F - Index on creation order * H5_INDEX_N_F - Number of indices defined - * order - Order within field or index; Possible values are: + * order - Order within field or index; Possible values are: * H5_ITER_UNKNOWN_F - Unknown order * H5_ITER_INC_F - Increasing order * H5_ITER_DEC_F - Decreasing order * H5_ITER_NATIVE_F - No particular order, whatever is fastest * H5_ITER_N_F - Number of iteration orders - * n - Link for which to retrieve information - * lapl_id - Link access property list + * n - Link for which to retrieve information + * lapl_id - Link access property list * * OUTPUTS * N/A * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * February 29, 2008 + * February 29, 2008 * HISTORY * N/A * SOURCE @@ -376,22 +376,22 @@ done: /****if* H5Lf/h5lexists_c * NAME - * h5lexists_c + * h5lexists_c * PURPOSE - * Calls H5Lexists + * Calls H5Lexists * INPUTS * - * loc_id - Identifier of the file or group to query. - * name - Link name to check - * lapl_id - Link access property list identifier. + * loc_id - Identifier of the file or group to query. + * name - Link name to check + * lapl_id - Link access property list identifier. * OUTPUTS * - * link_exists_c - returns a positive value, for TRUE, or 0 (zero), for FALSE. + * link_exists_c - returns a positive value, for TRUE, or 0 (zero), for FALSE. * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * February 29, 2008 + * February 29, 2008 * HISTORY * * SOURCE @@ -423,34 +423,34 @@ done: /****if* H5Lf/h5lget_info_c * NAME - * h5lget_info_c + * h5lget_info_c * PURPOSE - * Call H5Lget_info + * Call H5Lget_info * INPUTS * * link_loc_id - File or group identifier. - * link_name - Name of the link for which information is being sought - * link_namelen - Name length - * lapl_id - Link access property list + * link_name - Name of the link for which information is being sought + * link_namelen - Name length + * lapl_id - Link access property list * OUTPUTS * * - * cset - indicates the character set used for link’s name. - * corder - specifies the link’s creation order position. - * corder_valid - indicates whether the value in corder is valid. - * link_type - specifies the link class: + * cset - indicates the character set used for link’s name. + * corder - specifies the link’s creation order position. + * corder_valid - indicates whether the value in corder is valid. + * link_type - specifies the link class: * H5L_LINK_HARD_F - Hard link * H5L_LINK_SOFT_F - Soft link * H5L_LINK_EXTERNAL_F - External link * H5L_LINK_ERROR_F - Error - * address - If the link is a hard link, address specifies the file address that the link points to - * val_size - If the link is a symbolic link, val_size will be the length of the link value + * address - If the link is a hard link, address specifies the file address that the link points to + * val_size - If the link is a symbolic link, val_size will be the length of the link value * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * January, 2008 + * January, 2008 * HISTORY * N/A * SOURCE @@ -496,30 +496,30 @@ done: /****if* H5Lf/h5lget_info_by_idx_c * NAME - * h5lget_info_by_idx_c + * h5lget_info_by_idx_c * PURPOSE - * Call H5Lget_info_by_idx + * Call H5Lget_info_by_idx * INPUTS * * loc_id - File or group identifier specifying location of subject group - * group_name - Name of subject group - *group_namelen - Name length + * group_name - Name of subject group + * group_namelen - Name length * index_field - Index or field which determines the order - * order - Order within field or index - * n - Link for which to retrieve information - * lapl_id - Link access property list + * order - Order within field or index + * n - Link for which to retrieve information + * lapl_id - Link access property list * OUTPUTS * - * corder_valid - Indicates whether the the creation order data is valid for this attribute - * corder - Is a positive integer containing the creation order of the attribute - * cset - Indicates the character set used for the attribute’s name - * data_size - indicates the size, in the number of characters, of the attribute + * corder_valid - Indicates whether the the creation order data is valid for this attribute + * corder - Is a positive integer containing the creation order of the attribute + * cset - Indicates the character set used for the attribute’s name + * data_size - indicates the size, in the number of characters, of the attribute * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * January, 2008 + * January, 2008 * HISTORY * N/A * SOURCE @@ -570,7 +570,7 @@ done: * NAME * H5Lis_registered_c * PURPOSE - * Call H5Lis_registered + * Call H5Lis_registered * INPUTS * * link_cls_id - User-defined link class identifier @@ -578,11 +578,11 @@ done: * NONE * * RETURNS - * Returns a positive value if the link class has been registered - * and zero if it is unregistered. Otherwise returns a negative value + * Returns a positive value if the link class has been registered + * and zero if it is unregistered. Otherwise returns a negative value * AUTHOR * M. Scot Breitenfeld - * March 3, 2008 + * March 3, 2008 * HISTORY * N/A * SOURCE @@ -621,25 +621,25 @@ h5lis_registered_c(int_f *link_cls_id) /****if* H5Lf/h5lmove_c * NAME - * h5lmove_c + * h5lmove_c * PURPOSE - * Call H5Lmove + * Call H5Lmove * INPUTS * - * src_loc_id - Original file or group identifier. - * src_name - Original link name. - * src_namelen - name length - * dest_loc_id - Destination file or group identifier. - * dest_name - NEW link name. - * dest_namelen - name length + * src_loc_id - Original file or group identifier. + * src_name - Original link name. + * src_namelen - name length + * dest_loc_id - Destination file or group identifier. + * dest_name - NEW link name. + * dest_namelen - name length * OUTPUTS * * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * March 3, 2008 + * March 3, 2008 * SOURCE */ int_f @@ -682,17 +682,17 @@ done: * Call H5Lget_name_by_idx * INPUTS * - * loc_id - File or group identifier specifying location of subject group - * group_name - Name of subject group - * index_field - Index or field which determines the order - * order - Order within field or index - * n - Link for which to retrieve information - * size - Maximum number of characters of link value to be returned. - * lapl_id - Link access property list + * loc_id - File or group identifier specifying location of subject group + * group_name - Name of subject group + * index_field - Index or field which determines the order + * order - Order within field or index + * n - Link for which to retrieve information + * size - Maximum number of characters of link value to be returned. + * lapl_id - Link access property list * OUTPUTS * - * name - Buffer in which link value is returned - * size - The size of the link name on success + * name - Buffer in which link value is returned + * size - The size of the link name on success * RETURNS * 0 on success, -1 on failure * AUTHOR @@ -916,25 +916,25 @@ done: /****if* H5Lf/h5lget_val_c * NAME - * h5lget_val_c + * h5lget_val_c * PURPOSE - * Call H5Lget_val + * Call H5Lget_val * INPUTS * - * link_loc_id - File or group identifier. - * link_name - Link whose value is to be returned. - * link_name_len - length of link_name - * size - Maximum number of characters of link value to be returned. - * lapl_id - List access property list identifier + * link_loc_id - File or group identifier. + * link_name - Link whose value is to be returned. + * link_name_len - length of link_name + * size - Maximum number of characters of link value to be returned. + * lapl_id - List access property list identifier * OUTPUTS * - * linkval_buff - The buffer to hold the returned link value. + * linkval_buff - The buffer to hold the returned link value. * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * April 11, 2008 + * April 11, 2008 * SOURCE */ int_f @@ -971,16 +971,16 @@ done: * Calls H5Literate * INPUTS * - * group_id - Identifier specifying subject group - * index_type - Type of index which determines the order - * order - Order within index - * idx - Iteration position at which to start - * op - Callback function passing data regarding the link to the calling application - * op_data - User-defined pointer to data required by the application for its processing of the link + * group_id - Identifier specifying subject group + * index_type - Type of index which determines the order + * order - Order within index + * idx - Iteration position at which to start + * op - Callback function passing data regarding the link to the calling application + * op_data - User-defined pointer to data required by the application for its processing of the link * * OUTPUTS * - * idx - Position at which an interrupted iteration may be restarted + * idx - Position at which an interrupted iteration may be restarted * * RETURNS * >0 on success, 0< on failure @@ -1018,19 +1018,19 @@ h5literate_c(hid_t_f *group_id, int_f *index_type, int_f *order, hsize_t_f *idx, * Call H5Literate_by_name * INPUTS * - * loc_id - Identifier specifying subject group - * name - Name of subject group - * namelen - Name length - * index_type - Type of index which determines the order - * order - Order within index - * idx - Iteration position at which to start - * op - Callback function passing data regarding the link to the calling application - * op_data - User-defined pointer to data required by the application for its processing of the link - * lapl_id - List access property list identifier + * loc_id - Identifier specifying subject group + * name - Name of subject group + * namelen - Name length + * index_type - Type of index which determines the order + * order - Order within index + * idx - Iteration position at which to start + * op - Callback function passing data regarding the link to the calling application + * op_data - User-defined pointer to data required by the application for its processing of the link + * lapl_id - List access property list identifier * * OUTPUTS * - * idx - Position at which an interrupted iteration may be restarted + * idx - Position at which an interrupted iteration may be restarted * * RETURNS * >0 on success, 0< on failure diff --git a/fortran/src/H5Of.c b/fortran/src/H5Of.c index 7000ba2..4801f7d 100644 --- a/fortran/src/H5Of.c +++ b/fortran/src/H5Of.c @@ -1,6 +1,6 @@ /****h* H5Of/H5Of * PURPOSE - * This file contains C stubs for H5O Fortran APIs + * This file contains C stubs for H5O Fortran APIs * * COPYRIGHT * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * @@ -109,12 +109,12 @@ fill_h5o_info_t_f(H5O_info_t Oinfo, H5O_info_t_f *object_info) { * PURPOSE * Calls H5Olink * INPUTS - * object_id - Object to be linked. - * new_loc_id - File or group identifier specifying location at which object is to be linked. - * name - Name of link to be created, relative to new_loc_id. - * namelen - Length of buffer for link to be created. - * lcpl_id - Link creation property list identifier. - * lapl_id - Link access property list identifier. + * object_id - Object to be linked. + * new_loc_id - File or group identifier specifying location at which object is to be linked. + * name - Name of link to be created, relative to new_loc_id. + * namelen - Length of buffer for link to be created. + * lcpl_id - Link creation property list identifier. + * lapl_id - Link access property list identifier. * RETURNS * 0 on success, -1 on failure * AUTHOR @@ -194,16 +194,16 @@ h5oopen_c (hid_t_f *loc_id, _fcd name, size_t_f *namelen, hid_t_f *lapl_id, hid_ } /****if* H5Of/h5oclose_c * NAME - * h5oclose_c + * h5oclose_c * PURPOSE - * Call H5Oclose + * Call H5Oclose * INPUTS - * object_id - Object identifier + * object_id - Object identifier * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * December 17, 2008 + * December 17, 2008 * SOURCE */ int_f @@ -225,15 +225,15 @@ h5oclose_c ( hid_t_f *object_id ) * PURPOSE * Calls H5Ovisit * INPUTS - * object_id - Identifier specifying subject group - * index_type - Type of index which determines the order - * order - Order within index - * idx - Iteration position at which to start - * op - Callback function passing data regarding the link to the calling application - * op_data - User-defined pointer to data required by the application for its processing of the link + * object_id - Identifier specifying subject group + * index_type - Type of index which determines the order + * order - Order within index + * idx - Iteration position at which to start + * op - Callback function passing data regarding the link to the calling application + * op_data - User-defined pointer to data required by the application for its processing of the link * * OUTPUTS - * idx - Position at which an interrupted iteration may be restarted + * idx - Position at which an interrupted iteration may be restarted * * RETURNS * >0 on success, 0< on failure @@ -266,13 +266,13 @@ h5ovisit_c(hid_t_f *group_id, int_f *index_type, int_f *order, H5O_iterate_t op, * Calls H5open_by_addr * INPUTS * loc_id - File or group identifier - * addr - Object’s address in the file + * addr - Object’s address in the file * * OUTPUTS * obj_id - Dataset identifier * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld * September 14, 2009 @@ -499,15 +499,15 @@ h5ocopy_c (hid_t_f *src_loc_id, _fcd src_name, size_t_f *src_name_len, * PURPOSE * Calls H5Ovisit_by_name * INPUTS - * object_id - Identifier specifying subject group - * index_type - Type of index which determines the order - * order - Order within index - * idx - Iteration position at which to start - * op - Callback function passing data regarding the link to the calling application - * op_data - User-defined pointer to data required by the application for its processing of the link + * object_id - Identifier specifying subject group + * index_type - Type of index which determines the order + * order - Order within index + * idx - Iteration position at which to start + * op - Callback function passing data regarding the link to the calling application + * op_data - User-defined pointer to data required by the application for its processing of the link * * OUTPUTS - * idx - Position at which an interrupted iteration may be restarted + * idx - Position at which an interrupted iteration may be restarted * * RETURNS * >0 on success, 0< on failure @@ -697,7 +697,7 @@ h5oset_comment_c (hid_t_f *object_id, _fcd comment, size_t_f *commentlen) * INPUTS * object_id - Identifier of the target object. * name - Name of the object whose comment is to be set or reset, - * specified as a path relative to loc_id. + * specified as a path relative to loc_id. * namelen - Length of the name. * comment - The new comment. * commentlen - Length of the comment. @@ -755,7 +755,7 @@ h5oset_comment_by_name_c (hid_t_f *object_id, _fcd name, size_t_f *namelen, _fc * n - Object to open. * lapl_id - Link access property list. * OUTPUTS - * obj_id - An object identifier for the opened object. + * obj_id - An object identifier for the opened object. * RETURNS * 0 on success, -1 on failure * AUTHOR diff --git a/fortran/src/H5Pf.c b/fortran/src/H5Pf.c index 55f783b..59c6859 100644 --- a/fortran/src/H5Pf.c +++ b/fortran/src/H5Pf.c @@ -1,6 +1,6 @@ /****h* H5Pf/H5Pf * PURPOSE - * This file contains C stubs for H5P Fortran APIs + * This file contains C stubs for H5P Fortran APIs * * COPYRIGHT * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * @@ -43,15 +43,15 @@ /****if* H5Pf/h5pcreate_c * NAME - * h5pcreate_c + * h5pcreate_c * PURPOSE - * Call H5Pcreate to create a property list + * Call H5Pcreate to create a property list * INPUTS - * cls - property list class identifier + * cls - property list class identifier * OUTPUTS - * prp_id - identifier of the created property list + * prp_id - identifier of the created property list * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal * Wednesday, October 9, 2002 @@ -78,16 +78,16 @@ done: /****if* H5Pf/h5pclose_c * NAME - * h5pclose_c + * h5pclose_c * PURPOSE - * Call H5Pclose to close property lis + * Call H5Pclose to close property lis * INPUTS - * prp_id - identifier of the property list to be closed + * prp_id - identifier of the property list to be closed * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Saturday, August 14, 1999 + * Saturday, August 14, 1999 * * SOURCE */ @@ -107,18 +107,18 @@ h5pclose_c ( hid_t_f *prp_id ) /****if* H5Pf/h5pcopy_c * NAME - * h5pcopy_c + * h5pcopy_c * PURPOSE - * Call H5Pcopy to copy property list + * Call H5Pcopy to copy property list * INPUTS - * prp_id - identifier of the property list to be copied + * prp_id - identifier of the property list to be copied * OUTPUTS - * new_prp_id - identifier of the new property list + * new_prp_id - identifier of the new property list * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Saturday, August 14, 1999 + * Saturday, August 14, 1999 * * SOURCE */ @@ -141,19 +141,19 @@ done: /****if* H5Pf/h5pequal_c * NAME - * h5pequal_c + * h5pequal_c * PURPOSE - * Call H5Pequal to check if two property lists are equal + * Call H5Pequal to check if two property lists are equal * INPUTS - * plist1_id - property list identifier - * plist2_id - property list identifier + * plist1_id - property list identifier + * plist2_id - property list identifier * OUTPUTS - * c_flag - flag to indicate that lists are eqaul + * c_flag - flag to indicate that lists are eqaul * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Monday, September 30, 2002 + * Monday, September 30, 2002 * * SOURCE */ @@ -210,15 +210,15 @@ done: /****if* H5Pf/h5pset_preserve_c * NAME - * h5pset_preserve_c + * h5pset_preserve_c * PURPOSE - * Call H5Pset_preserve to set transfer property for compound - * datatype + * Call H5Pset_preserve to set transfer property for compound + * datatype * INPUTS - * prp_id - property list identifier - * flag - TRUE/FALSE flag + * prp_id - property list identifier + * flag - TRUE/FALSE flag * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal * Thursday, February 17, 2000 @@ -244,16 +244,16 @@ h5pset_preserve_c ( hid_t_f *prp_id , int_f *flag) /****if* H5Pf/h5pget_preserve_c * NAME - * h5pget_preserve_c + * h5pget_preserve_c * PURPOSE - * Call H5Pget_preserve to set transfer property for compound - * datatype + * Call H5Pget_preserve to set transfer property for compound + * datatype * INPUTS - * prp_id - property list identifier + * prp_id - property list identifier * OUTPUTS - * flag - TRUE/FALSE flag + * flag - TRUE/FALSE flag * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal * Thursday, February 17, 2000 @@ -277,17 +277,17 @@ h5pget_preserve_c ( hid_t_f *prp_id , int_f *flag) /****if* H5Pf/h5pset_deflate_c * NAME - * h5pset_deflate_c + * h5pset_deflate_c * PURPOSE - * Call H5Pset_deflate to set deflate level + * Call H5Pset_deflate to set deflate level * INPUTS - * prp_id - property list identifier - * level - level of deflation + * prp_id - property list identifier + * level - level of deflation * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Saturday, August 14, 1999 + * Saturday, August 14, 1999 * SOURCE */ @@ -311,17 +311,17 @@ h5pset_deflate_c ( hid_t_f *prp_id , int_f *level) /****if* H5Pf/h5pset_chunk_c * NAME - * h5pset_chunk_c + * h5pset_chunk_c * PURPOSE - * Call H5Pset_chunk to set the sizes of chunks for a chunked - * layout dataset + * Call H5Pset_chunk to set the sizes of chunks for a chunked + * layout dataset * INPUTS - * prp_id - property list identifier - * rank - number of dimensions of each chunk - * dims - array of the size of each chunk + * prp_id - property list identifier + * rank - number of dimensions of each chunk + * dims - array of the size of each chunk * RETURNS - * 0 on success, -1 on failure - * Saturday, August 14, 1999 + * 0 on success, -1 on failure + * Saturday, August 14, 1999 * AUTHOR * Elena Pourmal * SOURCE @@ -355,17 +355,17 @@ DONE: /****if* H5Pf/h5pget_chunk_c * NAME - * h5pget_chunk_c + * h5pget_chunk_c * PURPOSE - * Call H5Pget_chunk to get the sizes of chunks for a chunked - * layout dataset for at list max_rank number of dimensions + * Call H5Pget_chunk to get the sizes of chunks for a chunked + * layout dataset for at list max_rank number of dimensions * INPUTS - * prp_id - property list identifier - * max rank - maximum number of dimensions to return - * dims - array of the size of each chunk + * prp_id - property list identifier + * max rank - maximum number of dimensions to return + * dims - array of the size of each chunk * RETURNS - * number of chunk's dimnesion on success, -1 on failure - * Saturday, August 14, 1999 + * number of chunk's dimnesion on success, -1 on failure + * Saturday, August 14, 1999 * AUTHOR * Elena Pourmal * SOURCE @@ -470,24 +470,24 @@ h5pget_fill_value_c (hid_t_f *prp_id, hid_t_f *type_id, void *fillvalue) /****if* H5Pf/h5pget_version_c * NAME - * h5pget_version_c + * h5pget_version_c * PURPOSE - * Call H5Pget_version to get the version information - * of various objects for a file creation property list + * Call H5Pget_version to get the version information + * of various objects for a file creation property list * INPUTS - * prp_id - property list identifier + * prp_id - property list identifier * OUTPUTS - * boot - array to put boot block version number - * freelist - array to put global freelist version number - * stab - array to put symbol table version number - * shhdr - array to put shared object header version number + * boot - array to put boot block version number + * freelist - array to put global freelist version number + * stab - array to put symbol table version number + * shhdr - array to put shared object header version number * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Wednesday, February 23, 2000 + * Wednesday, February 23, 2000 * HISTORY - * Removed extra length parameters EP 7/6/00 + * Removed extra length parameters EP 7/6/00 * SOURCE */ int_f @@ -528,18 +528,18 @@ h5pget_version_c (hid_t_f *prp_id, int_f * boot,int_f * freelist, int_f * stab, /****if* H5Pf/h5pget_userblock_c * NAME - * h5pget_userblock_c + * h5pget_userblock_c * PURPOSE - * Call H5Pget_userblock to get the size of a user block in - * a file creation property list + * Call H5Pget_userblock to get the size of a user block in + * a file creation property list * INPUTS - * prp_id - property list identifier - * Outputs size - Size of the user-block in bytes + * prp_id - property list identifier + * Outputs size - Size of the user-block in bytes * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Wednesday, February 23, 2000 + * Wednesday, February 23, 2000 * SOURCE */ int_f @@ -566,18 +566,18 @@ h5pget_userblock_c (hid_t_f *prp_id, hsize_t_f * size) /****if* H5Pf/h5pset_userblock_c * NAME - * h5pset_userblock_c + * h5pset_userblock_c * PURPOSE - * Call H5Pset_userblock to set the size of a user block in - * a file creation property list + * Call H5Pset_userblock to set the size of a user block in + * a file creation property list * INPUTS - * prp_id - property list identifier - * size - Size of the user-block in bytes + * prp_id - property list identifier + * size - Size of the user-block in bytes * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Wednesday, February 23, 2000 + * Wednesday, February 23, 2000 * SOURCE */ int_f @@ -603,21 +603,21 @@ h5pset_userblock_c (hid_t_f *prp_id, hsize_t_f * size) /****if* H5Pf/h5pget_sizes_c * NAME - * h5pget_sizes_c + * h5pget_sizes_c * PURPOSE - * Call H5Pget_sizes to get the size of the offsets - * and lengths used in an HDF5 file + * Call H5Pget_sizes to get the size of the offsets + * and lengths used in an HDF5 file * INPUTS - * prp_id - property list identifier - * Outputs sizeof_addr - Size of an object offset in bytes - * sizeof_size - Size of an object length in bytes + * prp_id - property list identifier + * Outputs sizeof_addr - Size of an object offset in bytes + * sizeof_size - Size of an object length in bytes * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Wednesday, February 23, 2000 + * Wednesday, February 23, 2000 * HISTORY - * Deleted extra length parameters. EP 6/7/00 + * Deleted extra length parameters. EP 6/7/00 * SOURCE */ int_f @@ -646,18 +646,18 @@ h5pget_sizes_c (hid_t_f *prp_id, size_t_f * sizeof_addr, size_t_f * sizeof_size) /****if* H5Pf/h5pset_sizes_c * NAME - * h5pset_sizes_c + * h5pset_sizes_c * PURPOSE - * Call H5Pset_sizes to set the size of the offsets + * Call H5Pset_sizes to set the size of the offsets * INPUTS - * prp_id - property list identifier - * sizeof_addr - Size of an object offset in bytes - * sizeof_size - Size of an object length in bytes + * prp_id - property list identifier + * sizeof_addr - Size of an object offset in bytes + * sizeof_size - Size of an object length in bytes * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Wednesday, February 23, 2000 + * Wednesday, February 23, 2000 * HISTORY * * SOURCE @@ -686,19 +686,19 @@ h5pset_sizes_c (hid_t_f *prp_id, size_t_f * sizeof_addr, size_t_f * sizeof_size) /****if* H5Pf/h5pset_sym_k_c * NAME - * h5pset_sym_k_c + * h5pset_sym_k_c * PURPOSE - * Call H5Pset_sym_k to set the size of parameters used - * to control the symbol table node + * Call H5Pset_sym_k to set the size of parameters used + * to control the symbol table node * INPUTS - * prp_id - property list identifier - * ik - Symbol table tree rank - * lk - Symbol table node size + * prp_id - property list identifier + * ik - Symbol table tree rank + * lk - Symbol table node size * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Friday, February 25, 2000 + * Friday, February 25, 2000 * SOURCE */ int_f @@ -726,20 +726,20 @@ h5pset_sym_k_c (hid_t_f *prp_id, int_f* ik, int_f* lk) /****if* H5Pf/h5pget_sym_k_c * NAME - * h5pget_sym_k_c + * h5pget_sym_k_c * PURPOSE - * Call H5Pget_sym_k to get the size of parameters used - * to control the symbol table node + * Call H5Pget_sym_k to get the size of parameters used + * to control the symbol table node * INPUTS - * prp_id - property list identifier + * prp_id - property list identifier * OUTPUTS - * ik - Symbol table tree rank - * lk - Symbol table node size + * ik - Symbol table tree rank + * lk - Symbol table node size * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Friday, February 25, 2000 + * Friday, February 25, 2000 * HISTORY * * SOURCE @@ -768,18 +768,18 @@ h5pget_sym_k_c (hid_t_f *prp_id, int_f* ik, int_f* lk) /****if* H5Pf/h5pset_istore_k_c * NAME - * h5pset_istore_k_c + * h5pset_istore_k_c * PURPOSE - * Call H5Pset_istore_k to set the size of the parameter - * used to control the B-trees for indexing chunked datasets + * Call H5Pset_istore_k to set the size of the parameter + * used to control the B-trees for indexing chunked datasets * INPUTS - * prp_id - property list identifier - * ik - Symbol table tree rank + * prp_id - property list identifier + * ik - Symbol table tree rank * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Friday, February 25, 2000 + * Friday, February 25, 2000 * HISTORY * * SOURCE @@ -807,19 +807,19 @@ h5pset_istore_k_c (hid_t_f *prp_id, int_f* ik) /****if* H5Pf/h5pget_istore_k_c * NAME - * h5pget_istore_k_c + * h5pget_istore_k_c * PURPOSE - * Call H5Pget_istore_k to get the size of parameters used - * to control the B-trees for indexing chunked datasets + * Call H5Pget_istore_k to get the size of parameters used + * to control the B-trees for indexing chunked datasets * INPUTS - * prp_id - property list identifier + * prp_id - property list identifier * OUTPUTS - * ik - Symbol table tree rank + * ik - Symbol table tree rank * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Friday, February 25, 2000 + * Friday, February 25, 2000 * HISTORY * * SOURCE @@ -846,18 +846,18 @@ h5pget_istore_k_c (hid_t_f *prp_id, int_f* ik) /****if* H5Pf/h5pget_driver_c * NAME - * h5pget_driver_c + * h5pget_driver_c * PURPOSE - * Call H5Pget_driver to get low-level file driver identifier + * Call H5Pget_driver to get low-level file driver identifier * INPUTS - * prp_id - property list identifier + * prp_id - property list identifier * OUTPUTS - * driver - low-level file driver identifier + * driver - low-level file driver identifier * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Friday, February 25, 2000 + * Friday, February 25, 2000 * HISTORY * * SOURCE @@ -884,17 +884,17 @@ DONE: /****if* H5Pf/h5pset_fapl_stdio_c * NAME - * h5pset_fapl_stdio_c + * h5pset_fapl_stdio_c * PURPOSE - * Call H5Pset_stdio to set the low level file driver to - * use the functions declared in the stdio.h + * Call H5Pset_stdio to set the low level file driver to + * use the functions declared in the stdio.h * INPUTS - * prp_id - property list identifier + * prp_id - property list identifier * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * March 7, 2001 + * March 7, 2001 * HISTORY * * SOURCE @@ -918,20 +918,20 @@ h5pset_fapl_stdio_c (hid_t_f *prp_id) #ifdef NO_SUCH_F90_FUNCTION /****if* H5Pf/h5pget_fapl_stdio_c * NAME - * h5pget_fapl_stdio_c + * h5pget_fapl_stdio_c * PURPOSE - * Call H5Pget_fapl_stdio to determine whther the low level file driver - * uses the functions declared in the stdio.h + * Call H5Pget_fapl_stdio to determine whther the low level file driver + * uses the functions declared in the stdio.h * INPUTS - * prp_id - property list identifier + * prp_id - property list identifier * OUTPUTS - * io - value indicates whether the file driver uses - * the functions declared in the stdio.h + * io - value indicates whether the file driver uses + * the functions declared in the stdio.h * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * March 9, 2001 + * March 9, 2001 * HISTORY * * SOURCE @@ -958,17 +958,17 @@ h5pget_fapl_stdio_c (hid_t_f *prp_id, int_f* io) /****if* H5Pf/h5pset_fapl_sec2_c * NAME - * h5pset_fapl_sec2_c + * h5pset_fapl_sec2_c * PURPOSE - * Call H5Pset_fapl_sec2 to set the low level file driver to - * use the functions declared in the unistd.h + * Call H5Pset_fapl_sec2 to set the low level file driver to + * use the functions declared in the unistd.h * INPUTS - * prp_id - property list identifier + * prp_id - property list identifier * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * March 9, 2001 + * March 9, 2001 * HISTORY * * SOURCE @@ -993,20 +993,20 @@ h5pset_fapl_sec2_c (hid_t_f *prp_id) #ifdef NO_SUCH_F90_FUNCTION /****if* H5Pf/h5pget_fapl_sec2_c * NAME - * h5pget_fapl_sec2_c + * h5pget_fapl_sec2_c * PURPOSE - * Call H5Pget_fapl_stdio to determine whther the low level file driver - * uses the functions declared in the unistd.h + * Call H5Pget_fapl_stdio to determine whther the low level file driver + * uses the functions declared in the unistd.h * INPUTS - * prp_id - property list identifier + * prp_id - property list identifier * OUTPUTS - * sec2 - value indicates whether the file driver uses - * the functions declared in the unistd.h + * sec2 - value indicates whether the file driver uses + * the functions declared in the unistd.h * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * March 9, 2001 + * March 9, 2001 * HISTORY * * SOURCE @@ -1032,19 +1032,19 @@ h5pget_fapl_sec2_c (hid_t_f *prp_id, int_f* sec2) /****if* H5Pf/h5pset_alignment_c * NAME - * h5pset_alignment_c + * h5pset_alignment_c * PURPOSE - * Call H5Pset_alignment to set alignment properties of - * a file access property list + * Call H5Pset_alignment to set alignment properties of + * a file access property list * INPUTS - * prp_id - property list identifier - * threshold - Threshold value - * alignment - Alignment value + * prp_id - property list identifier + * threshold - Threshold value + * alignment - Alignment value * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Friday, February 25, 2000 + * Friday, February 25, 2000 * HISTORY * * SOURCE @@ -1071,19 +1071,19 @@ h5pset_alignment_c (hid_t_f *prp_id, hsize_t_f* threshold, hsize_t_f* alignment) /****if* H5Pf/h5pget_alignment_c * NAME - * h5pget_alignment_c + * h5pget_alignment_c * PURPOSE - * Call H5Pget_alignment to get alignment properties of - * a file access property list + * Call H5Pget_alignment to get alignment properties of + * a file access property list * INPUTS - * prp_id - property list identifier - * threshold - Threshold value - * alignment - Alignment value + * prp_id - property list identifier + * threshold - Threshold value + * alignment - Alignment value * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Friday, February 25, 2000 + * Friday, February 25, 2000 * HISTORY * * SOURCE @@ -1111,20 +1111,20 @@ h5pget_alignment_c (hid_t_f *prp_id, hsize_t_f* threshold, hsize_t_f* alignment) /****if* H5Pf/h5pset_fapl_core_c * NAME - * h5pset_fapl_core_c + * h5pset_fapl_core_c * PURPOSE - * Call H5Pset_fapl_core to set the low-level file driver - * to use malloc() and free() + * Call H5Pset_fapl_core to set the low-level file driver + * to use malloc() and free() * INPUTS - * prp_id - property list identifier - * increment - File block size in bytes - * flag - Boolean flag indicating whether to write the - * file contents to disk when the file is closed. + * prp_id - property list identifier + * increment - File block size in bytes + * flag - Boolean flag indicating whether to write the + * file contents to disk when the file is closed. * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * March 9, 2001 + * March 9, 2001 * HISTORY * * SOURCE @@ -1153,18 +1153,18 @@ h5pset_fapl_core_c (hid_t_f *prp_id, size_t_f* increment, int_f *flag) /****if* H5Pf/h5pget_fapl_core_c * NAME - * h5pget_fapl_core_c + * h5pget_fapl_core_c * PURPOSE - * Call H5Pget_fapl_core to determine whether the file access - * property list is set to the core drive + * Call H5Pget_fapl_core to determine whether the file access + * property list is set to the core drive * INPUTS - * prp_id - property list identifier - * Outputs increment - File block size in bytes + * prp_id - property list identifier + * Outputs increment - File block size in bytes * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * March 9, 2001 + * March 9, 2001 * HISTORY * * SOURCE @@ -1193,20 +1193,20 @@ h5pget_fapl_core_c (hid_t_f *prp_id, size_t_f* increment, int_f *flag) /****if* H5Pf/h5pset_fapl_family_c * NAME - * h5pset_fapl_family_c + * h5pset_fapl_family_c * PURPOSE - * Call H5Pset_fapl_family to set the file access properties list - * to the family driver + * Call H5Pset_fapl_family to set the file access properties list + * to the family driver * INPUTS - * prp_id - property list identifier - * memb_size - Logical size, in bytes, of each family member. - * memb_plist - Identifier of the file access property list - * for each member of the family + * prp_id - property list identifier + * memb_size - Logical size, in bytes, of each family member. + * memb_plist - Identifier of the file access property list + * for each member of the family * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * March 9, 2001 + * March 9, 2001 * HISTORY * * SOURCE @@ -1234,20 +1234,20 @@ h5pset_fapl_family_c(hid_t_f *prp_id, hsize_t_f* memb_size, hid_t_f* memb_plist /****if* H5Pf/h5pget_fapl_family_c * NAME - * h5pget_fapl_family_c + * h5pget_fapl_family_c * PURPOSE - * Call H5Pget_fapl_family to determine whether the file access - * property list is set to the family driver + * Call H5Pget_fapl_family to determine whether the file access + * property list is set to the family driver * INPUTS - * prp_id - property list identifier - * memb_size - Logical size, in bytes, of each family member. - * memb_plist - Identifier of the file access property list - * for each member of the family + * prp_id - property list identifier + * memb_size - Logical size, in bytes, of each family member. + * memb_plist - Identifier of the file access property list + * for each member of the family * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * March 9, 2001 + * March 9, 2001 * HISTORY * * SOURCE @@ -1276,25 +1276,25 @@ h5pget_fapl_family_c(hid_t_f *prp_id, hsize_t_f* memb_size, hid_t_f* memb_plist) /****if* H5Pf/h5pset_cache_c * NAME - * h5pset_cache_c + * h5pset_cache_c * PURPOSE - * Call H5Pset_cache to set he number of elements in - * the meta data cache and the total number of bytes in - * the raw data chunk cache + * Call H5Pset_cache to set he number of elements in + * the meta data cache and the total number of bytes in + * the raw data chunk cache * INPUTS - * prp_id - property list identifier - * mdc_nelmts - Number of elements (objects) in the - * meta data cache - * rdcc_nbytes - Total size of the raw data chunk cache, in bytes - * rdcc_w0 - Preemption policy + * prp_id - property list identifier + * mdc_nelmts - Number of elements (objects) in the + * meta data cache + * rdcc_nbytes - Total size of the raw data chunk cache, in bytes + * rdcc_w0 - Preemption policy * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Friday, February 25, 2000 + * Friday, February 25, 2000 * HISTORY - * Changed the type of the rdcc_w0 parameter to be real_f EP 7/7/00 - * instead of double + * Changed the type of the rdcc_w0 parameter to be real_f EP 7/7/00 + * instead of double * SOURCE */ int_f @@ -1325,27 +1325,27 @@ h5pset_cache_c(hid_t_f *prp_id, int_f* mdc_nelmts, size_t_f* rdcc_nelmts, size_ /****if* H5Pf/h5pget_cache_c * NAME - * h5pget_cache_c + * h5pget_cache_c * PURPOSE - * Call H5Pget_cache to get he number of elements in - * the meta data cache and the total number of bytes in - * the raw data chunk cache + * Call H5Pget_cache to get he number of elements in + * the meta data cache and the total number of bytes in + * the raw data chunk cache * INPUTS - * prp_id - property list identifier + * prp_id - property list identifier * OUTPUTS - * mdc_nelmts - Number of elements (objects) in the - * meta data cache - * rdcc_nelmts - Number of elements in the raw data chunk - * rdcc_nbytes - Total size of the raw data chunk cache, in bytes - * rdcc_w0 - Preemption policy + * mdc_nelmts - Number of elements (objects) in the + * meta data cache + * rdcc_nelmts - Number of elements in the raw data chunk + * rdcc_nbytes - Total size of the raw data chunk cache, in bytes + * rdcc_w0 - Preemption policy * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Friday, February 25, 2000 + * Friday, February 25, 2000 * HISTORY - * Changed type of the rdcc_w0 parameter to be real_f instead of double - * Changed type of the rdcc_nelmts parameter to be int_f. + * Changed type of the rdcc_w0 parameter to be real_f instead of double + * Changed type of the rdcc_nelmts parameter to be int_f. * EIP October 10, 2003 * SOURCE */ @@ -1377,23 +1377,23 @@ h5pget_cache_c(hid_t_f *prp_id, int_f* mdc_nelmts, size_t_f* rdcc_nelmts, size_t /****if* H5Pf/h5pset_fapl_split_c * NAME - * h5pset_fapl_split_c + * h5pset_fapl_split_c * PURPOSE - * Call H5Pset_fapl_split to set he low-level driver to split meta data - * from raw data + * Call H5Pset_fapl_split to set he low-level driver to split meta data + * from raw data * INPUTS - * prp_id - property list identifier - * meta_len - Length of meta_ext - * meta_ext - Name of the extension for the metafile filename. - * meta_plist - Identifier of the meta file access property list - * raw_len - Length of raw _ext - * raw_ext - Name of the extension for the raw file filename. - * raw_plist - Identifier of the raw file access property list + * prp_id - property list identifier + * meta_len - Length of meta_ext + * meta_ext - Name of the extension for the metafile filename. + * meta_plist - Identifier of the meta file access property list + * raw_len - Length of raw _ext + * raw_ext - Name of the extension for the raw file filename. + * raw_plist - Identifier of the raw file access property list * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * March 9, 2001 + * March 9, 2001 * HISTORY * * SOURCE @@ -1438,26 +1438,26 @@ DONE: #ifdef NO_SUCH_F90_FUNCTION /****if* H5Pf/h5pget_fapl_split_c * NAME - * h5pget_fapl_split_c + * h5pget_fapl_split_c * PURPOSE - * Call H5Pget_fapl_split to determine whether the file access - * property list is set to the split driver + * Call H5Pget_fapl_split to determine whether the file access + * property list is set to the split driver * INPUTS - * prp_id - property list identifier - * meta_ext_size - Number of characters of the meta file extension - * to be copied to the meta_ext buffer - * raw_ext_size - Number of characters of the raw file extension - * to be copied to the raw_ext buffer + * prp_id - property list identifier + * meta_ext_size - Number of characters of the meta file extension + * to be copied to the meta_ext buffer + * raw_ext_size - Number of characters of the raw file extension + * to be copied to the raw_ext buffer *OUTPUT - * meta_ext - Name of the extension for the metafile filename. - * meta_plist - Identifier of the meta file access property list - * raw_ext - Name of the extension for the raw file filename. - * raw_plist - Identifier of the raw file access property list + * meta_ext - Name of the extension for the metafile filename. + * meta_plist - Identifier of the meta file access property list + * raw_ext - Name of the extension for the raw file filename. + * raw_plist - Identifier of the raw file access property list * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * March 9 , 2001 + * March 9 , 2001 * HISTORY * * SOURCE @@ -1501,19 +1501,19 @@ h5pget_fapl_split_c(hid_t_f *prp_id, size_t_f* meta_ext_size , _fcd meta_ext, hi /****if* H5Pf/h5pset_gc_references_c * NAME - * h5pset_gc_references_c + * h5pset_gc_references_c * PURPOSE - * Call H5Pset_gc_references to set garbage - * collecting references flag + * Call H5Pset_gc_references to set garbage + * collecting references flag * INPUTS - * prp_id - property list identifier - * gc_reference - flag for garbage collecting references - * for the file + * prp_id - property list identifier + * gc_reference - flag for garbage collecting references + * for the file * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Friday, February 25, 2000 + * Friday, February 25, 2000 * HISTORY * * SOURCE @@ -1541,19 +1541,19 @@ h5pset_gc_references_c (hid_t_f *prp_id, int_f* gc_references) /****if* H5Pf/h5pget_gc_references_c * NAME - * h5pget_gc_references_c + * h5pget_gc_references_c * PURPOSE - * Call H5Pget_gc_references to set garbage - * collecting references flag + * Call H5Pget_gc_references to set garbage + * collecting references flag * INPUTS - * prp_id - property list identifier - * Outputs gc_reference - flag for garbage collecting references - * for the file + * prp_id - property list identifier + * Outputs gc_reference - flag for garbage collecting references + * for the file * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Friday, February 25, 2000 + * Friday, February 25, 2000 * HISTORY * * SOURCE @@ -1579,18 +1579,18 @@ h5pget_gc_references_c (hid_t_f *prp_id, int_f* gc_references) /****if* H5Pf/h5pset_layout_c * NAME - * h5pset_layout_c + * h5pset_layout_c * PURPOSE - * Call H5Pset_layout to the type of storage used - * store the raw data for a dataset + * Call H5Pset_layout to the type of storage used + * store the raw data for a dataset * INPUTS - * prp_id - property list identifier - * layout - Type of storage layout for raw data. + * prp_id - property list identifier + * layout - Type of storage layout for raw data. * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Friday, February 25, 2000 + * Friday, February 25, 2000 * HISTORY * * SOURCE @@ -1617,19 +1617,19 @@ h5pset_layout_c (hid_t_f *prp_id, int_f* layout) /****if* H5Pf/h5pget_layout_c * NAME - * h5pget_layout_c + * h5pget_layout_c * PURPOSE - * Call H5Pget_layout to the type of storage used - * store the raw data for a dataset + * Call H5Pget_layout to the type of storage used + * store the raw data for a dataset * INPUTS - * prp_id - property list identifier + * prp_id - property list identifier * OUTPUTS - * layout - Type of storage layout for raw data. + * layout - Type of storage layout for raw data. * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Friday, February 25, 2000 + * Friday, February 25, 2000 * HISTORY * * SOURCE @@ -1654,21 +1654,21 @@ h5pget_layout_c (hid_t_f *prp_id, int_f* layout) /****if* H5Pf/h5pset_filter_c * NAME - * h5pset_filter_c + * h5pset_filter_c * PURPOSE - * Call H5Pset_filter to add a filter to the filter pipeline. + * Call H5Pset_filter to add a filter to the filter pipeline. * INPUTS - * prp_id - property list identifier - * filter - Filter to be added to the pipeline. - * flags - Bit vector specifying certain general - * properties of the filter. - * cd_nelmts - Number of elements in cd_values. - * cd_values - Auxiliary data for the filter. + * prp_id - property list identifier + * filter - Filter to be added to the pipeline. + * flags - Bit vector specifying certain general + * properties of the filter. + * cd_nelmts - Number of elements in cd_values. + * cd_values - Auxiliary data for the filter. * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Wednesday, February 23, 2000 + * Wednesday, February 23, 2000 * HISTORY * * SOURCE @@ -1742,26 +1742,26 @@ h5pget_nfilters_c (hid_t_f *prp_id, int_f* nfilters) } /*---------------------------------------------------------------------------- - * Name: h5pget_filter_c - * Purpose: Call H5Pget_filter2 to get information about a filter - * in a pipeline - * Inputs: prp_id - property list identifier - * filter_number - Sequence number within the filter - * pipeline of the filter for which - * information is sought. - * namelen - Anticipated number of characters in name. - *Outputs: flags - Bit vector specifying certain general - * properties of the filter. - * cd_nelmts - Number of elements in cd_value - * cd_values - Auxiliary data for the filter. - * name - Name of the filter - * filter_id - filter identification number - * Returns: 0 on success, -1 on failure - * Programmer: Xiangyang Su - * Friday, February 25, 2000 - * Modifications: - * Since cd_nelmts has IN/OUT attributes, fixed the input and - * returned value of cd_nelmnts to satisfy this specification. + * Name: h5pget_filter_c + * Purpose: Call H5Pget_filter2 to get information about a filter + * in a pipeline + * Inputs: prp_id - property list identifier + * filter_number - Sequence number within the filter + * pipeline of the filter for which + * information is sought. + * namelen - Anticipated number of characters in name. + * Outputs: flags - Bit vector specifying certain general + * properties of the filter. + * cd_nelmts - Number of elements in cd_value + * cd_values - Auxiliary data for the filter. + * name - Name of the filter + * filter_id - filter identification number + * Returns: 0 on success, -1 on failure + * Programmer: Xiangyang Su + * Friday, February 25, 2000 + * Modifications: + * Since cd_nelmts has IN/OUT attributes, fixed the input and + * returned value of cd_nelmnts to satisfy this specification. * MSB January 27, 2009 *---------------------------------------------------------------------------*/ int_f @@ -1819,7 +1819,7 @@ DONE: * name - Name of an external file * namelen - length of name * offset - Offset, in bytes, from the beginning of the file - * to the location in the file where the data starts. + * to the location in the file where the data starts. * bytes - Number of bytes reserved in the file for the data. * RETURNS * 0 on success, -1 on failure @@ -1865,19 +1865,19 @@ DONE: /****if* H5Pf/h5pget_external_count_c * NAME - * h5pget_external_count_c + * h5pget_external_count_c * PURPOSE - * Call H5Pget_external_count to get the number of external - * files for the specified dataset. + * Call H5Pget_external_count to get the number of external + * files for the specified dataset. * INPUTS - * prp_id - property list identifier + * prp_id - property list identifier * OUTPUTS - * count - number of external files + * count - number of external files * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Friday, February 25, 2000 + * Friday, February 25, 2000 * HISTORY * * SOURCE @@ -1906,14 +1906,14 @@ h5pget_external_count_c (hid_t_f *prp_id, int_f* count) * PURPOSE * Call H5Pget_external to get nformation about an external file. * INPUTS - * prp_id - property list identifier - * name_size - length of name - * idx - External file index. + * prp_id - property list identifier + * name_size - length of name + * idx - External file index. * OUTPUT - * name - Name of an external file - * offset - Offset, in bytes, from the beginning of the file - * to the location in the file where the data starts. - * bytes - Number of bytes reserved in the file for the data. + * name - Name of an external file + * offset - Offset, in bytes, from the beginning of the file + * to the location in the file where the data starts. + * bytes - Number of bytes reserved in the file for the data. * RETURNS * on success, -1 on failure * AUTHOR @@ -1969,23 +1969,23 @@ DONE: /****if* H5Pf/h5pset_btree_ratios_c * NAME - * h5pset_btree_ratios_c + * h5pset_btree_ratios_c * PURPOSE - * Call H5Pset_btree_ratios to set B-tree split ratios for B-tree split ratios for a dataset transfer property list. a - * dataset transfer property list. + * Call H5Pset_btree_ratios to set B-tree split ratios for B-tree split ratios for a dataset transfer property list. a + * dataset transfer property list. * INPUTS - * prp_id - property list identifier - * left - The B-tree split ratio for left-most nodes. - * middle - The B-tree split ratio for all other nodes - * right - The B-tree split ratio for right-most nodes - * and lone nodes. + * prp_id - property list identifier + * left - The B-tree split ratio for left-most nodes. + * middle - The B-tree split ratio for all other nodes + * right - The B-tree split ratio for right-most nodes + * and lone nodes. * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Friday, February 25, 2000 + * Friday, February 25, 2000 * HISTORY - * Changed the type of the last three parameters from double to real_f + * Changed the type of the last three parameters from double to real_f * SOURCE */ int_f @@ -2014,23 +2014,23 @@ h5pset_btree_ratios_c(hid_t_f *prp_id, real_f* left, real_f* middle, real_f* rig /****if* H5Pf/h5pget_btree_ratios_c * NAME - * h5pget_btree_ratios_c + * h5pget_btree_ratios_c * PURPOSE - * Call H5Pget_btree_ratios to Gets B-tree split ratios - * for a dataset transfer property list. + * Call H5Pget_btree_ratios to Gets B-tree split ratios + * for a dataset transfer property list. * INPUTS - * prp_id - property list identifier - * left - The B-tree split ratio for left-most nodes. - * middle - The B-tree split ratio for all other nodes - * right - The B-tree split ratio for right-most nodes - * and lone nodes. + * prp_id - property list identifier + * left - The B-tree split ratio for left-most nodes. + * middle - The B-tree split ratio for all other nodes + * right - The B-tree split ratio for right-most nodes + * and lone nodes. * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Friday, February 25, 2000 + * Friday, February 25, 2000 * HISTORY - * Changed the type of the last three parameters from double to real_f + * Changed the type of the last three parameters from double to real_f * SOURCE */ int_f @@ -2056,23 +2056,23 @@ h5pget_btree_ratios_c(hid_t_f *prp_id, real_f* left, real_f* middle, real_f* rig } /****if* H5Pf/h5pget_fclose_degree_c * NAME - * h5pget_fclose_degree_c + * h5pget_fclose_degree_c * PURPOSE - * Call H5Pget_fclose_degree to determine file close behavior + * Call H5Pget_fclose_degree to determine file close behavior * INPUTS - * fapl_id - file access identifier + * fapl_id - file access identifier * OUTPUTS * - * degree - possible values are: + * degree - possible values are: * H5F_CLOSE_DEFAULT * H5F_CLOSE_WEAK * H5F_CLOSE_SEMI * H5F_CLOSE_STRONG * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Thursday, September 26, 2002 + * Thursday, September 26, 2002 * HISTORY * * SOURCE @@ -2096,21 +2096,21 @@ h5pget_fclose_degree_c ( hid_t_f *fapl_id , int_f *degree) /****if* H5Pf/h5pset_fclose_degree_c * NAME - * h5pset_fclose_degree_c + * h5pset_fclose_degree_c * PURPOSE - * Call H5Pset_fclose_degree to set file close behavior + * Call H5Pset_fclose_degree to set file close behavior * INPUTS - * fapl_id - file access identifier - * degree - possible values are: + * fapl_id - file access identifier + * degree - possible values are: * H5F_CLOSE_DEFAULT * H5F_CLOSE_WEAK * H5F_CLOSE_SEMI * H5F_CLOSE_STRONG * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Thursday, September 26, 2002 + * Thursday, September 26, 2002 * HISTORY * * SOURCE @@ -2134,19 +2134,19 @@ h5pset_fclose_degree_c ( hid_t_f *fapl_id , int_f *degree) /****if* H5Pf/h5pset_buffer_c * NAME - * h5pset_buffer_c + * h5pset_buffer_c * PURPOSE - * Call H5Pset_buffer to set size of conversion buffer + * Call H5Pset_buffer to set size of conversion buffer * INPUTS - * prp_id - t`dataset trasfer property list identifier - * size - size of the buffer + * prp_id - t`dataset trasfer property list identifier + * size - size of the buffer * OUTPUTS * NONE * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, October 2, 2002 + * Wednesday, October 2, 2002 * HISTORY * * SOURCE @@ -2168,18 +2168,18 @@ h5pset_buffer_c ( hid_t_f *prp_id , hsize_t_f *size) /****if* H5Pf/h5pget_buffer_c * NAME - * h5pget_buffer_c + * h5pget_buffer_c * PURPOSE - * Call H5Pget_buffer to get size of conversion buffer + * Call H5Pget_buffer to get size of conversion buffer * INPUTS - * prp_id - t`dataset trasfer property list identifier + * prp_id - t`dataset trasfer property list identifier * OUTPUTS - * size - size of conversion buffer + * size - size of conversion buffer * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, October 2, 2002 + * Wednesday, October 2, 2002 * HISTORY * * SOURCE @@ -2202,18 +2202,18 @@ h5pget_buffer_c ( hid_t_f *prp_id , hsize_t_f *size) } /****if* H5Pf/h5pfill_value_defined_c * NAME - * h5pfill_value_defined_c + * h5pfill_value_defined_c * PURPOSE - * Call H5Pfill_value_defined to check if fill value is defined + * Call H5Pfill_value_defined to check if fill value is defined * INPUTS - * prp_id - dataset creation property list identifier + * prp_id - dataset creation property list identifier * OUTPUTS - * flag - fill value status flag + * flag - fill value status flag * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Friday, October 4, 2002 + * Friday, October 4, 2002 * HISTORY * * SOURCE @@ -2235,19 +2235,19 @@ h5pfill_value_defined_c ( hid_t_f *prp_id , int_f *flag) } /****if* H5Pf/h5pget_alloc_time_c * NAME - * h5pget_alloc_time_c + * h5pget_alloc_time_c * PURPOSE - * Call H5Pget_alloc_time to get space allocation - * time for dataset during creation + * Call H5Pget_alloc_time to get space allocation + * time for dataset during creation * INPUTS - * prp_id - dataset creation property list identifier + * prp_id - dataset creation property list identifier * OUTPUTS - * flag - allocation time flag + * flag - allocation time flag * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Friday, October 4, 2002 + * Friday, October 4, 2002 * HISTORY * * SOURCE @@ -2269,18 +2269,18 @@ h5pget_alloc_time_c ( hid_t_f *prp_id , int_f *flag) } /****if* H5Pf/h5pset_alloc_time_c * NAME - * h5pset_alloc_time_c + * h5pset_alloc_time_c * PURPOSE - * Call H5Pset_alloc_time to get space allocation - * time for dataset during creation + * Call H5Pset_alloc_time to get space allocation + * time for dataset during creation * INPUTS - * prp_id - dataset creation property list identifier - * flag - allocation time flag + * prp_id - dataset creation property list identifier + * flag - allocation time flag * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Friday, October 4, 2002 + * Friday, October 4, 2002 * HISTORY * * SOURCE @@ -2302,19 +2302,19 @@ h5pset_alloc_time_c ( hid_t_f *prp_id , int_f *flag) } /****if* H5Pf/h5pget_fill_time_c * NAME - * h5pget_fill_time_c + * h5pget_fill_time_c * PURPOSE - * Call H5Pget_fill_time to get fill value writing - * time for dataset during creation + * Call H5Pget_fill_time to get fill value writing + * time for dataset during creation * INPUTS - * prp_id - dataset creation property list identifier + * prp_id - dataset creation property list identifier * OUTPUTS - * flag - fill value writing time flag + * flag - fill value writing time flag * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Friday, October 4, 2002 + * Friday, October 4, 2002 * HISTORY * * SOURCE @@ -2336,18 +2336,18 @@ h5pget_fill_time_c ( hid_t_f *prp_id , int_f *flag) } /****if* H5Pf/h5pset_fill_time_c * NAME - * h5pset_fill_time_c + * h5pset_fill_time_c * PURPOSE - * Call H5Pset_fill_time to set fill value writing - * time for dataset during creation + * Call H5Pset_fill_time to set fill value writing + * time for dataset during creation * INPUTS - * prp_id - dataset creation property list identifier - * flag - fill value writing time flag + * prp_id - dataset creation property list identifier + * flag - fill value writing time flag * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Friday, October 4, 2002 + * Friday, October 4, 2002 * HISTORY * * SOURCE @@ -2369,19 +2369,19 @@ h5pset_fill_time_c ( hid_t_f *prp_id , int_f *flag) } /****if* H5Pf/h5pset_meta_block_size_c * NAME - * h5pset_meta_block_size_c + * h5pset_meta_block_size_c * PURPOSE - * Call H5Pset_meta_block_size to set size of metadata block + * Call H5Pset_meta_block_size to set size of metadata block * INPUTS - * prp_id - file access property list identifier - * size - size of the metadata block + * prp_id - file access property list identifier + * size - size of the metadata block * OUTPUTS * NONE * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Monday, October 7, 2002 + * Monday, October 7, 2002 * HISTORY * * SOURCE @@ -2402,19 +2402,19 @@ h5pset_meta_block_size_c ( hid_t_f *prp_id , hsize_t_f *size) } /****if* H5Pf/h5pget_meta_block_size_c * NAME - * h5pget_meta_block_size_c + * h5pget_meta_block_size_c * PURPOSE - * Call H5Pget_meta_block_size to get size of metadata block + * Call H5Pget_meta_block_size to get size of metadata block * INPUTS - * prp_id - file access property list identifier + * prp_id - file access property list identifier * OUTPUTS * - * size - size of the metadata block + * size - size of the metadata block * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Monday, October 7, 2002 + * Monday, October 7, 2002 * HISTORY * * SOURCE @@ -2435,19 +2435,19 @@ h5pget_meta_block_size_c ( hid_t_f *prp_id , hsize_t_f *size) } /****if* H5Pf/h5pset_sieve_buf_size_c * NAME - * h5pset_sieve_buf_size_c + * h5pset_sieve_buf_size_c * PURPOSE - * Call H5Pset_sieve_buf_size to set size of datasieve buffer + * Call H5Pset_sieve_buf_size to set size of datasieve buffer * INPUTS - * prp_id - file access property list identifier - * size - size of the buffer + * prp_id - file access property list identifier + * size - size of the buffer * OUTPUTS * NONE * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Monday, October 7, 2002 + * Monday, October 7, 2002 * HISTORY * * SOURCE @@ -2468,19 +2468,19 @@ h5pset_sieve_buf_size_c ( hid_t_f *prp_id , size_t_f *size) } /****if* H5Pf/h5pget_sieve_buf_size_c * NAME - * h5pget_sieve_buf_size_c + * h5pget_sieve_buf_size_c * PURPOSE - * Call H5Pget_sieve_buf_size to get size of datasieve buffer + * Call H5Pget_sieve_buf_size to get size of datasieve buffer * INPUTS - * prp_id - file access property list identifier + * prp_id - file access property list identifier * OUTPUTS * - * size - size of the buffer + * size - size of the buffer * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Monday, October 7, 2002 + * Monday, October 7, 2002 * HISTORY * * SOURCE @@ -2501,19 +2501,19 @@ h5pget_sieve_buf_size_c ( hid_t_f *prp_id , size_t_f *size) } /****if* H5Pf/h5pset_small_data_block_size_c * NAME - * h5pset_small_data_block_size_c + * h5pset_small_data_block_size_c * PURPOSE - * Call H5Pset_small_data_block_size to set size of raw small data block + * Call H5Pset_small_data_block_size to set size of raw small data block * INPUTS - * prp_id - file access property list identifier - * size - size of the block + * prp_id - file access property list identifier + * size - size of the block * OUTPUTS * NONE * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Monday, October 7, 2002 + * Monday, October 7, 2002 * HISTORY * * SOURCE @@ -2534,19 +2534,19 @@ h5pset_small_data_block_size_c ( hid_t_f *prp_id , hsize_t_f *size) } /****if* H5Pf/h5pget_small_data_block_size_c * NAME - * h5pget_small_data_block_size_c + * h5pget_small_data_block_size_c * PURPOSE - * Call H5Pget_small_data_block_size to get size of raw small data block + * Call H5Pget_small_data_block_size to get size of raw small data block * INPUTS - * prp_id - file access property list identifier + * prp_id - file access property list identifier * OUTPUTS * - * size - size of the block + * size - size of the block * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Monday, October 7, 2002 + * Monday, October 7, 2002 * HISTORY * * SOURCE @@ -2567,19 +2567,19 @@ h5pget_small_data_block_size_c ( hid_t_f *prp_id , hsize_t_f *size) } /****if* H5Pf/h5pset_hyper_vector_size_c * NAME - * h5pset_hyper_vector_size_c + * h5pset_hyper_vector_size_c * PURPOSE - * Call H5Pset_hyper_vector_size to set size of the hyper vector + * Call H5Pset_hyper_vector_size to set size of the hyper vector * INPUTS - * prp_id - dataset transfer property list identifier - * size - size of the vector + * prp_id - dataset transfer property list identifier + * size - size of the vector * OUTPUTS * NONE * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Monday, October 7, 2002 + * Monday, October 7, 2002 * HISTORY * * SOURCE @@ -2600,19 +2600,19 @@ h5pset_hyper_vector_size_c ( hid_t_f *prp_id , size_t_f *size) } /****if* H5Pf/h5pget_hyper_vector_size_c * NAME - * h5pget_hyper_vector_size_c + * h5pget_hyper_vector_size_c * PURPOSE - * Call H5Pget_hyper_vector_size to get size of the hyper vector + * Call H5Pget_hyper_vector_size to get size of the hyper vector * INPUTS - * prp_id - dataset transfer property list identifier + * prp_id - dataset transfer property list identifier * OUTPUTS * - * size - size of the vector + * size - size of the vector * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Monday, October 7, 2002 + * Monday, October 7, 2002 * HISTORY * * SOURCE @@ -2800,19 +2800,19 @@ DONE: /****if* H5Pf/h5pexist_c * NAME - * h5pexist_c + * h5pexist_c * PURPOSE - * Call H5Pexist to querie whether a property name exists - * in a property list or class + * Call H5Pexist to querie whether a property name exists + * in a property list or class * INPUTS - * plist - property list or property class identifier - * name - name of the new property - * name_len - length of the "name" buffer + * plist - property list or property class identifier + * name - name of the new property + * name_len - length of the "name" buffer * RETURNS - * nonnegative on success, -1 on failure + * nonnegative on success, -1 on failure * AUTHOR * Elena Pourmal - * October 11, 2002 + * October 11, 2002 * HISTORY * * SOURCE @@ -2842,18 +2842,18 @@ DONE: } /****if* H5Pf/h5pisa_class_c * NAME - * h5pisa_class_c + * h5pisa_class_c * PURPOSE - * Call H5Pisa_class to querie whether a property is a - * member of a class + * Call H5Pisa_class to querie whether a property is a + * member of a class * INPUTS - * plist - property list identifier - * cls - property class identifier + * plist - property list identifier + * cls - property class identifier * RETURNS - * nonnegative on success, -1 on failure + * nonnegative on success, -1 on failure * AUTHOR * Elena Pourmal - * October 11, 2002 + * October 11, 2002 * HISTORY * * SOURCE @@ -2879,20 +2879,20 @@ h5pisa_class_c(hid_t_f *plist, hid_t_f *cls) } /****if* H5Pf/h5pget_size_c * NAME - * h5pget_size_c + * h5pget_size_c * PURPOSE - * Call H5Pget_size to querie the size of the property + * Call H5Pget_size to querie the size of the property * INPUTS - * plist - property list to query - * name - name of the property - * name_len - length of the "name" buffer + * plist - property list to query + * name - name of the property + * name_len - length of the "name" buffer * OUTPUTS - * size - size of the property in bytes + * size - size of the property in bytes * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * October 11, 2002 + * October 11, 2002 * HISTORY * * SOURCE @@ -2923,18 +2923,18 @@ DONE: } /****if* H5Pf/h5pget_nprops_c * NAME - * h5pget_nprops_c + * h5pget_nprops_c * PURPOSE - * Call H5Pget_nporps to get number of the properties in the list + * Call H5Pget_nporps to get number of the properties in the list * INPUTS - * plist - property list to query + * plist - property list to query * OUTPUTS - * nprops - number of properties in the list + * nprops - number of properties in the list * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * October 11, 2002 + * October 11, 2002 * HISTORY * * SOURCE @@ -2960,19 +2960,19 @@ h5pget_nprops_c(hid_t_f *plist, size_t_f *nprops) } /****if* H5Pf/h5pget_class_parent_c * NAME - * h5pget_class_parent_c + * h5pget_class_parent_c * PURPOSE - * Call H5Pget_class_parent to get the parent class of - * a genereic property class + * Call H5Pget_class_parent to get the parent class of + * a genereic property class * INPUTS - * prp_id - property list to query + * prp_id - property list to query * OUTPUTS - * parent_id - parent classs identifier + * parent_id - parent classs identifier * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * October 11, 2002 + * October 11, 2002 * HISTORY * * SOURCE @@ -2999,20 +2999,20 @@ h5pget_class_parent_c(hid_t_f *prp_id, hid_t_f *parent_id) } /****if* H5Pf/h5pcopy_prop_c * NAME - * h5pcopy_prop_c + * h5pcopy_prop_c * PURPOSE - * Call H5Pcopy_prop to copy a property from one list or - * class to another + * Call H5Pcopy_prop to copy a property from one list or + * class to another * INPUTS - * dst_id - identifier of destination property list - * src_id - identifier of source property list - * name - name of the property - * name_len - length of the "name" buffer + * dst_id - identifier of destination property list + * src_id - identifier of source property list + * name - name of the property + * name_len - length of the "name" buffer * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * October 11, 2002 + * October 11, 2002 * HISTORY * * SOURCE @@ -3042,18 +3042,18 @@ DONE: } /****if* H5Pf/h5premove_c * NAME - * h5premove_c + * h5premove_c * PURPOSE - * Call H5Premove to remove a property from a list + * Call H5Premove to remove a property from a list * INPUTS - * plid - identifier of property list - * name - name of the property to remove - * name_len - length of the "name" buffer + * plid - identifier of property list + * name - name of the property to remove + * name_len - length of the "name" buffer * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * October 11, 2002 + * October 11, 2002 * HISTORY * * SOURCE @@ -3082,15 +3082,15 @@ DONE: } /****if* H5Pf/h5punregister_c * NAME - * h5punregister_c + * h5punregister_c * PURPOSE - * Call H5Punregister to remove a property from a property class + * Call H5Punregister to remove a property from a property class * INPUTS - * cls - identifier of property class - * name - name of the property to unregister - * name_len - length of the "name" buffer + * cls - identifier of property class + * name - name of the property to unregister + * name_len - length of the "name" buffer * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal * October 11, 2002 @@ -3122,13 +3122,13 @@ DONE: } /****if* H5Pf/h5pclose_class_c * NAME - * h5pclose_class_c + * h5pclose_class_c * PURPOSE - * Call H5Pclose_class to close property class + * Call H5Pclose_class to close property class * INPUTS - * class - identifier of property class to close + * class - identifier of property class to close * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal * October 11, 2002 @@ -3154,15 +3154,15 @@ h5pclose_class_c(hid_t_f *cls) /****if* H5Pf/h5pget_class_name_c * NAME - * h5pget_class_name_c + * h5pget_class_name_c * PURPOSE - * Call H5Pget_class_name to get property class name + * Call H5Pget_class_name to get property class name * INPUTS - * cls - identifier of property class - * name - buffer to retrieve name in - * name_len - length of the "name" buffer + * cls - identifier of property class + * name - buffer to retrieve name in + * name_len - length of the "name" buffer * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal * October 11, 2002 @@ -3243,7 +3243,7 @@ DONE: * plist - property list class identifier * name - name of the new property * name_len - length of the "name" buffer - * Output: + * Output: * value - property value * RETURNS * 0 on success, -1 on failure @@ -3277,17 +3277,17 @@ DONE: /****if* H5Pf/h5pset_shuffle_c * NAME - * h5pset_shuffle_c + * h5pset_shuffle_c * PURPOSE - * Call H5Pset_shuffle + * Call H5Pset_shuffle * INPUTS - * prp_id - property list identifier - * type_size - size of the datatype in bytes + * prp_id - property list identifier + * type_size - size of the datatype in bytes * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, March 12, 2003 + * Wednesday, March 12, 2003 * HISTORY * * SOURCE @@ -3308,16 +3308,16 @@ h5pset_shuffle_c ( hid_t_f *prp_id ) } /****if* H5Pf/h5pset_fletcher32_c * NAME - * h5pset_fletcher32_c + * h5pset_fletcher32_c * PURPOSE - * Call H5Pset_fletcher32 to enable EDC + * Call H5Pset_fletcher32 to enable EDC * INPUTS - * prp_id - dataset creation property list identifier + * prp_id - dataset creation property list identifier * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Thursday, March 13, 2003 + * Thursday, March 13, 2003 * HISTORY * * SOURCE @@ -3339,17 +3339,17 @@ h5pset_fletcher32_c ( hid_t_f *prp_id ) /****if* H5Pf/h5pset_edc_check_c * NAME - * h5pset_edc_check_c + * h5pset_edc_check_c * PURPOSE - * Call H5Pset_edc_check to enable EDC + * Call H5Pset_edc_check to enable EDC * INPUTS - * prp_id - dataset transfer property list identifier - * flag - EDC flag + * prp_id - dataset transfer property list identifier + * flag - EDC flag * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Thursday, March 13, 2003 + * Thursday, March 13, 2003 * HISTORY * * SOURCE @@ -3373,17 +3373,17 @@ h5pset_edc_check_c ( hid_t_f *prp_id, int_f *flag ) /****if* H5Pf/h5pget_edc_check_c * NAME - * h5pget_edc_check_c + * h5pget_edc_check_c * PURPOSE - * Call H5Pget_edc_check to query EDC + * Call H5Pget_edc_check to query EDC * INPUTS - * prp_id - dataset transfer property list identifier - * Outouts: flag - EDC flag + * prp_id - dataset transfer property list identifier + * Outouts: flag - EDC flag * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Thursday, March 13, 2003 + * Thursday, March 13, 2003 * HISTORY * * SOURCE @@ -3405,17 +3405,17 @@ h5pget_edc_check_c ( hid_t_f *prp_id, int_f *flag ) } /****if* H5Pf/h5pset_family_offset_c * NAME - * h5pset_family_offset_c + * h5pset_family_offset_c * PURPOSE - * Call H5Pset_family_offset to set and offset for family driver + * Call H5Pset_family_offset to set and offset for family driver * INPUTS - * prp_id - property list identifier - * offset - offset in bytes + * prp_id - property list identifier + * offset - offset in bytes * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, 19 March 2003 + * Wednesday, 19 March 2003 * HISTORY * * SOURCE @@ -3439,22 +3439,22 @@ h5pset_family_offset_c ( hid_t_f *prp_id , hsize_t_f *offset) /****if* H5Pf/h5pset_fapl_multi_c * NAME - * h5pset_fapl_multi_c + * h5pset_fapl_multi_c * PURPOSE - * Call H5Pset_fapl_multi to set multi file dirver + * Call H5Pset_fapl_multi to set multi file dirver * INPUTS - * prp_id - file_creation property list identifier - * mem_map - memory mapping array - * memb_fapl - property list for each memory usage type - * memb_name - array with members names - * len - array with the lenght of each name - * lenmax - lenght of the name a sdeclared in Fortran - * flag - flag allowing partila access when one of the files is missing + * prp_id - file_creation property list identifier + * mem_map - memory mapping array + * memb_fapl - property list for each memory usage type + * memb_name - array with members names + * len - array with the lenght of each name + * lenmax - lenght of the name a sdeclared in Fortran + * flag - flag allowing partila access when one of the files is missing * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Monday 24, March 2003 + * Monday 24, March 2003 * HISTORY * * SOURCE @@ -3480,13 +3480,13 @@ h5pset_fapl_multi_c ( hid_t_f *prp_id , int_f *memb_map, hid_t_f *memb_fapl, _fc c_lenmax = (int)*lenmax; relax = (hbool_t)*flag; /* - * Check that we got correct values from Fortran for memb_addr array + * Check that we got correct values from Fortran for memb_addr array */ for (i=0; i < H5FD_MEM_NTYPES; i++) { if(memb_addr[i] >= 1.0f) return ret_value; } /* - * Take care of names array + * Take care of names array */ tmp = (char *)HD5f2cstring(memb_name, (size_t)c_lenmax*(H5FD_MEM_NTYPES)); @@ -3500,7 +3500,7 @@ h5pset_fapl_multi_c ( hid_t_f *prp_id , int_f *memb_map, hid_t_f *memb_fapl, _fc tmp_p = tmp_p + c_lenmax; } /* - * Take care of othe arguments + * Take care of othe arguments */ tmp_max_addr = (long double)(HADDR_MAX); c_prp_id = (hid_t)*prp_id; @@ -3511,7 +3511,7 @@ h5pset_fapl_multi_c ( hid_t_f *prp_id , int_f *memb_map, hid_t_f *memb_fapl, _fc else c_memb_addr[i] = (haddr_t)(((float)memb_addr[i])*(tmp_max_addr)); } /* - * Call H5Pset_fapl_multi function + * Call H5Pset_fapl_multi function */ status = H5Pset_fapl_multi(c_prp_id, c_memb_map, c_memb_fapl, (const char * const *)c_memb_name, c_memb_addr, relax); @@ -3527,16 +3527,16 @@ DONE: /****if* H5Pf/h5pset_fapl_multi_sc * NAME - * h5pset_fapl_multi_sc + * h5pset_fapl_multi_sc * PURPOSE - * Call H5Pset_fapl_multi to set multi file dirver + * Call H5Pset_fapl_multi to set multi file dirver * INPUTS - * prp_id - file_creation property list identifier + * prp_id - file_creation property list identifier * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * March 31 2003 + * March 31 2003 * HISTORY * * SOURCE @@ -3554,7 +3554,7 @@ h5pset_fapl_multi_sc ( hid_t_f *prp_id , int_f *flag) relax = (hbool_t)*flag; c_prp_id = (hid_t)*prp_id; /* - * Call H5Pset_fapl_multi function + * Call H5Pset_fapl_multi function */ status = H5Pset_fapl_multi(c_prp_id, NULL, NULL, NULL, NULL, relax); @@ -3564,23 +3564,23 @@ h5pset_fapl_multi_sc ( hid_t_f *prp_id , int_f *flag) } /****if* H5Pf/h5pget_fapl_multi_c * NAME - * h5pget_fapl_multi_c + * h5pget_fapl_multi_c * PURPOSE - * Call H5Pget_fapl_multi to set multi file dirver + * Call H5Pget_fapl_multi to set multi file dirver * INPUTS - * prp_id - file_creation property list identifier - * lenmax - lenght of the name a sdeclared in Fortran + * prp_id - file_creation property list identifier + * lenmax - lenght of the name a sdeclared in Fortran * OUTPUTS - * memb_map - memory mapping array - * memb_fapl - property list for each memory usage type - * memb_name - array with members names - * len - array with the lenght of each name - * flag - flag allowing partila access when one of the files is missing + * memb_map - memory mapping array + * memb_fapl - property list for each memory usage type + * memb_name - array with members names + * len - array with the lenght of each name + * flag - flag allowing partila access when one of the files is missing * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Monday 24, March 2003 + * Monday 24, March 2003 * HISTORY * * SOURCE @@ -3606,14 +3606,14 @@ h5pget_fapl_multi_c ( hid_t_f *prp_id , int_f *memb_map, hid_t_f *memb_fapl, _fc c_prp_id = (hid_t)*prp_id; /* - * Call H5Pget_fapl_multi function + * Call H5Pget_fapl_multi function */ status = H5Pget_fapl_multi(c_prp_id, c_memb_map, c_memb_fapl, c_memb_name, c_memb_addr, &relax); if ( status < 0 ) return ret_value; /* - * Take care of names array + * Take care of names array */ tmp = (char *)HDmalloc(c_lenmax*H5FD_MEM_NTYPES + 1); tmp_p = tmp; @@ -3628,7 +3628,7 @@ h5pget_fapl_multi_c ( hid_t_f *prp_id , int_f *memb_map, hid_t_f *memb_fapl, _fc HD5packFstring(tmp, _fcdtocp(memb_name), (size_t)(c_lenmax*H5FD_MEM_NTYPES)); /* - * Take care of other arguments + * Take care of other arguments */ for (i=0; i < H5FD_MEM_NTYPES; i++) { @@ -3648,18 +3648,18 @@ HD5packFstring(tmp, _fcdtocp(memb_name), (size_t)(c_lenmax*H5FD_MEM_NTYPES)); /****if* H5Pf/h5pset_szip_c * NAME - * h5pset_szip_c + * h5pset_szip_c * PURPOSE - * Call H5Pset_szip to set szip compression + * Call H5Pset_szip to set szip compression * INPUTS - * prp_id - dataset creation property list identifier - * options_mask - * pixels_per_block -szip compression parameters + * prp_id - dataset creation property list identifier + * options_mask + * pixels_per_block -szip compression parameters * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * April 8 2003 + * April 8 2003 * HISTORY * * SOURCE @@ -3679,7 +3679,7 @@ h5pset_szip_c ( hid_t_f *prp_id , int_f *options_mask, int_f *pixels_per_block) c_options_mask = (unsigned)*options_mask; c_pixels_per_block = (unsigned)*pixels_per_block; /* - * Call H5Pset_szip function + * Call H5Pset_szip function */ status = H5Pset_szip(c_prp_id, c_options_mask, c_pixels_per_block); @@ -3689,18 +3689,18 @@ h5pset_szip_c ( hid_t_f *prp_id , int_f *options_mask, int_f *pixels_per_block) } /****if* H5Pf/h5pall_filters_avail_c * NAME - * h5pall_filters_avail_c + * h5pall_filters_avail_c * PURPOSE - * Call H5Pall_filters_avail + * Call H5Pall_filters_avail * INPUTS - * prp_id - dataset creation property list identifier + * prp_id - dataset creation property list identifier * OUTPUTS - * status - logical flag + * status - logical flag * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * April 10 2003 + * April 10 2003 * HISTORY * * SOURCE @@ -3717,7 +3717,7 @@ h5pall_filters_avail_c ( hid_t_f *prp_id , int_f *status) c_prp_id = (hid_t)*prp_id; /* - * Call H5Pall_filters_avail function + * Call H5Pall_filters_avail function */ c_status = H5Pall_filters_avail(c_prp_id); @@ -3730,25 +3730,25 @@ h5pall_filters_avail_c ( hid_t_f *prp_id , int_f *status) /****if* H5Pf/h5pget_filter_by_id_c * NAME - * h5pget_filter_by_id_c + * h5pget_filter_by_id_c * PURPOSE - * Call H5Pget_filter_by_id2 to get information about a filter - * in a pipeline + * Call H5Pget_filter_by_id2 to get information about a filter + * in a pipeline * INPUTS - * prp_id - property list identifier - * filter_id - filter id - * namelen - Anticipated number of characters in name. + * prp_id - property list identifier + * filter_id - filter id + * namelen - Anticipated number of characters in name. *OUTPUT - * flags - Bit vector specifying certain general - * properties of the filter. - * cd_nelmts - Number of elements in cd_value - * cd_values - Auxiliary data for the filter. - * name - Name of the filter + * flags - Bit vector specifying certain general + * properties of the filter. + * cd_nelmts - Number of elements in cd_value + * cd_values - Auxiliary data for the filter. + * name - Name of the filter * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena POurmal - * April 10, 2003 + * April 10, 2003 * HISTORY * * SOURCE @@ -3797,21 +3797,21 @@ DONE: /****if* H5Pf/h5pmodify_filter_c * NAME - * h5pmodify_filter_c + * h5pmodify_filter_c * PURPOSE - * Call H5Pmodify_filter to modify a filter + * Call H5Pmodify_filter to modify a filter * INPUTS - * prp_id - property list identifier - * filter - Filter to be modified - * flags - Bit vector specifying certain general - * properties of the filter. - * cd_nelmts - Number of elements in cd_values. - * cd_values - Auxiliary data for the filter. + * prp_id - property list identifier + * filter - Filter to be modified + * flags - Bit vector specifying certain general + * properties of the filter. + * cd_nelmts - Number of elements in cd_values. + * cd_values - Auxiliary data for the filter. * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * April 10 2003 + * April 10 2003 * HISTORY * * SOURCE @@ -3849,17 +3849,17 @@ DONE: /****if* H5Pf/h5premove_filter_c * NAME - * h5premove_filter_c + * h5premove_filter_c * PURPOSE - * Call H5Premove_filter to delete one or more filters + * Call H5Premove_filter to delete one or more filters * INPUTS - * prp_id - property list identifier - * filter - Filter to be deleted + * prp_id - property list identifier + * filter - Filter to be deleted * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Quincey Koziol - * January 27 2004 + * January 27 2004 * HISTORY * * SOURCE @@ -3887,19 +3887,19 @@ DONE: /****if* H5Pf/h5pget_attr_phase_change_c * NAME - * h5pget_attr_phase_change_c + * h5pget_attr_phase_change_c * PURPOSE - * Calls H5Pget_attr_phase_change + * Calls H5Pget_attr_phase_change * * INPUTS - * ocpl_id - Object (dataset or group) creation property list identifier - * Outputs max_compact - Maximum number of attributes to be stored in compact storage - * min_dense - Minimum number of attributes to be stored in dense storage + * ocpl_id - Object (dataset or group) creation property list identifier + * Outputs max_compact - Maximum number of attributes to be stored in compact storage + * min_dense - Minimum number of attributes to be stored in dense storage * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * January, 2008 + * January, 2008 * HISTORY * * SOURCE @@ -3928,18 +3928,18 @@ h5pget_attr_phase_change_c(hid_t_f *ocpl_id, int_f *max_compact, int_f *min_dens /****if* H5Pf/h5pset_attr_creation_order_c * NAME - * h5pset_attr_creation_order_c + * h5pset_attr_creation_order_c * PURPOSE - * Calls H5Ppset_attr_creation_order + * Calls H5Ppset_attr_creation_order * * INPUTS - * ocpl_id - Object (dataset or group) creation property list identifier - * Outputs crt_order_flags - Flags specifying whether to track and index attribute creation order + * ocpl_id - Object (dataset or group) creation property list identifier + * Outputs crt_order_flags - Flags specifying whether to track and index attribute creation order * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * January, 2008 + * January, 2008 * HISTORY * * SOURCE @@ -3965,23 +3965,23 @@ h5pset_attr_creation_order_c(hid_t_f *ocpl_id, int_f *crt_order_flags ) /****if* H5Pf/h5pset_shared_mesg_nindexes_c * NAME - * h5pset_shared_mesg_nindexes_c + * h5pset_shared_mesg_nindexes_c * PURPOSE - * Calls h5pset_shared_mesg_nindexes + * Calls h5pset_shared_mesg_nindexes * * INPUTS * - * plist_id - file creation property list - * nindexes - Number of shared object header message indexes - * available in files created WITH this property list + * plist_id - file creation property list + * nindexes - Number of shared object header message indexes + * available in files created WITH this property list * * OUTPUTS * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * January, 2008 + * January, 2008 * HISTORY * * SOURCE @@ -4008,24 +4008,24 @@ h5pset_shared_mesg_nindexes_c(hid_t_f *plist_id, int_f *nindexes ) /****if* H5Pf/h5pset_shared_mesg_index_c * NAME - * h5pset_shared_mesg_index_c + * h5pset_shared_mesg_index_c * PURPOSE - * Calls H5Pset_shared_mesg_index + * Calls H5Pset_shared_mesg_index * * INPUTS * - * fcpl_id - File creation property list identifier. - * index_num - Index being configured. - * mesg_type_flags - Types of messages that should be stored in this index. - * min_mesg_size - Minimum message size. + * fcpl_id - File creation property list identifier. + * index_num - Index being configured. + * mesg_type_flags - Types of messages that should be stored in this index. + * min_mesg_size - Minimum message size. * * OUTPUTS * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * January, 2008 + * January, 2008 * HISTORY * * SOURCE @@ -4048,22 +4048,22 @@ h5pset_shared_mesg_index_c(hid_t_f *fcpl_id, int_f *index_num, int_f *mesg_type_ /****if* H5Pf/h5pget_attr_creation_order_c * NAME - * h5pget_attr_creation_order_c + * h5pget_attr_creation_order_c * PURPOSE - * Calls H5Pget_attr_creation_order + * Calls H5Pget_attr_creation_order * * INPUTS * - * ocpl_id - Object (group or dataset) creation property list identifier + * ocpl_id - Object (group or dataset) creation property list identifier * OUTPUTS * - * crt_order_flags - Flags specifying whether to track and index attribute creation order + * crt_order_flags - Flags specifying whether to track and index attribute creation order * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * February, 2008 + * February, 2008 * HISTORY * * SOURCE @@ -4090,23 +4090,23 @@ h5pget_attr_creation_order_c(hid_t_f *ocpl_id, int_f *crt_order_flags) } /****if* H5Pf/h5pset_libver_bounds_c * NAME - * h5pset_libver_bounds_c + * h5pset_libver_bounds_c * PURPOSE - * Calls H5Pset_libver_bounds + * Calls H5Pset_libver_bounds * * INPUTS * - * fapl_id - File access property list identifier - * low - The earliest version of the library that will be used for writing objects. - * high - The latest version of the library that will be used for writing objects. + * fapl_id - File access property list identifier + * low - The earliest version of the library that will be used for writing objects. + * high - The latest version of the library that will be used for writing objects. * OUTPUTS * * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * February 18, 2008 + * February 18, 2008 * HISTORY * * SOURCE @@ -4130,20 +4130,20 @@ h5pset_libver_bounds_c(hid_t_f *fapl_id, int_f *low, int_f *high ) /****if* H5Pf/h5pset_link_creation_order_c * NAME - * h5pset_link_creation_order_c + * h5pset_link_creation_order_c * PURPOSE - * Calls H5Pset_link_creation_order + * Calls H5Pset_link_creation_order * * INPUTS - * gcpl_id - Group creation property list identifier - * crt_order_flags - Creation order flag(s) + * gcpl_id - Group creation property list identifier + * crt_order_flags - Creation order flag(s) * OUTPUTS * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * February 18, 2008 + * February 18, 2008 * HISTORY * * SOURCE @@ -4166,19 +4166,19 @@ h5pset_link_creation_order_c(hid_t_f *gcpl_id, int_f *crt_order_flags ) /****if* H5Pf/h5pget_link_phase_change_c * NAME - * h5pget_link_phase_change_c + * h5pget_link_phase_change_c * PURPOSE - * Calls H5Pget_link_phase_change + * Calls H5Pget_link_phase_change * * INPUTS - * gcpl_id - Group creation property list identifier - * Outputs max_compact - Maximum number of attributes to be stored in compact storage - * min_dense - Minimum number of attributes to be stored in dense storage + * gcpl_id - Group creation property list identifier + * Outputs max_compact - Maximum number of attributes to be stored in compact storage + * min_dense - Minimum number of attributes to be stored in dense storage * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * February 20, 2008 + * February 20, 2008 * HISTORY * * SOURCE @@ -4206,20 +4206,20 @@ h5pget_link_phase_change_c(hid_t_f *gcpl_id, int_f *max_compact, int_f *min_dens /****if* H5Pf/h5pget_obj_track_times_c * NAME - * h5pget_obj_track_times_c + * h5pget_obj_track_times_c * PURPOSE - * Call H5Pget_obj_track_times + * Call H5Pget_obj_track_times * * INPUTS - * plist_id - property list id + * plist_id - property list id * OUTPUTS * - * flag - TRUE/FALSE flag + * flag - TRUE/FALSE flag * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * February 22, 2008 + * February 22, 2008 * HISTORY * * SOURCE @@ -4248,18 +4248,18 @@ h5pget_obj_track_times_c(hid_t_f *plist_id, int_f *flag) /****if* H5Pf/h5pset_obj_track_times_c * NAME - * h5pset_obj_track_times_c + * h5pset_obj_track_times_c * PURPOSE - * Call H5Pset_obj_track_times + * Call H5Pset_obj_track_times * * INPUTS - * plist_id - property list id - * flag - TRUE/FALSE flag + * plist_id - property list id + * flag - TRUE/FALSE flag * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * February 22, 2008 + * February 22, 2008 * HISTORY * * SOURCE @@ -4288,21 +4288,21 @@ h5pset_obj_track_times_c(hid_t_f *plist_id, int_f *flag) /****if* H5Pf/h5pset_create_inter_group_c * NAME - * h5pset_create_inter_group_c + * h5pset_create_inter_group_c * PURPOSE - * Calls H5Pset_create_intermediate_group + * Calls H5Pset_create_intermediate_group * * INPUTS * * lcpl_id - Link creation property list identifier - * crt_intermed_group - crt_intermed_group specifying whether - * to create intermediate groups upon the - * creation of an object + * crt_intermed_group - crt_intermed_group specifying whether + * to create intermediate groups upon the + * creation of an object * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * February 22, 2008 + * February 22, 2008 * HISTORY * * SOURCE @@ -4327,22 +4327,22 @@ h5pset_create_inter_group_c(hid_t_f *lcpl_id, int_f *crt_intermed_group) /****if* H5Pf/h5pget_link_creation_order_c * NAME - * h5pget_link_creation_order_c + * h5pget_link_creation_order_c * PURPOSE - * Calls H5Pget_link_creation_order + * Calls H5Pget_link_creation_order * * INPUTS * - * gcpl_id - Group creation property list identifier + * gcpl_id - Group creation property list identifier * OUTPUTS * - * crt_order_flags - Creation order flag(s) + * crt_order_flags - Creation order flag(s) * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * March 3, 2008 + * March 3, 2008 * HISTORY * * SOURCE @@ -4370,24 +4370,24 @@ h5pget_link_creation_order_c(hid_t_f *gcpl_id, int_f *crt_order_flags) /****if* H5Pf/h5pset_char_encoding_c * NAME - * h5pset_char_encoding_c + * h5pset_char_encoding_c * PURPOSE * Calls H5Pset_char_encoding * * INPUTS * - * plist_id - Property list identifier - * encoding - String encoding character set: + * plist_id - Property list identifier + * encoding - String encoding character set: * H5T_CSET_ASCII_F -> US ASCII * H5T_CSET_UTF8_F -> UTF-8 Unicode encoding * OUTPUTS * NONE * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * March 3, 2008 + * March 3, 2008 * HISTORY * * SOURCE @@ -4412,24 +4412,24 @@ h5pset_char_encoding_c(hid_t_f *plist_id, int_f *encoding) /****if* H5Pf/h5pget_char_encoding_c * NAME - * h5pget_char_encoding_c + * h5pget_char_encoding_c * PURPOSE * Calls H5Pget_char_encoding * * INPUTS * - * plist_id - Property list identifier + * plist_id - Property list identifier * OUTPUTS * - * encoding - Encoding character set: + * encoding - Encoding character set: * H5T_CSET_ASCII_F -> US ASCII * H5T_CSET_UTF8_F -> UTF-8 Unicode encoding * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * March 3, 2008 + * March 3, 2008 * HISTORY * * SOURCE @@ -4455,24 +4455,24 @@ h5pget_char_encoding_c(hid_t_f *plist_id, int_f *encoding) /****if* H5Pf/h5pset_copy_object_c * NAME - * h5pset_copy_object_c + * h5pset_copy_object_c * PURPOSE * Calls H5Pset_copy_object * * INPUTS * - * ocp_plist_id - Object copy property list identifier - * copy_options - Copy option(s) to be set + * ocp_plist_id - Object copy property list identifier + * copy_options - Copy option(s) to be set * * OUTPUTS * * NONE * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * March 3, 2008 + * March 3, 2008 * HISTORY * * SOURCE @@ -4495,23 +4495,23 @@ h5pset_copy_object_c(hid_t_f *ocp_plist_id, int_f *copy_options) /****if* H5Pf/h5pget_copy_object_c * NAME - * h5pget_copy_object_c + * h5pget_copy_object_c * PURPOSE * Calls H5Pget_copy_object * * INPUTS * - * ocp_plist_id - Object copy property list identifier + * ocp_plist_id - Object copy property list identifier * * OUTPUTS * - * copy_options - Copy option(s) to be get + * copy_options - Copy option(s) to be get * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * March 3, 2008 + * March 3, 2008 * HISTORY * * SOURCE @@ -4537,25 +4537,25 @@ h5pget_copy_object_c(hid_t_f *ocp_plist_id, int_f *copy_options) /****if* H5Pf/h5pget_data_transform_c * NAME - * h5pget_data_transform_c + * h5pget_data_transform_c * PURPOSE - * Calls H5Pget_data_transform + * Calls H5Pget_data_transform * INPUTS * - * prp_id - property list identifier to query - * expression_len - buffer size transorm expression + * prp_id - property list identifier to query + * expression_len - buffer size transorm expression * - * Output: - * expression - buffer to hold transform expression + * Output: + * expression - buffer to hold transform expression * * RETURNS * - * Success: 0 + * Success: 0 * Failure: -1 * * AUTHOR * M. Scot Breitenfeld - * March 19, 2008 + * March 19, 2008 * HISTORY * * SOURCE @@ -4599,25 +4599,25 @@ done: /****if* H5Pf/h5pset_data_transform_c * NAME - * h5pset_data_transform_c + * h5pset_data_transform_c * PURPOSE - * Calls H5Pset_data_transform + * Calls H5Pset_data_transform * INPUTS * - * prp_id - property list identifier to query - * expression - buffer to hold transform expression - * expression_len - buffer size transorm expression + * prp_id - property list identifier to query + * expression - buffer to hold transform expression + * expression_len - buffer size transorm expression * - * Output: + * Output: * * RETURNS * - * Success: 0 + * Success: 0 * Failure: -1 * * AUTHOR * M. Scot Breitenfeld - * March 19, 2008 + * March 19, 2008 * HISTORY * * SOURCE @@ -4650,23 +4650,23 @@ done: /****if* H5Pf/h5pget_local_heap_size_hint_c * NAME - * h5pget_local_heap_size_hint_c + * h5pget_local_heap_size_hint_c * PURPOSE - * Calls H5Pget_local_heap_size_hint + * Calls H5Pget_local_heap_size_hint * INPUTS * - * gcpl_id - Group creation property list identifier + * gcpl_id - Group creation property list identifier * - * Output: - * size_hint - Hint for size of local heap + * Output: + * size_hint - Hint for size of local heap * RETURNS * - * Success: 0 + * Success: 0 * Failure: -1 * * AUTHOR * M. Scot Breitenfeld - * March 21, 2008 + * March 21, 2008 * HISTORY * * SOURCE @@ -4691,24 +4691,24 @@ h5pget_local_heap_size_hint_c(hid_t_f *gcpl_id, size_t_f *size_hint) /****if* H5Pf/h5pget_est_link_info_c * NAME - * h5pget_est_link_info_c + * h5pget_est_link_info_c * PURPOSE - * Calls H5Pget_est_link_info + * Calls H5Pget_est_link_info * INPUTS * - * gcpl_id - Group creation property list identifier + * gcpl_id - Group creation property list identifier * - * Output: - * est_num_entries - Estimated number of links to be inserted into group - * est_name_len - Estimated average length of link names + * Output: + * est_num_entries - Estimated number of links to be inserted into group + * est_name_len - Estimated average length of link names * RETURNS * - * Success: 0 + * Success: 0 * Failure: -1 * * AUTHOR * M. Scot Breitenfeld - * March 21, 2008 + * March 21, 2008 * HISTORY * * SOURCE @@ -4736,24 +4736,24 @@ h5pget_est_link_info_c(hid_t_f *gcpl_id, int_f *est_num_entries, int_f *est_name /****if* H5Pf/h5pset_local_heap_size_hint_c * NAME - * h5pset_local_heap_size_hint_c + * h5pset_local_heap_size_hint_c * PURPOSE - * Calls H5Pset_local_heap_size_hint + * Calls H5Pset_local_heap_size_hint * INPUTS * - * gcpl_id - Group creation property list identifier - * size_hint - Hint for size of local heap + * gcpl_id - Group creation property list identifier + * size_hint - Hint for size of local heap * - * Output: + * Output: * * RETURNS * - * Success: 0 + * Success: 0 * Failure: -1 * * AUTHOR * M. Scot Breitenfeld - * March 21, 2008 + * March 21, 2008 * HISTORY * * SOURCE @@ -4776,24 +4776,24 @@ h5pset_local_heap_size_hint_c(hid_t_f *gcpl_id, size_t_f *size_hint) /****if* H5Pf/h5pset_est_link_info_c * NAME - * h5pset_est_link_info_c + * h5pset_est_link_info_c * PURPOSE - * Calls H5Pset_est_link_info + * Calls H5Pset_est_link_info * INPUTS * - * gcpl_id - Group creation property list identifier - * est_num_entries - Estimated number of links to be inserted into group - * est_name_len - Estimated average length of link names + * gcpl_id - Group creation property list identifier + * est_num_entries - Estimated number of links to be inserted into group + * est_name_len - Estimated average length of link names * - * Output: + * Output: * RETURNS * - * Success: 0 + * Success: 0 * Failure: -1 * * AUTHOR * M. Scot Breitenfeld - * March 21, 2008 + * March 21, 2008 * HISTORY * * SOURCE @@ -4816,20 +4816,20 @@ h5pset_est_link_info_c(hid_t_f *gcpl_id, int_f *est_num_entries, int_f *est_name /****if* H5Pf/h5pset_link_phase_change_c * NAME - * h5pset_link_phase_change_c + * h5pset_link_phase_change_c * PURPOSE - * Calls H5Pset_link_phase_change + * Calls H5Pset_link_phase_change * * INPUTS - * gcpl_id - Group creation property list identifier - * max_compact - Maximum number of attributes to be stored in compact storage - * min_dense - Minimum number of attributes to be stored in dense storage - * Outputs + * gcpl_id - Group creation property list identifier + * max_compact - Maximum number of attributes to be stored in compact storage + * min_dense - Minimum number of attributes to be stored in dense storage + * Outputs * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * March 21, 2008 + * March 21, 2008 * HISTORY * * SOURCE @@ -4859,11 +4859,11 @@ h5pset_link_phase_change_c(hid_t_f *gcpl_id, int_f *max_compact, int_f *min_dens * * INPUTS * - * fapl_id - File access property list identifier - * alignment - Required memory alignment boundary - * block_size - File system block size - * cbuf_size - Copy buffer size - * Outputs + * fapl_id - File access property list identifier + * alignment - Required memory alignment boundary + * block_size - File system block size + * cbuf_size - Copy buffer size + * Outputs * RETURNS * 0 on success, -1 on failure * AUTHOR @@ -4895,23 +4895,23 @@ h5pset_fapl_direct_c(hid_t_f H5_ATTR_UNUSED *fapl_id, size_t_f H5_ATTR_UNUSED *a /****if* H5Pf/h5pget_fapl_direct_c * NAME - * h5pget_fapl_direct_c + * h5pget_fapl_direct_c * PURPOSE - * Calls H5Pget_fapl_direct + * Calls H5Pget_fapl_direct * * INPUTS * - * fapl_id - File access property list identifier + * fapl_id - File access property list identifier * OUTPUTS * - * alignment - Required memory alignment boundary - * block_size - File system block size - * cbuf_size - Copy buffer size + * alignment - Required memory alignment boundary + * block_size - File system block size + * cbuf_size - Copy buffer size * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * March 21, 2008 + * March 21, 2008 * HISTORY * * SOURCE @@ -4944,21 +4944,21 @@ h5pget_fapl_direct_c(hid_t_f H5_ATTR_UNUSED *fapl_id, size_t_f H5_ATTR_UNUSED *a /****if* H5Pf/h5pset_attr_phase_change_c * NAME - * h5pset_attr_phase_change_c + * h5pset_attr_phase_change_c * PURPOSE - * Calls H5Pset_attr_phase_change + * Calls H5Pset_attr_phase_change * * INPUTS - * ocpl_id - Object (dataset or group) creation property list identifier - * max_compact - Maximum number of attributes to be stored in compact storage - * min_dense - Minimum number of attributes to be stored in dense storage + * ocpl_id - Object (dataset or group) creation property list identifier + * max_compact - Maximum number of attributes to be stored in compact storage + * min_dense - Minimum number of attributes to be stored in dense storage * OUTPUTS * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * March 21, 2008 + * March 21, 2008 * HISTORY * * SOURCE @@ -4981,19 +4981,19 @@ h5pset_attr_phase_change_c(hid_t_f *ocpl_id, int_f *max_compact, int_f *min_dens /****if* H5Pf/h5pset_nbit_c * NAME - * h5pset_nbit_c + * h5pset_nbit_c * PURPOSE - * Calls H5Pset_nbit + * Calls H5Pset_nbit * * INPUTS - * plist_id - Dataset creation property list identifier + * plist_id - Dataset creation property list identifier * OUTPUTS * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * March 21, 2008 + * March 21, 2008 * HISTORY * * SOURCE @@ -5084,23 +5084,23 @@ h5pset_nlinks_c(hid_t_f *lapl_id, size_t_f *nlinks) /****if* H5Pf/h5pget_nlinks * NAME - * h5pget_nlinks + * h5pget_nlinks * PURPOSE - * Calls H5Pget_nlinks + * Calls H5Pget_nlinks * * INPUTS * - * lapl_id - File access property list identifier + * lapl_id - File access property list identifier * * OUTPUTS * - * nlinks - Maximum number of links to traverse + * nlinks - Maximum number of links to traverse * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * March 24, 2008 + * March 24, 2008 * HISTORY * * SOURCE @@ -5125,20 +5125,20 @@ h5pget_nlinks_c(hid_t_f *lapl_id, size_t_f *nlinks) /****if* H5Pf/h5pget_create_inter_group_c * NAME - * h5pget_create_inter_group_c + * h5pget_create_inter_group_c * PURPOSE - * Calls H5Pget_create_intermediate_group + * Calls H5Pget_create_intermediate_group * * INPUTS * * lcpl_id - Link creation property list identifier - * crt_intermed_group - Specifying whether to create intermediate groups upon - * the creation of an object + * crt_intermed_group - Specifying whether to create intermediate groups upon + * the creation of an object * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * April 4, 2008 + * April 4, 2008 * HISTORY * * SOURCE @@ -5164,18 +5164,18 @@ h5pget_create_inter_group_c(hid_t_f *lcpl_id, int_f *crt_intermed_group) } /*---------------------------------------------------------------------------- - * Name: h5pset_chunk_cache_c - * Purpose: Calls H5Pset_chunk_cache - * - * Inputs: dapl_id - Link creation property list identifier - * rdcc_nslots - - * rdcc_nbytes - - * rdcc_w0 - - * - * Returns: 0 on success, -1 on failure - * Programmer: M. Scot Breitenfeld - * April 13, 2009 - * Modifications: + * Name: h5pset_chunk_cache_c + * Purpose: Calls H5Pset_chunk_cache + * + * Inputs: dapl_id - Link creation property list identifier + * rdcc_nslots - + * rdcc_nbytes - + * rdcc_w0 - + * + * Returns: 0 on success, -1 on failure + * Programmer: M. Scot Breitenfeld + * April 13, 2009 + * Modifications: *---------------------------------------------------------------------------*/ int_f @@ -5194,19 +5194,19 @@ h5pset_chunk_cache_c(hid_t_f *dapl_id, size_t_f *rdcc_nslots, size_t_f *rdcc_nby } /*---------------------------------------------------------------------------- - * Name: h5pget_chunk_cache_c - * Purpose: Calls H5Pget_chunk_cache - * - * Inputs: dapl_id - Link creation property list identifier - * Outputs: - * rdcc_nslots - - * rdcc_nbytes - - * rdcc_w0 - - * - * Returns: 0 on success, -1 on failure - * Programmer: M. Scot Breitenfeld - * April 13, 2009 - * Modifications: + * Name: h5pget_chunk_cache_c + * Purpose: Calls H5Pget_chunk_cache + * + * Inputs: dapl_id - Link creation property list identifier + * Outputs: + * rdcc_nslots - + * rdcc_nbytes - + * rdcc_w0 - + * + * Returns: 0 on success, -1 on failure + * Programmer: M. Scot Breitenfeld + * April 13, 2009 + * Modifications: *---------------------------------------------------------------------------*/ int_f @@ -5231,18 +5231,18 @@ h5pget_chunk_cache_c(hid_t_f *dapl_id, size_t_f *rdcc_nslots, size_t_f *rdcc_nby } /*---------------------------------------------------------------------------- - * Name: h5pset_file_image_c - * Purpose: Calls H5Pset_file_image + * Name: h5pset_file_image_c + * Purpose: Calls H5Pset_file_image * - * Inputs: + * Inputs: * fapl_id - File access property list identifier * buf_ptr - Pointer to the initial file image, - * or NULL if no initial file image is desired + * or NULL if no initial file image is desired * buf_len - Size of the supplied buffer, or 0 (zero) if no initial image is desired * - * Returns: 0 on success, -1 on failure - * Programmer: M. Scot Breitenfeld - * February 19, 2012 + * Returns: 0 on success, -1 on failure + * Programmer: M. Scot Breitenfeld + * February 19, 2012 *---------------------------------------------------------------------------*/ int_f @@ -5260,19 +5260,19 @@ h5pset_file_image_c(hid_t_f *fapl_id, void *buf_ptr, size_t_f *buf_len) } /*---------------------------------------------------------------------------- - * Name: h5pget_file_image_c - * Purpose: Calls H5Pget_file_image + * Name: h5pget_file_image_c + * Purpose: Calls H5Pget_file_image * - * Inputs: + * Inputs: * fapl_id - File access property list identifier - * Outputs: + * Outputs: * buf_ptr - Pointer to the initial file image, - * or NULL if no initial file image is desired + * or NULL if no initial file image is desired * buf_len - Size of the supplied buffer, or 0 (zero) if no initial image is desired * - * Returns: 0 on success, -1 on failure - * Programmer: M. Scot Breitenfeld - * February 19, 2012 + * Returns: 0 on success, -1 on failure + * Programmer: M. Scot Breitenfeld + * February 19, 2012 *---------------------------------------------------------------------------*/ int_f @@ -5303,19 +5303,19 @@ h5pget_file_image_c(hid_t_f *fapl_id, void **buf_ptr, size_t_f *buf_len_ptr) #ifdef H5_HAVE_PARALLEL /****if* H5Pf/h5pset_fapl_mpio_c * NAME - * h5pset_fapl_mpio_c + * h5pset_fapl_mpio_c * PURPOSE - * Call H5Pset_fapl_mpio to set mode for parallel I/O and the user - * supplied communicator and info object + * Call H5Pset_fapl_mpio to set mode for parallel I/O and the user + * supplied communicator and info object * INPUTS - * prp_id - property list identifier - * comm - MPI communicator - * info - MPI info object + * prp_id - property list identifier + * comm - MPI communicator + * info - MPI info object * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Thursday, October 26, 2000 + * Thursday, October 26, 2000 * HISTORY * * SOURCE @@ -5343,18 +5343,18 @@ h5pset_fapl_mpio_c(hid_t_f *prp_id, int_f* comm, int_f* info) } /****if* H5Pf/h5pget_fapl_mpio_c * NAME - * h5pget_fapl_mpio_c + * h5pget_fapl_mpio_c * PURPOSE - * Call H5Pget_fapl_mpio to retrieve communicator and info object + * Call H5Pget_fapl_mpio to retrieve communicator and info object * INPUTS - * prp_id - property list identifier - * comm - buffer to return MPI communicator - * info - buffer to return MPI info object + * prp_id - property list identifier + * comm - buffer to return MPI communicator + * info - buffer to return MPI info object * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Thursday, October 26, 2000 + * Thursday, October 26, 2000 * HISTORY * * SOURCE @@ -5382,18 +5382,18 @@ h5pget_fapl_mpio_c(hid_t_f *prp_id, int_f* comm, int_f* info) } /****if* H5Pf/h5pset_dxpl_mpio_c * NAME - * h5pset_dxpl_mpio_c + * h5pset_dxpl_mpio_c * PURPOSE - * Call H5Pset_dxpl_mpio to set transfer mode of the dataset - * trasfer property list + * Call H5Pset_dxpl_mpio to set transfer mode of the dataset + * trasfer property list * INPUTS - * prp_id - property list identifier - * data_xfer_mode - transfer mode + * prp_id - property list identifier + * data_xfer_mode - transfer mode * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Thursday, October 26, 2000 + * Thursday, October 26, 2000 * HISTORY * * SOURCE @@ -5433,18 +5433,18 @@ h5pset_dxpl_mpio_c(hid_t_f *prp_id, int_f* data_xfer_mode) /****if* H5Pf/h5pget_dxpl_mpio_c * NAME - * h5pget_dxpl_mpio_c + * h5pget_dxpl_mpio_c * PURPOSE - * Call H5Pget_dxpl_mpio to get transfer mode of the dataset - * trasfer property list + * Call H5Pget_dxpl_mpio to get transfer mode of the dataset + * trasfer property list * INPUTS - * prp_id - property list identifier - * data_xfer_mode - buffer to retrieve transfer mode + * prp_id - property list identifier + * data_xfer_mode - buffer to retrieve transfer mode * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Thursday, June 15, 2000 + * Thursday, June 15, 2000 * HISTORY * * SOURCE diff --git a/fortran/src/H5Rf.c b/fortran/src/H5Rf.c index b196c71..378dded 100644 --- a/fortran/src/H5Rf.c +++ b/fortran/src/H5Rf.c @@ -1,6 +1,6 @@ /****h* H5Rf/H5Rf * PURPOSE - * This file contains C stubs for H5R Fortran APIs + * This file contains C stubs for H5R Fortran APIs * * COPYRIGHT * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * @@ -26,19 +26,19 @@ /****if* H5Rf/h5rcreate_region_c * NAME - * h5rcreate_region_c + * h5rcreate_region_c * PURPOSE - * Call H5Rcreate to create a reference to dataset region - * region + * Call H5Rcreate to create a reference to dataset region + * region * INPUTS - * loc_id - file or group identifier - * name - name of the dataset - * namelen - name length - * space_id - dataset space identifier + * loc_id - file or group identifier + * name - name of the dataset + * namelen - name length + * space_id - dataset space identifier * OUTPUTS - * ref - reference to the dataset region + * ref - reference to the dataset region * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal * Wednesday, December 1, 1999 @@ -125,7 +125,7 @@ h5rcreate_ptr_c (void *ref, hid_t_f *loc_id, _fcd name, int_f *namelen, int_f *r * Call H5Rdereference * INPUTS * obj_id - Valid identifier for the file containing the - * referenced object or any object in that file. + * referenced object or any object in that file. * ref_typ - The reference type of ref. * ref - Object reference * OUTPUTS @@ -162,8 +162,8 @@ h5rdereference_ptr_c (hid_t_f *obj_id, int_f *ref_type, void *ref, hid_t_f *ref_ * PURPOSE * Call H5Rget_region to dereference dataspace region * INPUTS - * dset_id - dataset identifier - * ref - reference to the dataset region + * dset_id - dataset identifier + * ref - reference to the dataset region * OUTPUTS * space_id - dereferenced dataset dataspace identifier * RETURNS @@ -205,8 +205,8 @@ done: * PURPOSE * Call H5Rget_region to dereference dataspace region * INPUTS - * dset_id - dataset identifier - * ref - reference to the dataset region + * dset_id - dataset identifier + * ref - reference to the dataset region * OUTPUTS * space_id - dereferenced dataset dataspace identifier * RETURNS @@ -241,17 +241,17 @@ done: /****if* H5Rf/h5rget_object_type_obj_c * NAME - * h5rget_object_type_obj_c + * h5rget_object_type_obj_c * PURPOSE - * Call H5Rget_object_type to retrieve the type of the object reference points - * to + * Call H5Rget_object_type to retrieve the type of the object reference points + * to * INPUTS - * dset_id - dataset identifier - * ref - reference to the dataset region + * dset_id - dataset identifier + * ref - reference to the dataset region * OUTPUTS - * obj_type - type of dereferenced object + * obj_type - type of dereferenced object * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal * Wednesday, December 1, 1999 @@ -287,13 +287,13 @@ done: * Call H5Rget_name * INPUTS * - * loc_id - Identifier for the dataset containing the reference or for the group that dataset is in. - * ref_type - Type of reference. - * ref - An object or dataset region reference. + * loc_id - Identifier for the dataset containing the reference or for the group that dataset is in. + * ref_type - Type of reference. + * ref - An object or dataset region reference. * * OUTPUTS - * name - A name associated with the referenced object or dataset region. - * size - The size of the name buffer. + * name - A name associated with the referenced object or dataset region. + * size - The size of the name buffer. * * RETURNS * 0 on success, -1 on failure @@ -341,24 +341,24 @@ h5rget_name_ptr_c (hid_t_f *loc_id, int_f *ref_type, void *ref, _fcd name, size_ /****if* H5Rf/h5rget_obj_type_c * NAME - * h5rget_obj_type_c + * h5rget_obj_type_c * PURPOSE - * Call H5Rget_obj_type + * Call H5Rget_obj_type * INPUTS - * loc_id - Identifier for the dataset containing the reference or - * for the group that dataset is in. - * ref_type - Type of reference to query. - * ref - Reference to query. + * loc_id - Identifier for the dataset containing the reference or + * for the group that dataset is in. + * ref_type - Type of reference to query. + * ref - Reference to query. * * OUTPUTS - * obj_type - Type of referenced object. These are defined in H5Opublic.h, - * enum H5O_type_t + * obj_type - Type of referenced object. These are defined in H5Opublic.h, + * enum H5O_type_t * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * December 17, 2008 + * December 17, 2008 * * SOURCE */ diff --git a/fortran/src/H5Sf.c b/fortran/src/H5Sf.c index 53dd6ab..a12adfa 100644 --- a/fortran/src/H5Sf.c +++ b/fortran/src/H5Sf.c @@ -1,6 +1,6 @@ /****h* H5Sf/H5Sf * PURPOSE - * This file contains C stubs for H5S Fortran APIs + * This file contains C stubs for H5S Fortran APIs * * COPYRIGHT * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * @@ -26,20 +26,20 @@ /****if* H5Sf/h5screate_simple_c * NAME - * h5screate_simple_c + * h5screate_simple_c * PURPOSE - * Call H5Screate_simple to create a dataspace + * Call H5Screate_simple to create a dataspace * INPUTS - * rank - number of dimensions of dataspace - * dims - array of the size of each dimension + * rank - number of dimensions of dataspace + * dims - array of the size of each dimension maxdims - an array of the maximum size of each dimension * OUTPUTS - * space_id - identifier of the created dataspace + * space_id - identifier of the created dataspace * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, August 4, 1999 + * Wednesday, August 4, 1999 * HISTORY * * SOURCE @@ -75,16 +75,16 @@ done: /****if* H5Sf/h5sclose_c * NAME - * h5sclose_c + * h5sclose_c * PURPOSE - * Call H5Sclose to close the dataspace + * Call H5Sclose to close the dataspace * INPUTS - * space_id - identifier of the dataspace to be closed + * space_id - identifier of the dataspace to be closed * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, August 4, 1999 + * Wednesday, August 4, 1999 * HISTORY * * SOURCE @@ -104,18 +104,18 @@ h5sclose_c ( hid_t_f *space_id ) /****if* H5Sf/h5screate_c * NAME - * h5screate_c + * h5screate_c * PURPOSE - * Call H5Screate to create a dataspace + * Call H5Screate to create a dataspace * INPUTS - * classtype - type of the dataspace class + * classtype - type of the dataspace class * OUTPUTS - * space_id - identifier of the created dataspace + * space_id - identifier of the created dataspace * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Tuesday, August 10, 1999 + * Tuesday, August 10, 1999 * HISTORY * * SOURCE @@ -138,18 +138,18 @@ h5screate_c ( int_f *classtype, hid_t_f *space_id ) /****if* H5Sf/h5scopy_c * NAME - * h5scopy_c + * h5scopy_c * PURPOSE - * Call H5Scopy to copy dataspace + * Call H5Scopy to copy dataspace * INPUTS - * space_id - identifier of the dataspace to be copied + * space_id - identifier of the dataspace to be copied * OUTPUTS - * new_space_id - identifier of the new datspace + * new_space_id - identifier of the new datspace * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Tuesday, August 10, 1999 + * Tuesday, August 10, 1999 * HISTORY * * SOURCE @@ -173,21 +173,21 @@ h5scopy_c( hid_t_f *space_id , hid_t_f *new_space_id) /****if* H5Sf/h5sget_select_hyper_nblocks_c * NAME - * h5sget_select_hyper_nblocks_c + * h5sget_select_hyper_nblocks_c * PURPOSE - * Call H5SH5Sget_select_hyper_nblocks to - * get the the number of hyperslab blocks in - * the current dataspace selection if successful + * Call H5SH5Sget_select_hyper_nblocks to + * get the the number of hyperslab blocks in + * the current dataspace selection if successful * INPUTS - * space_id - identifier of the dataspace + * space_id - identifier of the dataspace * OUTPUTS - * num_blocks - number of hyperslab blocks in - * the current dataspace selection + * num_blocks - number of hyperslab blocks in + * the current dataspace selection * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Friday, November 12, 1999 + * Friday, November 12, 1999 * HISTORY * * SOURCE @@ -211,21 +211,21 @@ h5sget_select_hyper_nblocks_c( hid_t_f *space_id , hssize_t_f * num_blocks) /****if* H5Sf/h5sget_select_elem_npoints_c * NAME - * h5sget_select_elem_npoints_c + * h5sget_select_elem_npoints_c * PURPOSE - * Call H5Sget_select_elem_npoints to - * get the the number of element points in - * the current dataspace selection if successful + * Call H5Sget_select_elem_npoints to + * get the the number of element points in + * the current dataspace selection if successful * INPUTS - * space_id - identifier of the dataspace + * space_id - identifier of the dataspace * OUTPUTS - * num_points - number of element points in - * the current dataspace selection + * num_points - number of element points in + * the current dataspace selection * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Monday, November 15, 1999 + * Monday, November 15, 1999 * HISTORY * * SOURCE @@ -249,30 +249,30 @@ h5sget_select_elem_npoints_c( hid_t_f *space_id , hssize_t_f * num_points) /****if* H5Sf/h5sget_select_hyper_blocklist_c * NAME - * h5sget_select_hyper_blocklist_c + * h5sget_select_hyper_blocklist_c * PURPOSE - * Call H5Sget_select_hyper_blocklist to - * get a list of the hyperslab blocks currently selected - * Starting with the startblock-th block in the - * list of blocks, num_blocks blocks are put into the user's - * buffer. If the user's buffer fills up before numblocks - * blocks are inserted, the buffer - * will contain only as many blocks as fit. + * Call H5Sget_select_hyper_blocklist to + * get a list of the hyperslab blocks currently selected + * Starting with the startblock-th block in the + * list of blocks, num_blocks blocks are put into the user's + * buffer. If the user's buffer fills up before numblocks + * blocks are inserted, the buffer + * will contain only as many blocks as fit. * INPUTS - * space_id - identifier of the dataspace - * startblock - Hyperslab block to start with - * num_blocks - number of hyperslab blocks in - * the current dataspace selection + * space_id - identifier of the dataspace + * startblock - Hyperslab block to start with + * num_blocks - number of hyperslab blocks in + * the current dataspace selection * OUTPUTS - * buf - List of hyperslab blocks selected + * buf - List of hyperslab blocks selected * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Monday, November 15, 1999 + * Monday, November 15, 1999 * HISTORY * - * Transpose dimension arrays because of C-FORTRAN storage order + * Transpose dimension arrays because of C-FORTRAN storage order * M. Scot Breitenfeld * SOURCE */ @@ -327,25 +327,25 @@ h5sget_select_hyper_blocklist_c( hid_t_f *space_id ,hsize_t_f *startblock, /****if* H5Sf/h5sget_select_bounds_c * NAME - * h5sget_select_bounds_c + * h5sget_select_bounds_c * PURPOSE - * Call H5Sget_select_bounds to retrieve the coordinates - * of the bounding box containing the current selection - * and places them into user-supplied buffers + * Call H5Sget_select_bounds to retrieve the coordinates + * of the bounding box containing the current selection + * and places them into user-supplied buffers * INPUTS - * space_id - identifier of the dataspace + * space_id - identifier of the dataspace * OUTPUTS - * start - Starting coordinates of the bounding box - * end - Ending coordinates of the bounding box, - * i.e., the coordinates of the diagonally opposite corne + * start - Starting coordinates of the bounding box + * end - Ending coordinates of the bounding box, + * i.e., the coordinates of the diagonally opposite corne * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Wednesday, November 17, 1999 + * Wednesday, November 17, 1999 * HISTORY - * swapped array bounds to account for C and Fortran reversed - * matrix notation. + * swapped array bounds to account for C and Fortran reversed + * matrix notation. * M. Scot Breitenfeld * SOURCE */ @@ -379,27 +379,27 @@ done: /****if* H5Sf/h5sget_select_elem_pointlist_c * NAME - * h5sget_select_elem_pointlist_c + * h5sget_select_elem_pointlist_c * PURPOSE - * Call H5Sget_select_elem_pointlist - * get a list of element points in the - * current dataspace selectin. - * Starting with the startpoint-th point in the - * list of points, numpoints points are put into the user's - * buffer. If the user's buffer fills up before numpoints - * points are inserted, the buffer - * will contain only as many points as fit. + * Call H5Sget_select_elem_pointlist + * get a list of element points in the + * current dataspace selectin. + * Starting with the startpoint-th point in the + * list of points, numpoints points are put into the user's + * buffer. If the user's buffer fills up before numpoints + * points are inserted, the buffer + * will contain only as many points as fit. * INPUTS - * space_id - identifier of the dataspace - * startpoint - Element point to start with - * numpoints - Number of element points to get + * space_id - identifier of the dataspace + * startpoint - Element point to start with + * numpoints - Number of element points to get * OUTPUTS - * buf - List of element points selected + * buf - List of element points selected * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Wednesday, November 17, 1999 + * Wednesday, November 17, 1999 * HISTORY * * SOURCE @@ -451,16 +451,16 @@ h5sget_select_elem_pointlist_c( hid_t_f *space_id ,hsize_t_f * startpoint, /****if* H5Sf/h5sselect_all_c * NAME - * h5sselect_all_c + * h5sselect_all_c * PURPOSE - * Call H5Sselect_all to select entire dataspace + * Call H5Sselect_all to select entire dataspace * INPUTS - * space_id - identifier of the dataspace + * space_id - identifier of the dataspace * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Tuesday, August 10, 1999 + * Tuesday, August 10, 1999 * HISTORY * * SOURCE @@ -480,16 +480,16 @@ h5sselect_all_c ( hid_t_f *space_id ) /****if* H5Sf/h5sselect_none_c * NAME - * h5sselect_none_c + * h5sselect_none_c * PURPOSE - * Call H5Sselect_none to reset the selection region + * Call H5Sselect_none to reset the selection region * INPUTS - * space_id - identifier of the dataspace + * space_id - identifier of the dataspace * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Tuesday, August 10, 1999 + * Tuesday, August 10, 1999 * HISTORY * * SOURCE @@ -509,20 +509,20 @@ h5sselect_none_c ( hid_t_f *space_id ) /****if* H5Sf/h5sselect_valid_c * NAME - * h5sselect_valid_c + * h5sselect_valid_c * PURPOSE - * Call H5Sselect_valid to verify that selection - * is within dataspace extent. + * Call H5Sselect_valid to verify that selection + * is within dataspace extent. * INPUTS - * space_id - identifier of the dataspace + * space_id - identifier of the dataspace * OUTPUTS - * flag - 0 if not valid selection, 1 if is valid selection, - * and negative on failure. + * flag - 0 if not valid selection, 1 if is valid selection, + * and negative on failure. * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Tuesday, August 10, 1999 + * Tuesday, August 10, 1999 * HISTORY * * SOURCE @@ -545,19 +545,19 @@ h5sselect_valid_c ( hid_t_f *space_id , int_f *flag ) /****if* H5Sf/h5sget_simple_extent_npoints_c * NAME - * h5sget_simple_extent_npoints_c + * h5sget_simple_extent_npoints_c * PURPOSE - * Call H5Sget_simple_extent_npoints to determine the number - * of elements in a dataspace + * Call H5Sget_simple_extent_npoints to determine the number + * of elements in a dataspace * INPUTS - * space_id - identifier of the dataspace + * space_id - identifier of the dataspace * OUTPUTS - * npoints - number of points in a dataspace + * npoints - number of points in a dataspace * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, August 11, 1999 + * Wednesday, August 11, 1999 * HISTORY * * SOURCE @@ -580,19 +580,19 @@ h5sget_simple_extent_npoints_c ( hid_t_f *space_id , hsize_t_f *npoints ) /****if* H5Sf/h5sget_select_npoints_c * NAME - * h5sget_select_npoints_c + * h5sget_select_npoints_c * PURPOSE - * Call H5Sget_select_npoints to determine the number - * of elements in a dataspace selection + * Call H5Sget_select_npoints to determine the number + * of elements in a dataspace selection * INPUTS - * space_id - identifier of the dataspace + * space_id - identifier of the dataspace * OUTPUTS - * npoints - number of points in a dataspace selection + * npoints - number of points in a dataspace selection * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, August 11, 1999 + * Wednesday, August 11, 1999 * HISTORY * * SOURCE @@ -615,19 +615,19 @@ h5sget_select_npoints_c ( hid_t_f *space_id , hssize_t_f *npoints ) /****if* H5Sf/h5sget_simple_extent_ndims_c * NAME - * h5sget_simple_extent_ndims_c + * h5sget_simple_extent_ndims_c * PURPOSE - * Call H5Sget_simple_extent_ndims to determine the number - * dimensions + * Call H5Sget_simple_extent_ndims to determine the number + * dimensions * INPUTS - * space_id - identifier of the dataspace + * space_id - identifier of the dataspace * OUTPUTS - * rank - number of dataspace dimensions + * rank - number of dataspace dimensions * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, August 11, 1999 + * Wednesday, August 11, 1999 * HISTORY * * SOURCE @@ -650,20 +650,20 @@ h5sget_simple_extent_ndims_c ( hid_t_f *space_id , int_f *ndims ) /****if* H5Sf/h5sget_simple_extent_type_c * NAME - * h5sget_simple_extent_type_c + * h5sget_simple_extent_type_c * PURPOSE - * Call H5Sget_simple_extent_type to determine the class type - * of a dataspace + * Call H5Sget_simple_extent_type to determine the class type + * of a dataspace * INPUTS - * space_id - identifier of the dataspace + * space_id - identifier of the dataspace * OUTPUTS - * classtype - class type; possible values are: + * classtype - class type; possible values are: * H5S_SCALAR_F (0), H5S_SIMPLE_F (1), H5S_NULL_F (2) * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, August 11, 1999 + * Wednesday, August 11, 1999 * HISTORY * * SOURCE @@ -691,18 +691,18 @@ h5sget_simple_extent_type_c ( hid_t_f *space_id , int_f *classtype) /****if* H5Sf/h5soffset_simple_c * NAME - * h5soffset_simple_c + * h5soffset_simple_c * PURPOSE - * Call H5Soffset_simple to set the offset of a simple - * dataspace + * Call H5Soffset_simple to set the offset of a simple + * dataspace * INPUTS - * space_id - identifier of the dataspace - * offset - offset array + * space_id - identifier of the dataspace + * offset - offset array * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, August 11, 1999 + * Wednesday, August 11, 1999 * HISTORY * * SOURCE @@ -738,20 +738,20 @@ done: /****if* H5Sf/h5sset_extent_simple_c * NAME - * h5sset_extent_simple_c + * h5sset_extent_simple_c * PURPOSE - * Call H5Sset_extent_simple to set or reset size of - * existing dataspace + * Call H5Sset_extent_simple to set or reset size of + * existing dataspace * INPUTS - * space_id - identifier of the dataspace - * rank - dataspace rank - * current_size - array with the new dimension sizes - * maximum_size - aray with maximum sizes of dimensions + * space_id - identifier of the dataspace + * rank - dataspace rank + * current_size - array with the new dimension sizes + * maximum_size - aray with maximum sizes of dimensions * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, August 11, 1999 + * Wednesday, August 11, 1999 * HISTORY * * SOURCE @@ -784,20 +784,20 @@ done: /****if* H5Sf/h5sget_simple_extent_dims_c * NAME - * h5sget_simple_extent_dims_c + * h5sget_simple_extent_dims_c * PURPOSE - * Call H5Sget_simple_extent_dims to retrieve sizes of an - * existing dataspace + * Call H5Sget_simple_extent_dims to retrieve sizes of an + * existing dataspace * INPUTS - * space_id - identifier of the dataspace + * space_id - identifier of the dataspace * OUTPUTS - * dims - array with the dimension sizes - * maxdims - aray with maximum sizes of dimensions + * dims - array with the dimension sizes + * maxdims - aray with maximum sizes of dimensions * RETURNS - * number of dataspace dimensions (rank) on success, -1 on failure + * number of dataspace dimensions (rank) on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, August 11, 1999 + * Wednesday, August 11, 1999 * HISTORY * * SOURCE @@ -838,20 +838,20 @@ done: /****if* H5Sf/h5sis_simple_c * NAME - * h5sis_simple_c + * h5sis_simple_c * PURPOSE - * Call H5Sis_simple to detrmine if the dataspace - * is simple. + * Call H5Sis_simple to detrmine if the dataspace + * is simple. * INPUTS - * space_id - identifier of the dataspace + * space_id - identifier of the dataspace * OUTPUTS - * flag - 0 if not simple, 1 if is simple, - * and negative on failure. + * flag - 0 if not simple, 1 if is simple, + * and negative on failure. * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, August 11, 1999 + * Wednesday, August 11, 1999 * HISTORY * * SOURCE @@ -875,17 +875,17 @@ h5sis_simple_c ( hid_t_f *space_id , int_f *flag ) /****if* H5Sf/h5sextent_copy_c * NAME - * h5sextent_copy_c + * h5sextent_copy_c * PURPOSE - * Call H5Sextent_copy to copy an extent of dataspace + * Call H5Sextent_copy to copy an extent of dataspace * INPUTS - * dest_space_id - identifier of the destination dataspace - * source_space_id - identifier of the source dataspace + * dest_space_id - identifier of the destination dataspace + * source_space_id - identifier of the source dataspace * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, August 11, 1999 + * Wednesday, August 11, 1999 * HISTORY * * SOURCE @@ -908,16 +908,16 @@ h5sextent_copy_c ( hid_t_f *dest_space_id , hid_t_f *source_space_id) /****if* H5Sf/h5sset_extent_none_c * NAME - * h5sset_extent_none_c + * h5sset_extent_none_c * PURPOSE - * Call H5Sset_extent_none to remove extent from a dataspace + * Call H5Sset_extent_none to remove extent from a dataspace * INPUTS - * space_id - dataspace identifier + * space_id - dataspace identifier * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, August 11, 1999 + * Wednesday, August 11, 1999 * HISTORY * * SOURCE @@ -939,23 +939,23 @@ h5sset_extent_none_c ( hid_t_f *space_id ) /****if* H5Sf/h5sselect_hyperslab_c * NAME - * h5sselect_hyperslab_c + * h5sselect_hyperslab_c * PURPOSE - * Call H5Sselect_hyperslab to select a hyperslab + * Call H5Sselect_hyperslab to select a hyperslab * INPUTS - * space_id - identifier of the dataspace - * operator - defines how the new selection is combined - * with the previous one; current values are + * space_id - identifier of the dataspace + * operator - defines how the new selection is combined + * with the previous one; current values are * H5S_SELECT_SET_F (0) and H5S_SELECT_OR_F (1) - * start - offset of start of hyperslab - * count - number of blocks included in the hyperslab - * stride - hyperslab stride (interval between blocks) - * block - size of block in the hyperslab + * start - offset of start of hyperslab + * count - number of blocks included in the hyperslab + * stride - hyperslab stride (interval between blocks) + * block - size of block in the hyperslab * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, August 11, 1999 + * Wednesday, August 11, 1999 * HISTORY * * SOURCE @@ -1000,23 +1000,23 @@ done: #ifdef NEW_HYPERSLAB_API /****if* H5Sf/h5scombine_hyperslab_c * NAME - * h5scombine_hyperslab_c + * h5scombine_hyperslab_c * PURPOSE - * Call H5Scombine_hyperslab + * Call H5Scombine_hyperslab * INPUTS - * space_id - identifier of the dataspace - * operator - defines how the new selection is combined - * start - offset of start of hyperslab - * count - number of blocks included in the hyperslab - * stride - hyperslab stride (interval between blocks) - * block - size of block in the hyperslab + * space_id - identifier of the dataspace + * operator - defines how the new selection is combined + * start - offset of start of hyperslab + * count - number of blocks included in the hyperslab + * stride - hyperslab stride (interval between blocks) + * block - size of block in the hyperslab * OUTPUTS - * hyper_id - identifier for the new dataspace + * hyper_id - identifier for the new dataspace * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Monday, October 7, 2002 + * Monday, October 7, 2002 * HISTORY * * SOURCE @@ -1082,20 +1082,20 @@ DONE: } /****if* H5Sf/h5scombine_select_c * NAME - * h5scombine_select_c + * h5scombine_select_c * PURPOSE - * Call H5Scombine_ select + * Call H5Scombine_ select * INPUTS - * space1_id - identifier of the first dataspace - * operator - defines how the new selection is combined - * space2_id - identifier of the second dataspace + * space1_id - identifier of the first dataspace + * operator - defines how the new selection is combined + * space2_id - identifier of the second dataspace * OUTPUTS - * ds_id - identifier for the new dataspace + * ds_id - identifier for the new dataspace * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Monday, October 7, 2002 + * Monday, October 7, 2002 * HISTORY * * SOURCE @@ -1123,18 +1123,18 @@ h5scombine_select_c ( hid_t_f *space1_id , int_f *op, hid_t_f *space2_id, hid_t_ } /****if* H5Sf/h5sselect_select_c * NAME - * h5sselect_select_c + * h5sselect_select_c * PURPOSE - * Call H5Sselect_ select + * Call H5Sselect_ select * INPUTS - * space1_id - identifier of the first dataspace to modify - * operator - defines how the new selection is combined - * space2_id - identifier of the second dataspace + * space1_id - identifier of the first dataspace to modify + * operator - defines how the new selection is combined + * space2_id - identifier of the second dataspace * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Monday, October 7, 2002 + * Monday, October 7, 2002 * HISTORY * * SOURCE @@ -1160,18 +1160,18 @@ h5sselect_select_c ( hid_t_f *space1_id , int_f *op, hid_t_f *space2_id) #endif /*NEW_HYPERSLAB_API*/ /****if* H5Sf/h5sget_select_type_c * NAME - * h5sget_select_type_c + * h5sget_select_type_c * PURPOSE - * Call H5Sget_select_type + * Call H5Sget_select_type * INPUTS - * space_id - identifier of the dataspace + * space_id - identifier of the dataspace * OUTPUTS - * type - type of selection + * type - type of selection * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Monday, October 7, 2002 + * Monday, October 7, 2002 * HISTORY * * SOURCE @@ -1195,21 +1195,21 @@ h5sget_select_type_c ( hid_t_f *space_id , int_f *type) /****if* H5Sf/h5sselect_elements_c * NAME - * h5sselect_elements_c + * h5sselect_elements_c * PURPOSE - * Call H5Sselect_elements to select elements of a dataspace + * Call H5Sselect_elements to select elements of a dataspace * INPUTS - * space_id - identifier of the dataspace - * operator - defines how the new selection is combined - * with the previous one; current values are + * space_id - identifier of the dataspace + * operator - defines how the new selection is combined + * with the previous one; current values are * H5S_SELECT_SET_F (0) - * nelements - number of elements in the selection - * coord - arrays with the elements coordinates + * nelements - number of elements in the selection + * coord - arrays with the elements coordinates * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, August 11, 1999 + * Wednesday, August 11, 1999 * HISTORY * * SOURCE @@ -1251,21 +1251,21 @@ h5sselect_elements_c ( hid_t_f *space_id , int_f *op, size_t_f *nelements, hsiz /****if* H5Sf/h5sdecode_c * NAME - * h5sdecode_c + * h5sdecode_c * PURPOSE - * Call H5Sdecode + * Call H5Sdecode * INPUTS * * buf - Buffer for the data space object to be decoded. * OUTPUTS * - * obj_id - Object_id (non-negative) + * obj_id - Object_id (non-negative) * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * March 26, 2008 + * March 26, 2008 * HISTORY * * SOURCE @@ -1297,19 +1297,19 @@ h5sdecode_c ( _fcd buf, hid_t_f *obj_id ) /****if* H5Sf/h5sencode_c * NAME - * h5sencode_c + * h5sencode_c * PURPOSE - * Call H5Sencode + * Call H5Sencode * INPUTS * - * obj_id - Identifier of the object to be encoded. + * obj_id - Identifier of the object to be encoded. * buf - Buffer for the object to be encoded into. - * nalloc - The size of the allocated buffer. + * nalloc - The size of the allocated buffer. * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * March 26, 2008 + * March 26, 2008 * HISTORY * * SOURCE @@ -1366,21 +1366,21 @@ h5sencode_c (_fcd buf, hid_t_f *obj_id, size_t_f *nalloc ) /****if* H5Sf/h5sextent_equal_c * NAME - * h5sextent_equal_c + * h5sextent_equal_c * PURPOSE - * Call H5Sextent_equal + * Call H5Sextent_equal * INPUTS * * space1_id - First dataspace identifier. - * space2_id - Second dataspace identifier. + * space2_id - Second dataspace identifier. * OUTPUTS * - * equal - TRUE if equal, FALSE if unequal. + * equal - TRUE if equal, FALSE if unequal. * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld - * April 4, 2008 + * April 4, 2008 * HISTORY * * SOURCE diff --git a/fortran/src/H5Tf.c b/fortran/src/H5Tf.c index 7103ca2..8481cbc 100644 --- a/fortran/src/H5Tf.c +++ b/fortran/src/H5Tf.c @@ -1,6 +1,6 @@ /****h* H5Tf/H5Tf * PURPOSE - * This file contains C stubs for H5T Fortran APIs + * This file contains C stubs for H5T Fortran APIs * * COPYRIGHT * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * @@ -30,17 +30,17 @@ * PURPOSE * Call H5Topen2 to open a datatype * INPUTS - * loc_id - file or group identifier - * name - name of the datatype within file or group - * namelen - name length - * tapl_id - datatype access property list identifier + * loc_id - file or group identifier + * name - name of the datatype within file or group + * namelen - name length + * tapl_id - datatype access property list identifier * OUTPUTS - * type_id - dataset identifier + * type_id - dataset identifier * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Saturday, August 14, 1999 + * Saturday, August 14, 1999 * HISTORY * * SOURCE @@ -82,18 +82,18 @@ done: * PURPOSE * Call H5Tcommit2 to commit a datatype * INPUTS - * loc_id - file or group identifier - * name - name of the datatype within file or group - * namelen - name length - * type_id - dataset identifier - * lcpl_id - Link creation property list - * tcpl_id - Datatype creation property list - * tapl_id - Datatype access property list + * loc_id - file or group identifier + * name - name of the datatype within file or group + * namelen - name length + * type_id - dataset identifier + * lcpl_id - Link creation property list + * tcpl_id - Datatype creation property list + * tapl_id - Datatype access property list * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Saturday, August 14, 1999 + * Saturday, August 14, 1999 * HISTORY * * - Added passing optional parameters for version 1.8 @@ -130,12 +130,12 @@ done: * PURPOSE * Call H5Tclose to close the datatype * INPUTS - * type_id - identifier of the datatype to be closed + * type_id - identifier of the datatype to be closed * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Saturday, August 14, 1999 + * Saturday, August 14, 1999 * HISTORY * * SOURCE @@ -160,14 +160,14 @@ h5tclose_c ( hid_t_f *type_id ) * PURPOSE * Call H5Tcopy to copy a datatype * INPUTS - * type_id - identifier of the datatype to be copied + * type_id - identifier of the datatype to be copied * OUTPUTS - * new_type_id - identifier of the new datatype + * new_type_id - identifier of the new datatype * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Saturday, August 14, 1999 + * Saturday, August 14, 1999 * HISTORY * * SOURCE @@ -194,15 +194,15 @@ h5tcopy_c ( hid_t_f *type_id , hid_t_f *new_type_id) * PURPOSE * Call H5Tequal to copy a datatype * INPUTS - * type1_id - datatype identifier - * type2_id - datatype identifier + * type1_id - datatype identifier + * type2_id - datatype identifier * OUTPUTS - * c_flag - flag; indicates if two datatypes are equal or not. + * c_flag - flag; indicates if two datatypes are equal or not. * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Tuesday, February 22, 2000 + * Tuesday, February 22, 2000 * HISTORY * * SOURCE @@ -293,17 +293,17 @@ h5tget_class_c ( hid_t_f *type_id , int_f *classtype) * PURPOSE * Call H5Tget_order to determine byte order * INPUTS - * type_id - identifier of the dataspace + * type_id - identifier of the dataspace * OUTPUTS - * order; possible values are: + * order; possible values are: * H5T_ORDER_LE_F (0) * H5T_ORDER_BE_F (1) * H5T_ORDER_VAX_F (2) * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Saturday, August 14, 1999 + * Saturday, August 14, 1999 * HISTORY * * SOURCE @@ -337,16 +337,16 @@ h5tget_order_c ( hid_t_f *type_id , int_f *order) * PURPOSE * Call H5Tset_order to set byte order * INPUTS - * type_id - identifier of the dataspace - * order; possible values are: + * type_id - identifier of the dataspace + * order; possible values are: * H5T_ORDER_LE_F (0) * H5T_ORDER_BE_F (1) * H5T_ORDER_VAX_F (2) * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Saturday, August 14, 1999 + * Saturday, August 14, 1999 * HISTORY * * SOURCE @@ -378,14 +378,14 @@ h5tset_order_c ( hid_t_f *type_id , int_f *order) * PURPOSE * Call H5Tget_size to get size of the datatype * INPUTS - * type_id - identifier of the dataspace + * type_id - identifier of the dataspace * OUTPUTS - * size (in bytes) + * size (in bytes) * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Saturday, August 14, 1999 + * Saturday, August 14, 1999 * HISTORY * * SOURCE @@ -413,14 +413,14 @@ h5tget_size_c ( hid_t_f *type_id , size_t_f *size) * PURPOSE * Call H5Tget_size to get size of the datatype * INPUTS - * type_id - identifier of the dataspace + * type_id - identifier of the dataspace * OUTPUTS - * size (in bytes) + * size (in bytes) * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Saturday, August 14, 1999 + * Saturday, August 14, 1999 * HISTORY * * SOURCE @@ -449,14 +449,14 @@ h5tset_size_c ( hid_t_f *type_id , size_t_f *size) * PURPOSE * Call H5Tget_precision to get precision of the datatype * INPUTS - * type_id - identifier of the dataspace + * type_id - identifier of the dataspace * OUTPUTS - * precision - number of significant bits + * precision - number of significant bits * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * XIANGYANG SU - * Tuesday, January 25, 2000 + * Tuesday, January 25, 2000 * HISTORY * * SOURCE @@ -484,13 +484,13 @@ h5tget_precision_c ( hid_t_f *type_id , size_t_f *precision) * PURPOSE * Call H5Tset_precision to set precision of the datatype * INPUTS - * type_id - identifier of the dataspace - * precision - number of significant bits + * type_id - identifier of the dataspace + * precision - number of significant bits * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * XIANGYANG SU - * Tuesday, January 25, 2000 + * Tuesday, January 25, 2000 * HISTORY * * SOURCE @@ -518,16 +518,16 @@ h5tset_precision_c ( hid_t_f *type_id , size_t_f *precision) * h5tget_offset_c * PURPOSE * Call H5Tget_offset to get bit offset of the first - * significant bit of the datatype + * significant bit of the datatype * INPUTS - * type_id - identifier of the dataspace + * type_id - identifier of the dataspace * OUTPUTS - * offset - bit offset of the first significant bit + * offset - bit offset of the first significant bit * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * XIANGYANG SU - * Tuesday, January 25, 2000 + * Tuesday, January 25, 2000 * HISTORY * * SOURCE @@ -555,15 +555,15 @@ h5tget_offset_c ( hid_t_f *type_id , size_t_f *offset) * h5tset_offset_c * PURPOSE * Call H5Tset_offset to set bit offset of the first - * significant bit of the datatype + * significant bit of the datatype * INPUTS - * type_id - identifier of the dataspace - * offset - bit offset of the first significant bit + * type_id - identifier of the dataspace + * offset - bit offset of the first significant bit * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * XIANGYANG SU - * Tuesday, January 25, 2000 + * Tuesday, January 25, 2000 * HISTORY * * SOURCE @@ -591,18 +591,18 @@ h5tset_offset_c ( hid_t_f *type_id , size_t_f *offset) * h5tget_pad_c * PURPOSE * Call H5Tget_pad to get the padding type of the least and - * most-significant bit padding + * most-significant bit padding * * INPUTS - * type_id - identifier of the dataspace + * type_id - identifier of the dataspace * OUTPUTS - * lsbpad - padding type of the least significant bit - * msbpad - padding type of the least significant bit + * lsbpad - padding type of the least significant bit + * msbpad - padding type of the least significant bit * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * XIANGYANG SU - * Wednesday, January 26, 2000 + * Wednesday, January 26, 2000 * HISTORY * * SOURCE @@ -631,20 +631,20 @@ h5tget_pad_c ( hid_t_f *type_id , int_f * lsbpad, int_f * msbpad) * NAME * h5tset_pad_c * INPUTS - * type_id - identifier of the dataspace + * type_id - identifier of the dataspace * PURPOSE * Call H5Tset_pad to set the padding type of the least and - * most-significant bit padding + * most-significant bit padding * * INPUTS - * type_id - identifier of the dataspace - * lsbpad - padding type of the least significant bit - * msbpad - padding type of the least significant bit + * type_id - identifier of the dataspace + * lsbpad - padding type of the least significant bit + * msbpad - padding type of the least significant bit * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * XIANGYANG SU - * Wednesday, January 26, 2000 + * Wednesday, January 26, 2000 * HISTORY * * SOURCE @@ -674,14 +674,14 @@ h5tset_pad_c ( hid_t_f *type_id, int_f * lsbpad, int_f* msbpad ) * PURPOSE * Call H5Tget_sign to get sign type for an integer type * INPUTS - * type_id - identifier of the dataspace + * type_id - identifier of the dataspace * OUTPUTS - * sign - sign type for an integer type + * sign - sign type for an integer type * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * XIANGYANG SU - * Wednesday, January 26, 2000 + * Wednesday, January 26, 2000 * HISTORY * * SOURCE @@ -709,13 +709,13 @@ h5tget_sign_c ( hid_t_f *type_id , int_f *sign) * PURPOSE * Call H5Tset_sign to set sign type for an integer type * INPUTS - * type_id - identifier of the dataspace - * sign - sign type for an integer typ + * type_id - identifier of the dataspace + * sign - sign type for an integer typ * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * XIANGYANG SU - * Wednesday, January 26, 2000 + * Wednesday, January 26, 2000 * HISTORY * * SOURCE @@ -744,19 +744,19 @@ h5tset_sign_c ( hid_t_f *type_id , int_f* sign) * h5tget_fields_c * PURPOSE * Call H5Tget_fields to get floating point datatype - * bit field information + * bit field information * INPUTS - * type_id - identifier of the dataspace + * type_id - identifier of the dataspace * OUTPUTS - * epos - exponent bit-position - * esize - size of exponent in bits - * mpos - mantissa bit-position - * msize - size of mantissa in bits + * epos - exponent bit-position + * esize - size of exponent in bits + * mpos - mantissa bit-position + * msize - size of mantissa in bits * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * XIANGYANG SU - * Thursday, January 27, 2000 + * Thursday, January 27, 2000 * HISTORY * * SOURCE @@ -788,18 +788,18 @@ h5tget_fields_c ( hid_t_f *type_id , size_t_f *spos, size_t_f *epos, size_t_f* e * h5tset_fields_c * PURPOSE * Call H5Tset_fields to set floating point datatype - * bit field information + * bit field information * INPUTS - * type_id - identifier of the dataspace - * epos - exponent bit-position - * esize - size of exponent in bits - * mpos - mantissa bit-position - * msize - size of mantissa in bits + * type_id - identifier of the dataspace + * epos - exponent bit-position + * esize - size of exponent in bits + * mpos - mantissa bit-position + * msize - size of mantissa in bits * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * XIANGYANG SU - * Wednesday, January 26, 2000 + * Wednesday, January 26, 2000 * HISTORY * * SOURCE @@ -832,16 +832,16 @@ h5tset_fields_c ( hid_t_f *type_id, size_t_f *spos, size_t_f *epos, size_t_f* es * h5tget_ebias_c * PURPOSE * Call H5Tget_ebias to get exponent bias of a - * floating-point type of the datatype + * floating-point type of the datatype * INPUTS - * type_id - identifier of the dataspace + * type_id - identifier of the dataspace * OUTPUTS - * ebias - exponent bias of a floating-point type of the datatype + * ebias - exponent bias of a floating-point type of the datatype * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Friday, January 27, 2000 + * Friday, January 27, 2000 * HISTORY * * SOURCE @@ -869,15 +869,15 @@ h5tget_ebias_c ( hid_t_f *type_id , size_t_f *ebias) * h5tset_ebias_c * PURPOSE * Call H5Tset_ebias to set exponent bias of a - * floating-point type of the datatype + * floating-point type of the datatype * INPUTS - * type_id - identifier of the dataspace - * ebias - exponent bias of a floating-point type of the datatyp + * type_id - identifier of the dataspace + * ebias - exponent bias of a floating-point type of the datatyp * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Friday, January 27, 2000 + * Friday, January 27, 2000 * HISTORY * * SOURCE @@ -906,16 +906,16 @@ h5tset_ebias_c ( hid_t_f *type_id , size_t_f *ebias) * h5tget_norm_c * PURPOSE * Call H5Tget_norm to get mantissa normalization - * of a floating-point datatype + * of a floating-point datatype * INPUTS - * type_id - identifier of the dataspace + * type_id - identifier of the dataspace * OUTPUTS - * norm - mantissa normalization of a floating-point type + * norm - mantissa normalization of a floating-point type * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Friday, January 27, 2000 + * Friday, January 27, 2000 * HISTORY * * SOURCE @@ -943,15 +943,15 @@ h5tget_norm_c ( hid_t_f *type_id , int_f *norm) * h5tset_norm_c * PURPOSE * Call H5Tset_norm to set mantissa normalization of - * floating-point type of the datatype + * floating-point type of the datatype * INPUTS - * type_id - identifier of the dataspace - * norm - mantissa normalization of a floating-point type + * type_id - identifier of the dataspace + * norm - mantissa normalization of a floating-point type * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Xiangyang Su - * Friday, January 27, 2000 + * Friday, January 27, 2000 * HISTORY * * SOURCE @@ -980,18 +980,18 @@ h5tset_norm_c ( hid_t_f *type_id , int_f *norm) * h5tget_inpad_c * PURPOSE * Call H5Tget_inpad to get the padding type for - * unused bits in floating-point datatypes + * unused bits in floating-point datatypes * * INPUTS - * type_id - identifier of the dataspace + * type_id - identifier of the dataspace * OUTPUTS - * padtype - padding type for - * unused bits in floating-point datatype + * padtype - padding type for + * unused bits in floating-point datatype * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * XIANGYANG SU - * Wednesday, January 26, 2000 + * Wednesday, January 26, 2000 * HISTORY * * SOURCE @@ -1018,20 +1018,20 @@ h5tget_inpad_c ( hid_t_f *type_id , int_f * padtype) * NAME * h5tset_inpad_c * INPUTS - * type_id - identifier of the dataspace + * type_id - identifier of the dataspace * PURPOSE * Call H5Tset_inpad to set the padding type - * unused bits in floating-point datatype + * unused bits in floating-point datatype * * INPUTS - * type_id - identifier of the dataspace - * padtype - padding type for unused bits - * in floating-point datatypes + * type_id - identifier of the dataspace + * padtype - padding type for unused bits + * in floating-point datatypes * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * XIANGYANG SU - * Wednesday, January 26, 2000 + * Wednesday, January 26, 2000 * HISTORY * * SOURCE @@ -1060,17 +1060,17 @@ h5tset_inpad_c ( hid_t_f *type_id, int_f * padtype) * h5tget_cset_c * PURPOSE * Call H5Tget_cset to get character set - * type of a string datatype + * type of a string datatype * * INPUTS - * type_id - identifier of the dataspace + * type_id - identifier of the dataspace * OUTPUTS - * cset - character set type of a string datatype + * cset - character set type of a string datatype * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * XIANGYANG SU - * Wednesday, January 26, 2000 + * Wednesday, January 26, 2000 * HISTORY * * SOURCE @@ -1097,19 +1097,19 @@ h5tget_cset_c ( hid_t_f *type_id , int_f * cset) * NAME * h5tset_cset_c * INPUTS - * type_id - identifier of the dataspace + * type_id - identifier of the dataspace * PURPOSE * Call H5Tset_cset to set character set - * type of a string datatype + * type of a string datatype * * INPUTS - * type_id - identifier of the dataspace - * cset - character set type of a string datatype + * type_id - identifier of the dataspace + * cset - character set type of a string datatype * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * XIANGYANG SU - * Wednesday, January 26, 2000 + * Wednesday, January 26, 2000 * HISTORY * * SOURCE @@ -1138,16 +1138,16 @@ h5tset_cset_c ( hid_t_f *type_id, int_f * cset) * h5tget_strpad_c * PURPOSE * Call H5Tget_strpad to get string padding method - * for a string datatype + * for a string datatype * INPUTS - * type_id - identifier of the dataspace + * type_id - identifier of the dataspace * OUTPUTS - * strpad - string padding method for a string datatype + * strpad - string padding method for a string datatype * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * XIANGYANG SU - * Wednesday, January 26, 2000 + * Wednesday, January 26, 2000 * HISTORY * * SOURCE @@ -1173,19 +1173,19 @@ h5tget_strpad_c ( hid_t_f *type_id , int_f * strpad) * NAME * h5tset_strpad_c * INPUTS - * type_id - identifier of the dataspace + * type_id - identifier of the dataspace * PURPOSE * Call H5Tset_strpad to set string padding method - * for a string datatype + * for a string datatype * * INPUTS - * type_id - identifier of the dataspace - * strpad - string padding method for a string datatype + * type_id - identifier of the dataspace + * strpad - string padding method for a string datatype * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * XIANGYANG SU - * Wednesday, January 26, 2000 + * Wednesday, January 26, 2000 * HISTORY * * SOURCE @@ -1214,16 +1214,16 @@ h5tset_strpad_c ( hid_t_f *type_id, int_f * strpad) * h5tget_nmembers_c * PURPOSE * Call H5Tget_nmembers to get number of fields - * in a compound datatype + * in a compound datatype * INPUTS - * type_id - identifier of the dataspace + * type_id - identifier of the dataspace * OUTPUTS - * num_members - number of fields in a compound datatype + * num_members - number of fields in a compound datatype * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * XIANGYANG SU - * Thursday, February 3, 2000 + * Thursday, February 3, 2000 * HISTORY * * SOURCE @@ -1249,19 +1249,19 @@ h5tget_nmembers_c ( hid_t_f *type_id , int_f * num_members) * h5tget_member_name_c * PURPOSE * Call H5Tget_member_name to get name - * of a compound datatype + * of a compound datatype * INPUTS - * type_id - identifier of the dataspace + * type_id - identifier of the dataspace * OUTPUTS - * member_name - name of a field of a compound datatype + * member_name - name of a field of a compound datatype * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * XIANGYANG SU - * Thursday, February 3, 2000 + * Thursday, February 3, 2000 * HISTORY - * Elena Pourmal - * Added namelen parameter to return length of the name to Fortran user + * Elena Pourmal + * Added namelen parameter to return length of the name to Fortran user * SOURCE */ @@ -1290,15 +1290,15 @@ h5tget_member_name_c ( hid_t_f *type_id ,int_f* idx, _fcd member_name, int_f *na * h5tget_member_index_c * PURPOSE * Call H5Tget_member_index to get an index of - * the specified datatype filed or member. + * the specified datatype filed or member. * INPUTS - * type_id - datatype identifier - * name - name of the datatype within file or group - * namelen - name length + * type_id - datatype identifier + * name - name of the datatype within file or group + * namelen - name length * OUTPUTS - * index - 0-based index + * index - 0-based index * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal * Thursday, September 26, 2002 @@ -1341,19 +1341,19 @@ DONE: * h5tget_member_offset_c * PURPOSE * Call H5Tget_member_offset to get byte offset of the - * beginning of a field within a compound datatype with - * respect to the beginning of the compound data type datum + * beginning of a field within a compound datatype with + * respect to the beginning of the compound data type datum * INPUTS - * type_id - identifier of the dataspace - * member_no - Number of the field whose offset is requested + * type_id - identifier of the dataspace + * member_no - Number of the field whose offset is requested * OUTPUTS - * offset - byte offset of the the beginning of the field of - * a compound datatype + * offset - byte offset of the the beginning of the field of + * a compound datatype * RETURNS - * always 0 + * always 0 * AUTHOR * XIANGYANG SU - * Thursday, February 3, 2000 + * Thursday, February 3, 2000 * HISTORY * * SOURCE @@ -1377,16 +1377,16 @@ h5tget_member_offset_c ( hid_t_f *type_id ,int_f* member_no, size_t_f * offset) * h5tget_array_dims_c * PURPOSE * Call H5Tget_array_dims2 to get - * dimensions of array datatype + * dimensions of array datatype * INPUTS - * type_id - identifier of the array datatype + * type_id - identifier of the array datatype * OUTPUTS - * dims - dimensions(sizes of dimensions) of the array + * dims - dimensions(sizes of dimensions) of the array * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Thursday, November 16, 2000 + * Thursday, November 16, 2000 * HISTORY * * SOURCE @@ -1420,16 +1420,16 @@ DONE: * h5tget_array_ndims_c * PURPOSE * Call H5Tget_array_ndims to get number - * of dimensions of array datatype + * of dimensions of array datatype * INPUTS - * type_id - identifier of the array datatype + * type_id - identifier of the array datatype * OUTPUTS - * ndims - number of dimensions of the array + * ndims - number of dimensions of the array * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Thursday, November 16, 2000 + * Thursday, November 16, 2000 * HISTORY * * SOURCE @@ -1457,16 +1457,16 @@ h5tget_array_ndims_c ( hid_t_f *type_id , int_f * ndims) * h5tget_super_c * PURPOSE * Call H5Tget_super to get base datatype from which - * datatype was derived + * datatype was derived * INPUTS - * type_id - identifier of the array datatype + * type_id - identifier of the array datatype * OUTPUTS - * base_type_id - base datatype identifier + * base_type_id - base datatype identifier * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Thursday, November 16, 2000 + * Thursday, November 16, 2000 * HISTORY * * SOURCE @@ -1495,14 +1495,14 @@ h5tget_super_c ( hid_t_f *type_id , hid_t_f *base_type_id) * h5tget_member_type_c * PURPOSE * Call H5Tget_member_type to get the identifier of a copy of - * the datatype of the field + * the datatype of the field * INPUTS - * type_id - identifier of the datatype - * field_idx - Field index (0-based) of the field type to retrieve + * type_id - identifier of the datatype + * field_idx - Field index (0-based) of the field type to retrieve * OUTPUTS - * datatype - identifier of a copy of the datatype of the field + * datatype - identifier of a copy of the datatype of the field * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * XIANGYANG SU * Thursday, February 3, 2000 @@ -1531,10 +1531,10 @@ h5tget_member_type_c ( hid_t_f *type_id ,int_f* field_idx, hid_t_f * datatype) * PURPOSE * Call H5Tcreate to create a datatype * INPUTS - * cls - class type - * size - size of the class memeber + * cls - class type + * size - size of the class memeber * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal * Thursday, February 17, 2000 @@ -1643,12 +1643,12 @@ h5tpack_c(hid_t_f * type_id) * PURPOSE * Call H5Tarray_create2 to create array datatype * INPUTS - * base_id - identifier of array base datatype - * rank - array's rank - * dims - Size of new member array - * type_id - identifier of the array datatype + * base_id - identifier of array base datatype + * rank - array's rank + * dims - Size of new member array + * type_id - identifier of the array datatype * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal * Thursday, November 16, 2000 @@ -1692,7 +1692,7 @@ DONE: * parent_id - Datatype identifier for the base datatype * OUTPUTS * new_type_id - datatype identifier for the new - * enumeration datatype + * enumeration datatype * RETURNS * 0 on success, -1 on failure * AUTHOR @@ -1767,17 +1767,17 @@ h5tenum_insert_c(hid_t_f *type_id, _fcd name, int_f* namelen, int_f* value) * h5tenum_nameof_c * PURPOSE * Call H5Tenum_nameof to find the symbol name that corresponds to - * the specified value of the enumeration datatype type + * the specified value of the enumeration datatype type * INPUTS - * type_id - identifier of the datatype - * namelen - length of the name - * value - value of the enumeration datatype - * Output: name - Name of the enumeration datatype + * type_id - identifier of the datatype + * namelen - length of the name + * value - value of the enumeration datatype + * Output: name - Name of the enumeration datatype * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * XIANGYANG SU - * Thursday, February 3, 2000 + * Thursday, February 3, 2000 * HISTORY * * SOURCE @@ -1811,17 +1811,17 @@ h5tenum_nameof_c(hid_t_f *type_id, int_f* value, _fcd name, size_t_f* namelen) * h5tenum_valueof_c * PURPOSE * Call H5Tenum_valueof to find the value of that corresponds to - * the specified name of the enumeration datatype type + * the specified name of the enumeration datatype type * INPUTS - * type_id - identifier of the datatype - * name - Name of the enumeration datatype - * namelen - length of name - * Output: value - value of the enumeration datatype + * type_id - identifier of the datatype + * name - Name of the enumeration datatype + * namelen - length of name + * Output: value - value of the enumeration datatype * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * XIANGYANG SU - * Thursday, February 3, 2000 + * Thursday, February 3, 2000 * HISTORY * * SOURCE @@ -1851,16 +1851,16 @@ h5tenum_valueof_c(hid_t_f *type_id, _fcd name, int_f* namelen, int_f* value) * h5tget_member_value_c * PURPOSE * Call H5Tget_member_value to get the value of an - * enumeration datatype member + * enumeration datatype member * INPUTS - * type_id - identifier of the datatype - * member_no - Number of the enumeration datatype member. - * Output: value - value of the enumeration datatype + * type_id - identifier of the datatype + * member_no - Number of the enumeration datatype member. + * Output: value - value of the enumeration datatype * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * XIANGYANG SU - * Thursday, February 3, 2000 + * Thursday, February 3, 2000 * HISTORY * * SOURCE @@ -1886,19 +1886,19 @@ h5tget_member_value_c(hid_t_f *type_id, int_f* member_no, int_f* value) * NAME * h5tset_tag_c * INPUTS - * type_id - identifier of the dataspace + * type_id - identifier of the dataspace * PURPOSE * Call H5Tset_tag to set an opaque datatype tag * INPUTS - * type_id - identifier of the dataspace - * tag - Unique ASCII string with which the opaque - * datatype is to be tagged - * namelen - length of tag + * type_id - identifier of the dataspace + * tag - Unique ASCII string with which the opaque + * datatype is to be tagged + * namelen - length of tag * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * XIANGYANG SU - * Wednesday, January 26, 2000 + * Wednesday, January 26, 2000 * HISTORY * * SOURCE @@ -1929,11 +1929,11 @@ h5tset_tag_c(hid_t_f* type_id, _fcd tag, int_f* namelen) * INPUTS * type_id - identifier of the datatype * OUTPUTS - * tag - Unique ASCII string with which the opaque - * datatype is to be tagged - * taglen - length of tag + * tag - Unique ASCII string with which the opaque + * datatype is to be tagged + * taglen - length of tag * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * XIANGYANG SU * Wednesday, January 26, 2000 @@ -1965,14 +1965,14 @@ h5tget_tag_c(hid_t_f* type_id, _fcd tag, size_t_f* tag_size, int_f* taglen) * PURPOSE * Call H5Tvlen_create to create VL dtatype * INPUTS - * type_id - identifier of the base datatype + * type_id - identifier of the base datatype * OUTPUTS - * vltype_id - identifier of the VL datatype + * vltype_id - identifier of the VL datatype * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, October 23, 2002 + * Wednesday, October 23, 2002 * HISTORY * * SOURCE @@ -1997,17 +1997,17 @@ h5tvlen_create_c(hid_t_f* type_id, hid_t_f *vltype_id) * h5tis_variable_str_c * PURPOSE * Call H5Tis_variable_str to detrmine if the datatype - * is a variable string. + * is a variable string. * INPUTS - * type_id - identifier of the dataspace + * type_id - identifier of the dataspace * OUTPUTS - * flag - 0 if not VL str, 1 if is not - * and negative on failure. + * flag - 0 if not VL str, 1 if is not + * and negative on failure. * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, March 12 , 2003 + * Wednesday, March 12 , 2003 * HISTORY * * SOURCE @@ -2034,13 +2034,13 @@ h5tis_variable_str_c ( hid_t_f *type_id , int_f *flag ) * Call H5Tget_member_class to detrmine ithe class of the compound * datatype member * INPUTS - * type_id - identifier of the dataspace - * member_no - member's index + * type_id - identifier of the dataspace + * member_no - member's index * OUTPUTS - * class - member's class - * and negative on failure. + * class - member's class + * and negative on failure. * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal * Wednesday, April 6, 2005 @@ -2073,12 +2073,12 @@ h5tget_member_class_c ( hid_t_f *type_id , int_f *member_no, int_f *cls ) * PURPOSE * Call H5Tcommit_anon * INPUTS - * loc_id - file or group identifier - * dtype_id - dataset identifier - * tcpl_id - Datatype creation property list - * tapl_id - Datatype access property list + * loc_id - file or group identifier + * dtype_id - dataset identifier + * tcpl_id - Datatype creation property list + * tapl_id - Datatype access property list * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld * February 25, 2008 @@ -2108,10 +2108,10 @@ h5tcommit_anon_c(hid_t_f *loc_id, hid_t_f *dtype_id, * h5tcommitted_c * PURPOSE * Call H5Tcommitted - * dtype_id - dataset identifier + * dtype_id - dataset identifier * RETURNS - * a positive value, for TRUE, if the datatype has been committed, - * or 0 (zero), for FALSE, if the datatype has not been committed. + * a positive value, for TRUE, if the datatype has been committed, + * or 0 (zero), for FALSE, if the datatype has not been committed. * Otherwise returns a negative value. * AUTHOR * M. Scot Breitenfeld @@ -2144,10 +2144,10 @@ h5tcommitted_c(hid_t_f *dtype_id) * buf - Buffer for the data space object to be decoded. * OUTPUTS * - * obj_id - Object_id (non-negative) + * obj_id - Object_id (non-negative) * * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld * April 9, 2008 @@ -2187,11 +2187,11 @@ h5tdecode_c ( _fcd buf, hid_t_f *obj_id ) * Call H5Tencode * INPUTS * - * obj_id - Identifier of the object to be encoded. + * obj_id - Identifier of the object to be encoded. * buf - Buffer for the object to be encoded into. - * nalloc - The size of the allocated buffer. + * nalloc - The size of the allocated buffer. * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld * April 9, 2008 @@ -2256,11 +2256,11 @@ h5tencode_c (_fcd buf, hid_t_f *obj_id, size_t_f *nalloc ) * PURPOSE * Call H5Tget_create_plist * INPUTS - * dtype_id - Datatype identifier + * dtype_id - Datatype identifier * OUTPUTS - * dtpl_id - Datatype property list identifier + * dtpl_id - Datatype property list identifier * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld * April 9, 2008 @@ -2289,12 +2289,12 @@ h5tget_create_plist_c ( hid_t_f *dtype_id, hid_t_f *dtpl_id) * Call H5Tcompiler_conv * INPUTS * - * src_id - Identifier for the source datatype. - * dst_id - Identifier for the destination datatype. + * src_id - Identifier for the source datatype. + * dst_id - Identifier for the destination datatype. * OUTPUTS - * c_flag - flag; TRUE for compiler conversion, FALSE for library conversion + * c_flag - flag; TRUE for compiler conversion, FALSE for library conversion * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M.Scot Breitenfeld * April 9, 2008 @@ -2323,12 +2323,12 @@ h5tcompiler_conv_c ( hid_t_f *src_id, hid_t_f *dst_id, int_f *c_flag) * Call H5Tget_native_type * INPUTS * - * dtype_id - Datatype identifier for the dataset datatype. - * direction - Direction of search. + * dtype_id - Datatype identifier for the dataset datatype. + * direction - Direction of search. * OUTPUTS - * native_dtype_id - The native datatype identifier for the specified dataset datatype + * native_dtype_id - The native datatype identifier for the specified dataset datatype * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * M. Scot Breitenfeld * June 18, 2008 diff --git a/fortran/src/H5Zf.c b/fortran/src/H5Zf.c index 887ec17..a8cf1c2 100644 --- a/fortran/src/H5Zf.c +++ b/fortran/src/H5Zf.c @@ -1,6 +1,6 @@ /****h* H5Zf/H5Zf * PURPOSE - * This file contains C stubs for H5Z Fortran APIs + * This file contains C stubs for H5Z Fortran APIs * * COPYRIGHT * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * @@ -25,16 +25,16 @@ /****if* H5Zf/h5zunregister_c * NAME - * h5zunregister_c + * h5zunregister_c * PURPOSE - * Call H5Zunregister to unregister filter + * Call H5Zunregister to unregister filter * INPUTS - * filter identifier + * filter identifier * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR * Elena Pourmal - * Wednesday, March 12, 2003 + * Wednesday, March 12, 2003 * HISTORY * * SOURCE @@ -92,7 +92,7 @@ h5zfilter_avail_c ( int_f *filter , int_f *flag ) /****if* H5Zf/h5zget_filter_info_c * NAME - * h5zget_filter_info_c + * h5zget_filter_info_c * PURPOSE * Call H5Zget_filter_info to find if filter has its encoder * and/or its decoder available diff --git a/fortran/src/H5_f.c b/fortran/src/H5_f.c index fa96ebe..90edfa7 100644 --- a/fortran/src/H5_f.c +++ b/fortran/src/H5_f.c @@ -1,6 +1,6 @@ /****ih* H5_f/H5_f * PURPOSE - * This file contains C stubs for H5 Fortran APIs + * This file contains C stubs for H5 Fortran APIs * * COPYRIGHT * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * @@ -30,16 +30,16 @@ * Initialize predefined datatypes in Fortran * INPUTS * types - array with the predefined Native Fortran - * type, its element and length must be the - * same as the types array defined in the + * type, its element and length must be the + * same as the types array defined in the * H5f90global.F90 * floatingtypes - array with the predefined Floating Fortran - * type, its element and length must be the - * same as the floatingtypes array defined in the + * type, its element and length must be the + * same as the floatingtypes array defined in the * H5f90global.F90 * integertypes - array with the predefined Integer Fortran - * type, its element and length must be the - * same as the integertypes array defined in the + * type, its element and length must be the + * same as the integertypes array defined in the * H5f90global.F90 * RETURNS * 0 on success, -1 on failure @@ -341,31 +341,31 @@ h5init_types_c( hid_t_f * types, hid_t_f * floatingtypes, hid_t_f * integertypes * Closes predefined datatype in Fortran * INPUTS * types - array with the predefined Native Fortran - * type, its element and length must be the - * same as the types array defined in the + * type, its element and length must be the + * same as the types array defined in the * H5f90global.F90 * lentypes - length of the types array, which must be the - * same as the length of types array defined - * in the H5f90global.F90 + * same as the length of types array defined + * in the H5f90global.F90 * floatingtypes - array with the predefined Floating Fortran - * type, its element and length must be the - * same as the floatingtypes array defined in the + * type, its element and length must be the + * same as the floatingtypes array defined in the * H5f90global.F90 * floatinglen - length of the floatingtypes array, which must be the - * same as the length of floatingtypes array defined - * in the H5f90global.F90 + * same as the length of floatingtypes array defined + * in the H5f90global.F90 * integertypes - array with the predefined Integer Fortran - * type, its element and length must be the - * same as the integertypes array defined in the + * type, its element and length must be the + * same as the integertypes array defined in the * H5f90global.F90 * integerlen - length of the floatingtypes array, which must be the - * same as the length of floatingtypes array defined - * in the H5f90global.F90 + * same as the length of floatingtypes array defined + * in the H5f90global.F90 * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR - * Elena Pourmal - * Tuesday, August 3, 1999 + * Elena Pourmal + * Tuesday, August 3, 1999 * SOURCE */ int_f @@ -593,11 +593,11 @@ h5init_flags_c( int_f *h5d_flags, size_t_f *h5d_size_flags, h5o_flags[6] = (int_f)H5O_COPY_ALL; /* All object copying flags (for internal checking) */ /* Flags for shared message indexes. - * Pass these flags in using the mesg_type_flags parameter in + * Pass these flags in using the mesg_type_flags parameter in * H5P_set_shared_mesg_index. * (Developers: These flags correspond to object header message type IDs, - * but we need to assign each kind of message to a different bit so that - * one index can hold multiple types.) + * but we need to assign each kind of message to a different bit so that + * one index can hold multiple types.) */ h5o_flags[7] = (int_f)H5O_SHMESG_NONE_FLAG; /* No shared messages */ h5o_flags[8] = (int_f)H5O_SHMESG_SDSPACE_FLAG; /* Simple Dataspace Message. */ @@ -616,7 +616,7 @@ h5init_flags_c( int_f *h5d_flags, size_t_f *h5d_size_flags, h5o_flags[19] = (int_f)H5O_HDR_ALL_FLAGS; /* Maximum shared message values. Number of indexes is 8 to allow room to add - * new types of messages. + * new types of messages. */ h5o_flags[20] = (int_f)H5O_SHMESG_MAX_NINDEXES; h5o_flags[21] = (int_f)H5O_SHMESG_MAX_LIST_SIZE; @@ -796,14 +796,14 @@ h5init1_flags_c(int_f *h5lib_flags) /****if* H5_f/h5open_c * NAME - * h5open_c + * h5open_c * PURPOSE - * Calls H5open call to initialize C HDF5 library + * Calls H5open call to initialize C HDF5 library * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR - * Elena Pourmal - * Friday, November 17, 2000 + * Elena Pourmal + * Friday, November 17, 2000 * * SOURCE */ @@ -819,13 +819,13 @@ h5open_c(void) } /****if* H5_f/h5close_c * NAME - * h5close_c + * h5close_c * PURPOSE - * Calls H5close call to close C HDF5 library + * Calls H5close call to close C HDF5 library * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR - * Elena Pourmal + * Elena Pourmal * SOURCE */ int_f @@ -841,23 +841,23 @@ h5close_c(void) /****if* H5_f/h5get_libversion_c * NAME - * h5get_libversion_c + * h5get_libversion_c * PURPOSE - * Calls H5get_libversion function + * Calls H5get_libversion function * to retrieve library version info. * INPUTS * - * None + * None * OUTPUTS * - * majnum - the major version of the library - * minnum - the minor version of the library - * relnum - the release version of the library + * majnum - the major version of the library + * minnum - the minor version of the library + * relnum - the release version of the library * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR - * Elena Pourmal - * Tuesday, September 24, 2002 + * Elena Pourmal + * Tuesday, September 24, 2002 * SOURCE * */ @@ -880,23 +880,23 @@ h5get_libversion_c(int_f *majnum, int_f *minnum, int_f *relnum) /****if* H5_f/h5check_version_c * NAME - * h5check_version_c + * h5check_version_c * PURPOSE - * Calls H5check_version function + * Calls H5check_version function * to verify library version info. * INPUTS * - * majnum - the major version of the library - * minnum - the minor version of the library - * relnum - the release version of the library + * majnum - the major version of the library + * minnum - the minor version of the library + * relnum - the release version of the library * OUTPUTS * - * None + * None * RETURNS - * 0 on success, aborts on failure + * 0 on success, aborts on failure * AUTHOR - * Elena Pourmal - * Tuesday, September 24, 2002 + * Elena Pourmal + * Tuesday, September 24, 2002 * SOURCE */ int_f @@ -918,14 +918,14 @@ h5check_version_c(int_f *majnum, int_f *minnum, int_f *relnum) /****if* H5_f/h5garbage_collect_c * NAME - * h5garbage_collect_c + * h5garbage_collect_c * PURPOSE - * Calls H5garbage_collect to collect on all free-lists of all types + * Calls H5garbage_collect to collect on all free-lists of all types * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR - * Elena Pourmal - * Tuesday, September 24, 2002 + * Elena Pourmal + * Tuesday, September 24, 2002 * SOURCE */ int_f @@ -941,14 +941,14 @@ h5garbage_collect_c(void) /****if* H5_f/h5dont_atexit_c * NAME - * h5dont_atexit_c + * h5dont_atexit_c * PURPOSE - * Calls H5dont_atexit not to install atexit cleanup routine + * Calls H5dont_atexit not to install atexit cleanup routine * RETURNS - * 0 on success, -1 on failure + * 0 on success, -1 on failure * AUTHOR - * Elena Pourmal - * Tuesday, September 24, 2002 + * Elena Pourmal + * Tuesday, September 24, 2002 * SOURCE */ int_f diff --git a/fortran/src/H5f90kit.c b/fortran/src/H5f90kit.c index 0bc721f..c6c874f 100644 --- a/fortran/src/H5f90kit.c +++ b/fortran/src/H5f90kit.c @@ -1,6 +1,6 @@ /****h* H5f90kit/H5f90kit * PURPOSE - * Routines from HDF4 to deal with C-FORTRAN issues: + * Routines from HDF4 to deal with C-FORTRAN issues: * * HD5f2cstring -- convert a Fortran string to a C string * HD5packFstring -- convert a C string into a Fortran string @@ -31,16 +31,16 @@ /****if* H5f90kit/HDf2cstring * NAME * HD5f2cstring -- convert a Fortran string to a C string - * char * HDf2cstring(fdesc, len) + * char * HDf2cstring(fdesc, len) * INPUTS * _fcd fdesc; IN: Fortran string descriptor - * int len; IN: length of Fortran string + * int len; IN: length of Fortran string * RETURNS - * Pointer to the C string if success, else NULL + * Pointer to the C string if success, else NULL * PURPOSE - * Chop off trailing blanks off of a Fortran string and - * move it into a newly allocated C string. It is up - * to the user to free this string. + * Chop off trailing blanks off of a Fortran string and + * move it into a newly allocated C string. It is up + * to the user to free this string. * SOURCE */ char * @@ -72,21 +72,21 @@ HD5f2cstring(_fcd fdesc, size_t len) /****if* H5f90kit/HD5packFstring * NAME * HD5packFstring -- convert a C string into a Fortran string - * int HD5packFstring(src, dest, len) + * int HD5packFstring(src, dest, len) * INPUTS - * char * src; IN: source string - * int len; IN: length of string + * char * src; IN: source string + * int len; IN: length of string * OUTPUTS - * char * dest; OUT: destination + * char * dest; OUT: destination * RETURNS * SUCCEED / FAIL * PURPOSE - * given a NULL terminated C string 'src' convert it to - * a space padded Fortran string 'dest' of length 'len' + * given a NULL terminated C string 'src' convert it to + * a space padded Fortran string 'dest' of length 'len' * - * This is very similar to HDc2fstr except that function does - * it in place and this one copies. We should probably only - * support one of these. + * This is very similar to HDc2fstr except that function does + * it in place and this one copies. We should probably only + * support one of these. * SOURCE */ void |