summaryrefslogtreecommitdiffstats
path: root/fortran/src/H5Af.c
diff options
context:
space:
mode:
authorScot Breitenfeld <brtnfld@hdfgroup.org>2011-09-27 05:02:38 (GMT)
committerScot Breitenfeld <brtnfld@hdfgroup.org>2011-09-27 05:02:38 (GMT)
commit4af3cd2b7a89b2eeed05d5ec0b0641ca7c2545bc (patch)
tree01f90619962c447280074bb8d10ae5c7b2b9acbc /fortran/src/H5Af.c
parenta07004c825e3a4e4b61269fd3e5f2b57092f073c (diff)
downloadhdf5-4af3cd2b7a89b2eeed05d5ec0b0641ca7c2545bc.zip
hdf5-4af3cd2b7a89b2eeed05d5ec0b0641ca7c2545bc.tar.gz
hdf5-4af3cd2b7a89b2eeed05d5ec0b0641ca7c2545bc.tar.bz2
[svn-r21421] Merged the Fortran 2003 changes from the trunk into the 1.8 branch, used:
svn merge -r 20506:21414 https://svn.hdfgroup.uiuc.edu/hdf5/trunk/fortran Tested: jam (gnu, intel, pgi compilers) Also merged effected non-Fortran files: svn merge -r21247:r21248 https://svn.hdfgroup.uiuc.edu/hdf5/trunk/src/libhdf5.settings.in
Diffstat (limited to 'fortran/src/H5Af.c')
-rw-r--r--fortran/src/H5Af.c913
1 files changed, 652 insertions, 261 deletions
diff --git a/fortran/src/H5Af.c b/fortran/src/H5Af.c
index 8e6158e..896736d 100644
--- a/fortran/src/H5Af.c
+++ b/fortran/src/H5Af.c
@@ -1,4 +1,9 @@
-/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+/****h* H5Af/H5Af
+ * PURPOSE
+ * This file contains C stubs for H5A Fortran APIs
+ *
+ * COPYRIGHT
+ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by The HDF Group. *
* Copyright by the Board of Trustees of the University of Illinois. *
* All rights reserved. *
@@ -11,31 +16,41 @@
* is linked from the top-level documents page. It can also be found at *
* http://hdfgroup.org/HDF5/doc/Copyright.html. If you do not have *
* access to either file, you may request a copy from help@hdfgroup.org. *
- * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
-
-/* This files contains C stubs for H5A Fortran APIs */
+ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+ *
+ ******
+*/
#include "H5f90.h"
#include "H5Eprivate.h"
-/*----------------------------------------------------------------------------
- * Name: h5acreate_c
- * Purpose: Call H5Acreate2 to create an attribute
- * Inputs: obj_id - object identifier
+/****if* H5Af/h5acreate_c
+ * NAME
+ * h5acreate_c
+ * PURPOSE
+ * 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
- * Outputs: attr_id - attribute identifier
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * OUTPUTS
+ * attr_id - attribute identifier
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Thursday, August 12, 1999
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5acreate_c(hid_t_f *obj_id, _fcd name, size_t_f *namelen, hid_t_f *type_id,
hid_t_f *space_id, hid_t_f *crt_prp, hid_t_f *aapl, hid_t_f *attr_id)
+/*******/
{
char *c_name = NULL; /* Buffer to hold C string */
int_f ret_value = 0; /* Return value */
@@ -58,20 +73,29 @@ done:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5aopen_name _c
- * Purpose: Call H5Aopen to open an attribute
- * Inputs: obj_id - object identifier
+/****if* H5Af/h5aopen_name_c
+ * NAME
+ * h5aopen_name_c
+ * PURPOSE
+ * Call H5Aopen to open an attribute
+ * INPUTS
+ * obj_id - object identifier
* name - name of the attribute
* namelen - name length
- * Outputs: attr_id - dataset identifier
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * OUTPUTS
+ * attr_id - dataset identifier
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Thursday, August 12, 1999
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5aopen_name_c (hid_t_f *obj_id, _fcd name, size_t_f *namelen, hid_t_f *attr_id)
+/*******/
{
char *c_name = NULL; /* Buffer to hold C string */
int_f ret_value = 0; /* Return value */
@@ -94,22 +118,30 @@ done:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5awritec_c
- * Purpose: Call h5awrite_c to write a character attribute
- * Inputs: attr_id - dataset identifier
+/****if* H5Af/h5awritec_c
+ * NAME
+ * h5awritec_c
+ * PURPOSE
+ * Call h5awrite_c to write a character attribute
+ * INPUTS
+ * attr_id - dataset identifier
* mem_type_id - memory datatype identifier
* buf - character data buffer
* dims - array to store dimensions sizes of buf; used only
* by Fortran routine.
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Thursday , August 12, 1999
- * Modifications: dims paramete added.
+ * HISTORY
+ * dims paramete added.
* April 4, 2001
- *---------------------------------------------------------------------------*/
+ * SOURCE
+*/
int_f
nh5awritec_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -118,6 +150,7 @@ nh5awritec_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
}
int_f
nh5awritec_s_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -127,6 +160,7 @@ nh5awritec_s_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
int_f
nh5awritec_1_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -136,6 +170,7 @@ nh5awritec_1_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
int_f
nh5awritec_2_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -145,6 +180,7 @@ nh5awritec_2_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
int_f
nh5awritec_3_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -154,6 +190,7 @@ nh5awritec_3_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
int_f
nh5awritec_4_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -163,6 +200,7 @@ nh5awritec_4_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
int_f
nh5awritec_5_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -172,6 +210,7 @@ nh5awritec_5_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
int_f
nh5awritec_6_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -181,6 +220,7 @@ nh5awritec_6_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
int_f
nh5awritec_7_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -190,26 +230,34 @@ nh5awritec_7_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
-/*----------------------------------------------------------------------------
- * Name: h5awrite_c
- * Purpose: Call H5Awrite to write a attribute
- * Inputs: attr_id - attribute identifier
+/****if* H5Af/h5awrite_c
+ * NAME
+ * h5awrite_c
+ * PURPOSE
+ * Call H5Awrite to write a attribute
+ * INPUTS
+ * attr_id - attribute identifier
* mem_type_id - memory datatype identifier
* buf - data buffer
* dims - array to store dimensions sizes of buf; used only
* by Fortran routine.
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Thursday, August 12, 1999
- * Modifications: dims parameter added
+ * HISTORY
+ * dims parameter added
* April 4, 2001
* Added nh5awrite_integer(real,double)_s,1-7 functions to eliminate
* complains about wrong parameters types in h5awrite_c function
* called by Fortran routines.
* October 9, 2006 EIP
- *---------------------------------------------------------------------------*/
+ * SOURCE
+*/
int_f
nh5awrite_integer_s_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -219,6 +267,7 @@ nh5awrite_integer_s_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void U
int_f
nh5awrite_integer_1_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -228,6 +277,7 @@ nh5awrite_integer_1_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void U
int_f
nh5awrite_integer_2_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -237,6 +287,7 @@ nh5awrite_integer_2_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void U
int_f
nh5awrite_integer_3_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -246,6 +297,7 @@ nh5awrite_integer_3_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void U
int_f
nh5awrite_integer_4_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -255,6 +307,7 @@ nh5awrite_integer_4_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void U
int_f
nh5awrite_integer_5_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -264,6 +317,7 @@ nh5awrite_integer_5_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void U
int_f
nh5awrite_integer_6_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -273,6 +327,7 @@ nh5awrite_integer_6_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void U
int_f
nh5awrite_integer_7_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -282,6 +337,7 @@ nh5awrite_integer_7_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void U
int_f
nh5awrite_real_s_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -291,6 +347,7 @@ nh5awrite_real_s_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUS
int_f
nh5awrite_real_1_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -300,6 +357,7 @@ nh5awrite_real_1_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUS
int_f
nh5awrite_real_2_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -309,6 +367,7 @@ nh5awrite_real_2_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUS
int_f
nh5awrite_real_3_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -318,6 +377,7 @@ nh5awrite_real_3_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUS
int_f
nh5awrite_real_4_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -327,6 +387,7 @@ nh5awrite_real_4_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUS
int_f
nh5awrite_real_5_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -336,6 +397,7 @@ nh5awrite_real_5_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUS
int_f
nh5awrite_real_6_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -345,6 +407,7 @@ nh5awrite_real_6_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUS
int_f
nh5awrite_real_7_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -354,6 +417,7 @@ nh5awrite_real_7_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUS
int_f
nh5awrite_double_s_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -363,6 +427,7 @@ nh5awrite_double_s_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UN
int_f
nh5awrite_double_1_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -372,6 +437,7 @@ nh5awrite_double_1_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UN
int_f
nh5awrite_double_2_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -381,6 +447,7 @@ nh5awrite_double_2_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UN
int_f
nh5awrite_double_3_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -390,6 +457,7 @@ nh5awrite_double_3_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UN
int_f
nh5awrite_double_4_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -399,6 +467,7 @@ nh5awrite_double_4_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UN
int_f
nh5awrite_double_5_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -408,6 +477,7 @@ nh5awrite_double_5_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UN
int_f
nh5awrite_double_6_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -417,6 +487,7 @@ nh5awrite_double_6_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UN
int_f
nh5awrite_double_7_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED *dims)
+/******/
{
/*
* Call h5awrite_c function.
@@ -426,6 +497,7 @@ nh5awrite_double_7_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UN
int_f
nh5awrite_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED *dims)
+/******/
{
int_f ret_value=0; /* Return value */
@@ -440,26 +512,35 @@ done:
}
-/*----------------------------------------------------------------------------
- * Name: h5areadc_c
- * Purpose: Call h5aread_c to read character attribute
- * Inputs: dset_id - dataset identifier
+/****if* H5Af/h5areadc_c
+ * NAME
+ * h5areadc_c
+ * PURPOSE
+ * Call h5aread_c to read character attribute
+ * INPUTS
+ * dset_id - dataset identifier
* mem_type_id - memory datatype identifier
* dims - array to store dimensions sizes of buf; used only
* by Fortran routine.
- * Outputs: buf - character data buffer
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * OUTPUTS
+ * buf - character data buffer
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Thursday, August 12, 1999
- * Modifications: dims parameter added.
+ * HISTORY
+ * dims parameter added.
* April 4, 2001
* Added nh5areadc_s,1-7 functions to eliminate
* complains about wrong parameters types in h5awrite_c function
* called by Fortran routines.
* October 9, 2006 EIP
- *---------------------------------------------------------------------------*/
+ * SOURCE
+*/
int_f
nh5areadc_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -468,6 +549,7 @@ nh5areadc_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
}
int_f
nh5areadc_s_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -477,6 +559,7 @@ nh5areadc_s_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
int_f
nh5areadc_1_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -486,6 +569,7 @@ nh5areadc_1_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
int_f
nh5areadc_2_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -495,6 +579,7 @@ nh5areadc_2_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
int_f
nh5areadc_3_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -504,6 +589,7 @@ nh5areadc_3_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
int_f
nh5areadc_4_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -513,6 +599,7 @@ nh5areadc_4_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
int_f
nh5areadc_5_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -522,6 +609,7 @@ nh5areadc_5_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
int_f
nh5areadc_6_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -530,6 +618,7 @@ nh5areadc_6_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
}
int_f
nh5areadc_7_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -539,26 +628,35 @@ nh5areadc_7_c (hid_t_f *attr_id, hid_t_f *mem_type_id, _fcd buf, void *dims)
-/*----------------------------------------------------------------------------
- * Name: h5aread_c
- * Purpose: Call H5Aread to read an attribute
- * Inputs: dset_id - dataset identifier
+/****if* H5Af/h5aread_c
+ * NAME
+ * h5aread_c
+ * PURPOSE
+ * Call H5Aread to read an attribute
+ * INPUTS
+ * dset_id - dataset identifier
* mem_type_id - memory datatype identifier
* dims - array to store dimensions sizes of buf; used only
* by Fortran routine.
- * Outputs: buf - data buffer
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * OUTPUTS
+ * buf - data buffer
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Thursday, August 12, 1999
- * Modifications: dims paramete added.
+ * HISTORY
+ * dims paramete added.
* April 4, 2001
* Added nh5aread_integer(real,double)_s,1-7 functions to eliminate
* complains about wrong parameters types in h5awrite_c function
* called by Fortran routines.
* October 9, 2006 EIP
- *---------------------------------------------------------------------------*/
+ * SOURCE
+*/
int_f
nh5aread_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED * dims)
+/******/
{
int_f ret_value=0; /* Return value */
@@ -574,6 +672,7 @@ done:
int_f
nh5aread_integer_s_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED * dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -583,6 +682,7 @@ nh5aread_integer_s_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UN
int_f
nh5aread_integer_1_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED * dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -592,6 +692,7 @@ nh5aread_integer_1_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UN
int_f
nh5aread_integer_2_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED * dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -601,6 +702,7 @@ nh5aread_integer_2_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UN
int_f
nh5aread_integer_3_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED * dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -610,6 +712,7 @@ nh5aread_integer_3_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UN
int_f
nh5aread_integer_4_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED * dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -619,6 +722,7 @@ nh5aread_integer_4_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UN
int_f
nh5aread_integer_5_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED * dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -628,6 +732,7 @@ nh5aread_integer_5_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UN
int_f
nh5aread_integer_6_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED * dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -637,6 +742,7 @@ nh5aread_integer_6_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UN
int_f
nh5aread_integer_7_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED * dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -646,6 +752,7 @@ nh5aread_integer_7_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UN
int_f
nh5aread_real_s_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED * dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -655,6 +762,7 @@ nh5aread_real_s_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSE
int_f
nh5aread_real_1_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED * dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -664,6 +772,7 @@ nh5aread_real_1_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSE
int_f
nh5aread_real_2_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED * dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -673,6 +782,7 @@ nh5aread_real_2_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSE
int_f
nh5aread_real_3_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED * dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -682,6 +792,7 @@ nh5aread_real_3_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSE
int_f
nh5aread_real_4_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED * dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -691,6 +802,7 @@ nh5aread_real_4_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSE
int_f
nh5aread_real_5_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED * dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -700,6 +812,7 @@ nh5aread_real_5_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSE
int_f
nh5aread_real_6_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED * dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -709,6 +822,7 @@ nh5aread_real_6_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSE
int_f
nh5aread_real_7_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED * dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -718,6 +832,7 @@ nh5aread_real_7_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSE
int_f
nh5aread_double_s_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED * dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -727,6 +842,7 @@ nh5aread_double_s_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNU
int_f
nh5aread_double_1_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED * dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -736,6 +852,7 @@ nh5aread_double_1_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNU
int_f
nh5aread_double_2_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED * dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -745,6 +862,7 @@ nh5aread_double_2_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNU
int_f
nh5aread_double_3_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED * dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -754,6 +872,7 @@ nh5aread_double_3_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNU
int_f
nh5aread_double_4_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED * dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -763,6 +882,7 @@ nh5aread_double_4_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNU
int_f
nh5aread_double_5_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED * dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -772,6 +892,7 @@ nh5aread_double_5_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNU
int_f
nh5aread_double_6_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED * dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -781,6 +902,7 @@ nh5aread_double_6_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNU
int_f
nh5aread_double_7_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNUSED * dims)
+/******/
{
/*
* Call h5aread_c function.
@@ -789,18 +911,26 @@ nh5aread_double_7_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf, void UNU
}
-/*----------------------------------------------------------------------------
- * Name: h5aclose_c
- * Purpose: Call H5Aclose to close an attribute
- * Inputs: attr_id - identifier of an attribute to be closed
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+/****if* H5Af/h5aclose_c
+ * NAME
+ * h5aclose_c
+ * PURPOSE
+ * Call H5Aclose to close an attribute
+ * INPUTS
+ * attr_id - identifier of an attribute to be closed
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Thursday, August 12, 1999
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5aclose_c ( hid_t_f *attr_id )
+/******/
{
int_f ret_value=0; /* Return value */
@@ -811,19 +941,27 @@ done:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5adelete_c
- * Purpose: Call H5Adelete to delete an attribute
- * Inputs: obj_id - object identifier
+/****if* H5Af/h5adelete_c
+ * NAME
+ * h5adelete_c
+ * PURPOSE
+ * Call H5Adelete to delete an attribute
+ * INPUTS
+ * obj_id - object identifier
* name - name of the attribute
* namelen - name length
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Thursday, August 12, 1999
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5adelete_c (hid_t_f *obj_id, _fcd name, size_t_f *namelen)
+/******/
{
char *c_name = NULL; /* Buffer to hold C string */
int_f ret_value = 0; /* Return value */
@@ -848,19 +986,28 @@ done:
}
-/*----------------------------------------------------------------------------
- * Name: h5aopen_idx_c
- * Purpose: Call H5Aopen_by_idx to open an attribute
- * Inputs: obj_id - object identifier
+/****if* H5Af/h5aopen_idx_c
+ * NAME
+ * h5aopen_idx_c
+ * PURPOSE
+ * Call H5Aopen_by_idx to open an attribute
+ * INPUTS
+ * obj_id - object identifier
* idx - attribute index ( zero based)
- * Outputs: attr_id - attribute identifier
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * OUTPUTS
+ * attr_id - attribute identifier
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Thursday, August 12, 1999
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5aopen_idx_c (hid_t_f *obj_id, int_f *idx, hid_t_f *attr_id)
+/******/
{
int_f ret_value = 0; /* Return value */
@@ -875,18 +1022,27 @@ done:
}
-/*----------------------------------------------------------------------------
- * Name: h5aget_space_c
- * Purpose: Call H5Aget_space to get attribute's dataspace
- * Inputs: attr_id - attribute identifier
- * Outputs: space_id - dataspace identifier
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+/****if* H5Af/h5aget_space_c
+ * NAME
+ * h5aget_space_c
+ * PURPOSE
+ * Call H5Aget_space to get attribute's dataspace
+ * INPUTS
+ * attr_id - attribute identifier
+ * OUTPUTS
+ * space_id - dataspace identifier
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Thursday, August 12, 1999
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5aget_space_c (hid_t_f *attr_id, hid_t_f *space_id)
+/******/
{
int_f ret_value=0; /* Return value */
@@ -900,18 +1056,27 @@ done:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5aget_type_c
- * Purpose: Call H5Aget_space to get attribute's datatype
- * Inputs: attr_id - attribute identifier
- * Outputs: type_id - datatype identifier
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+/****if* H5Af/h5aget_type_c
+ * NAME
+ * h5aget_type_c
+ * PURPOSE
+ * Call H5Aget_space to get attribute's datatype
+ * INPUTS
+ * attr_id - attribute identifier
+ * OUTPUTS
+ * type_id - datatype identifier
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Thursday, August 12, 1999
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5aget_type_c (hid_t_f *attr_id, hid_t_f *type_id)
+/******/
{
int_f ret_value=0; /* Return value */
@@ -925,19 +1090,27 @@ done:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5aget_num_attrs_c
- * Purpose: Call H5Oget_info to determine number of
+/****if* H5Af/h5aget_num_attrs_c
+ * NAME
+ * h5aget_num_attrs_c
+ * PURPOSE
+ * Call H5Oget_info to determine number of
* attributes of an object
- * Inputs: obj_id - object identifier
+ * INPUTS
+ * obj_id - object identifier
* attr_num - number of attributes
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Thursday, August 12, 1999
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5aget_num_attrs_c (hid_t_f *obj_id, int_f *attr_num)
+/******/
{
H5O_info_t oinfo; /* Object info */
int_f ret_value = 0; /* Return value */
@@ -955,19 +1128,28 @@ done:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5aget_name_c
- * Purpose: Call H5Aget_name to get attribute's name
- * Inputs: attr_id - attribute identifier
+/****if* H5Af/h5aget_name_c
+ * NAME
+ * h5aget_name_c
+ * PURPOSE
+ * Call H5Aget_name to get attribute's name
+ * INPUTS
+ * attr_id - attribute identifier
* bufsize - size of the buffer
- * Outputs: buf - buffer to hold the name
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * OUTPUTS
+ * buf - buffer to hold the name
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Thursday, August 12, 1999
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5aget_name_c(hid_t_f *attr_id, size_t_f *bufsize, _fcd buf)
+/******/
{
size_t c_bufsize;
char *c_buf=NULL; /* Buffer to hold C string */
@@ -997,19 +1179,28 @@ done:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5aget_storage_size_c
- * Purpose: Call H5Aget_storage_size
- * Inputs: attr_id - identifier of an attribute
- * Outputs: size - attributes storage requirements
- * Returns: 0 on success, -1 on failure
- * Programmer: M. S. Breitenfeld
+/****if* H5Af/h5aget_storage_size_c
+ * NAME
+ * h5aget_storage_size_c
+ * PURPOSE
+ * Call H5Aget_storage_size
+ * INPUTS
+ * attr_id - identifier of an attribute
+ * OUTPUTS
+ * size - attributes storage requirements
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* January, 2008
- * Modifications: N/A
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ * N/A
+ * SOURCE
+*/
int_f
nh5aget_storage_size_c ( hid_t_f *attr_id, hsize_t_f *size)
+/******/
{
int_f ret_value=0; /* Return value */
@@ -1020,19 +1211,28 @@ done:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5aget_create_plist_c
- * Purpose: Call H5Aget_create_plist
- * Inputs: attr_id - identifier of an attribute
- * Outputs: creation_prop_id - Identifier for the attribute’s creation property
- * Returns: 0 on success, -1 on failure
- * Programmer: M. S. Breitenfeld
+/****if* H5Af/h5aget_create_plist_c
+ * NAME
+ * h5aget_create_plist_c
+ * PURPOSE
+ * Call H5Aget_create_plist
+ * INPUTS
+ * attr_id - identifier of an attribute
+ * OUTPUTS
+ * creation_prop_id - Identifier for the attribute’s creation property
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* January, 2008
- * Modifications: N/A
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ * N/A
+ * SOURCE
+*/
int_f
nh5aget_create_plist_c ( hid_t_f *attr_id, hid_t_f *creation_prop_id)
+/******/
{
int_f ret_value=0; /* Return value */
@@ -1043,10 +1243,13 @@ done:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5arename_by_name_c
- * Purpose: Calls H5Arename_by_name
- * Inputs: loc_id - Object identifier
+/****if* H5Af/h5arename_by_name_c
+ * NAME
+ * h5arename_by_name_c
+ * PURPOSE
+ * 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
@@ -1055,18 +1258,24 @@ done:
* 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
- * Programmer: M. S. Breitenfeld
+ * OUTPUTS
+ * N/A
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* January, 2008
- * Modifications: N/A
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ * N/A
+ * SOURCE
+*/
int_f
nh5arename_by_name_c( hid_t_f *loc_id, _fcd obj_name, size_t_f *obj_namelen,
_fcd old_attr_name, size_t_f *old_attr_namelen,
_fcd new_attr_name, size_t_f *new_attr_namelen,
hid_t_f *lapl_id )
+/******/
{
char *c_obj_name = NULL; /* Buffer to hold C string */
char *c_old_attr_name = NULL; /* Buffer to hold C string */
@@ -1095,21 +1304,30 @@ done:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5aopen_c
- * Purpose: Call H5Aopen to open an attribute
- * Inputs: obj_id - Identifer for object to which attribute is attached
+/****if* H5Af/h5aopen_c
+ * NAME
+ * h5aopen_c
+ * PURPOSE
+ * Call H5Aopen to open an attribute
+ * INPUTS
+ * 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
- * Outputs: attr_id - dataset identifier
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * OUTPUTS
+ * attr_id - dataset identifier
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* January, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5aopen_c (hid_t_f *obj_id, _fcd attr_name, size_t_f *attr_namelen, hid_t_f *aapl_id, hid_t_f *attr_id)
+/******/
{
char *c_attr_name = NULL; /* Buffer to hold C string */
int_f ret_value = 0; /* Return value */
@@ -1131,24 +1349,33 @@ done:
HDfree(c_attr_name);
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5adelete_by_name_c
- * Purpose: Call h5adelete_by_name to remove an attribute from a specified location
- * Inputs: loc_id - identifer for object to which attribute is attached
+/****if* H5Af/h5adelete_by_name_c
+ * NAME
+ * h5adelete_by_name_c
+ * PURPOSE
+ * 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
*
- * Outputs: N/A
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * OUTPUTS
+ * N/A
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* January, 2008
- * Modifications: N/A
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ * N/A
+ * SOURCE
+*/
int_f
nh5adelete_by_name_c (hid_t_f *loc_id, _fcd obj_name, size_t_f *obj_namelen, _fcd attr_name, size_t_f *attr_namelen, hid_t_f *lapl_id)
+/******/
{
char *c_obj_name = NULL; /* Buffer to hold C string */
char *c_attr_name = NULL; /* Buffer to hold C string */
@@ -1175,25 +1402,34 @@ done:
HDfree(c_obj_name);
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5adelete_by_idx_c
- * Purpose: Call h5adelete_by_idx
- * Inputs: loc_id - Location or object identifier; may be dataset or group
+/****if* H5Af/h5adelete_by_idx_c
+ * NAME
+ * h5adelete_by_idx_c
+ * PURPOSE
+ * 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
*
- * Outputs: N/A
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * OUTPUTS
+ * N/A
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* January, 2008
- * Modifications: N/A
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ * N/A
+ * SOURCE
+*/
int_f
nh5adelete_by_idx_c (hid_t_f *loc_id, _fcd obj_name, size_t_f *obj_namelen,
int_f *idx_type, int_f *order, hsize_t_f *n, hid_t_f *lapl_id)
+/******/
{
char *c_obj_name = NULL; /* Buffer to hold C string */
int_f ret_value = 0; /* Return value */
@@ -1216,11 +1452,13 @@ done:
return ret_value;
}
-
-/*----------------------------------------------------------------------------
- * Name: h5aget_name_by_idx_c
- * Purpose: Call h5aget_name_by_idx
- * Inputs:
+/****if* H5Af/h5aget_name_by_idx_c
+ * NAME
+ * h5aget_name_by_idx_c
+ * PURPOSE
+ * Call h5aget_name_by_idx
+ * INPUTS
+ *
*
* loc_id - Identifer for object to which attribute is attached
* obj_name - Name of object, relative to location,
@@ -1246,17 +1484,23 @@ done:
* hdferr - Error code:
* Returns attribute name size, -1 if fail
*
- * Outputs: name - Attribute name
+ * OUTPUTS
+ * name - Attribute name
*
- * Returns: Size of buffer on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * RETURNS
+ * Size of buffer on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* January, 2008
- * Modifications: N/A
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ * N/A
+ * SOURCE
+*/
int_f
nh5aget_name_by_idx_c (hid_t_f *loc_id, _fcd obj_name, size_t_f *obj_namelen,
int_f *idx_type, int_f *order, hsize_t_f *n, _fcd name,
size_t_f *size, hid_t_f *lapl_id)
+/******/
{
char *c_obj_name = NULL; /* Buffer to hold C string */
ssize_t c_size;
@@ -1299,10 +1543,13 @@ done:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5aopen_by_idx_c
- * Purpose: Call H5Aopen_by_idx
- * Inputs: loc_id - Object identifier
+/****if* H5Af/h5aopen_by_idx_c
+ * NAME
+ * h5aopen_by_idx_c
+ * PURPOSE
+ * 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:
@@ -1321,15 +1568,21 @@ done:
* n - Attribute’s position in index
* aapl_id - Attribute access property list
* lapl_id - Link access property list
- * Outputs: attr_id - attribute identifer
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * OUTPUTS
+ * attr_id - attribute identifer
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* January, 2008
- * Modifications: N/A
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ * N/A
+ * SOURCE
+*/
int_f
nh5aopen_by_idx_c (hid_t_f *loc_id, _fcd obj_name, size_t_f *obj_namelen,
int_f *idx_type, int_f *order, hsize_t_f *n, hid_t_f *aapl_id, hid_t_f *lapl_id, hid_t_f *attr_id )
+/******/
{
char *c_obj_name = NULL; /* Buffer to hold C string */
int_f ret_value = 0; /* Return value */
@@ -1353,24 +1606,33 @@ done:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5aget_info_c
- * Purpose: Call H5Aget_info
- * Inputs: loc_id - Object identifier
- * Outputs:
+/****if* H5Af/h5aget_info_c
+ * NAME
+ * h5aget_info_c
+ * PURPOSE
+ * Call H5Aget_info
+ * INPUTS
+ * 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
*
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* January, 2008
- * Modifications: N/A
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ * N/A
+ * SOURCE
+*/
int_f
nh5aget_info_c (hid_t_f *loc_id, int_f *corder_valid, int_f *corder,
int_f *cset, hsize_t_f *data_size )
+/******/
{
int_f ret_value = 0; /* Return value */
@@ -1396,10 +1658,13 @@ done:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5aget_info_by_idx_c
- * Purpose: Call H5Aget_info_by_idx
- * Inputs: loc_id - Object identifier
+/****if* H5Af/h5aget_info_by_idx_c
+ * NAME
+ * h5aget_info_by_idx_c
+ * PURPOSE
+ * 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:
@@ -1417,22 +1682,28 @@ done:
*
* n - Attribute’s position in index
* lapl_id - Link access property list
- * Outputs:
+ * 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
*
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* January, 2008
- * Modifications: N/A
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ * N/A
+ * SOURCE
+*/
int_f
nh5aget_info_by_idx_c (hid_t_f *loc_id, _fcd obj_name, size_t_f *obj_namelen,
int_f *idx_type, int_f *order, hsize_t_f *n, hid_t_f *lapl_id,
int_f *corder_valid, int_f *corder,
int_f *cset, hsize_t_f *data_size )
+/******/
{
char *c_obj_name = NULL; /* Buffer to hold C string */
H5A_info_t ainfo;
@@ -1466,31 +1737,40 @@ done:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5aget_info_by_name_c
- * Purpose: Call H5Aget_info_by_name
- * Inputs: loc_id - Object identifier
+/****if* H5Af/h5aget_info_by_name_c
+ * NAME
+ * h5aget_info_by_name_c
+ * PURPOSE
+ * 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
- * Outputs:
+ * 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
*
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* January, 2008
- * Modifications: N/A
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ * N/A
+ * SOURCE
+*/
int_f
nh5aget_info_by_name_c (hid_t_f *loc_id, _fcd obj_name, size_t_f *obj_namelen,
_fcd attr_name, size_t_f *attr_namelen, hid_t_f *lapl_id,
int_f *corder_valid, int_f *corder,
int_f *cset, hsize_t_f *data_size )
+/******/
{
char *c_obj_name = NULL; /* Buffer to hold C string */
char *c_attr_name = NULL; /* Buffer to hold C string */
@@ -1528,11 +1808,14 @@ done:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5acreate_by_name_c
- * Purpose: Call h5acreate_by_name
+/****if* H5Af/h5acreate_by_name_c
+ * NAME
+ * h5acreate_by_name_c
+ * PURPOSE
+ * Call h5acreate_by_name
- * Inputs:
+ * INPUTS
+ *
* loc_id - Object identifier
* obj_name - Name of object to which attribute is attached
* obj_namelen - name length
@@ -1544,19 +1827,25 @@ done:
* aapl_id - Attribute access property list identifier (Currently not used.)
* lapl_id - Link access property list
*
- * Outputs:
+ * OUTPUTS
+ *
* attr - an attribute identifier
*
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* February, 2008
- * Modifications: N/A
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ * N/A
+ * SOURCE
+*/
int_f
nh5acreate_by_name_c(hid_t_f *loc_id, _fcd obj_name, size_t_f *obj_namelen,
_fcd attr_name, size_t_f *attr_namelen, hid_t_f *type_id,
hid_t_f *space_id, hid_t_f *acpl_id, hid_t_f *aapl_id,
hid_t_f *lapl_id, hid_t_f *attr_id )
+/******/
{
char *c_obj_name = NULL; /* Buffer to hold C string */
char *c_attr_name = NULL; /* Buffer to hold C string */
@@ -1585,21 +1874,30 @@ done:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5aexists_c
- * Purpose: CAll h5aexists
- * Inputs:
+/****if* H5Af/h5aexists_c
+ * NAME
+ * h5aexists_c
+ * PURPOSE
+ * CAll h5aexists
+ * INPUTS
+ *
* obj_id - Object identifier
* attr_name - Attribute name
- * Outputs:
+ * OUTPUTS
+ *
* attr_exists_c - returns a positive value, for TRUE, or 0 (zero), for FALSE.
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* February, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5aexists_c (hid_t_f *obj_id, _fcd name, size_t_f *namelen, hid_t_f *attr_exists)
+/******/
{
char *c_name = NULL; /* Buffer to hold C string */
int_f ret_value = 0; /* Return value */
@@ -1622,24 +1920,33 @@ done:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5aexists_by_name_c
- * Purpose: CAll H5Aexists_by_name
- * Inputs:
+/****if* H5Af/h5aexists_by_name_c
+ * NAME
+ * 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)
* attr_name - Attribute name
* lapl_id - Link access property list identifier
- * Outputs:
+ * OUTPUTS
+ *
* attr_exists_c - returns a positive value, for TRUE, or 0 (zero), for FALSE.
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* February, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5aexists_by_name_c (hid_t_f *loc_id, _fcd obj_name, size_t_f *obj_namelen, _fcd attr_name, size_t_f *attr_namelen,
hid_t_f *lapl_id, int_f *attr_exists)
+/******/
{
char *c_obj_name = NULL; /* Buffer to hold object name C string */
char *c_attr_name = NULL; /* Buffer to hold attribute name C string */
@@ -1667,25 +1974,34 @@ done:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5aopen_by_name_c
- * Purpose: Call H5Aopen_by_name
- * Inputs:
+/****if* H5Af/h5aopen_by_name_c
+ * NAME
+ * h5aopen_by_name_c
+ * PURPOSE
+ * 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)
* 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
- * Outputs:
+ * OUTPUTS
+ *
* attr_id - attribute identifier
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* February, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5aopen_by_name_c (hid_t_f *loc_id, _fcd obj_name, size_t_f *obj_namelen, _fcd attr_name, size_t_f *attr_namelen,
hid_t_f *aapl_id, hid_t_f *lapl_id, hid_t_f *attr_id)
+/******/
{
char *c_obj_name = NULL; /* Buffer to hold object name C string */
char *c_attr_name = NULL; /* Buffer to hold attribute name C string */
@@ -1713,25 +2029,34 @@ nh5aopen_by_name_c (hid_t_f *loc_id, _fcd obj_name, size_t_f *obj_namelen, _fcd
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5arename_c
- * Purpose: Calls H5Arename
- * Inputs: loc_id - Object identifier
+/****if* H5Af/h5arename_c
+ * NAME
+ * h5arename_c
+ * PURPOSE
+ * 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
- * Outputs: N/A
- * Returns: 0 on success, -1 on failure
- * Programmer: M. S. Breitenfeld
+ * OUTPUTS
+ * N/A
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* January, 2008
- * Modifications: N/A
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ * N/A
+ * SOURCE
+*/
int_f
nh5arename_c( hid_t_f *loc_id,
_fcd old_attr_name, size_t_f *old_attr_namelen,
_fcd new_attr_name, size_t_f *new_attr_namelen)
+/******/
{
char *c_old_attr_name = NULL; /* Buffer to hold C string */
char *c_new_attr_name = NULL; /* Buffer to hold C string */
@@ -1754,3 +2079,69 @@ done:
HDfree(c_new_attr_name);
return ret_value;
}
+/****if* H5Af/h5awrite_f_c
+ * NAME
+ * h5awrite_f_c
+ * PURPOSE
+ * Call H5Awrite to write a dataset
+ * INPUTS
+ * attr_id - Identifier of an attribute to write.
+ * mem_type_id - Identifier of the attribute datatype (in memory).
+ * buf - data pointer buffer
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
+ * June 11, 2008
+ * HISTORY
+ *
+ *
+ * SOURCE
+*/
+int_f
+nh5awrite_f_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf)
+/******/
+{
+ int ret_value = -1;
+ herr_t ret;
+
+ ret = H5Awrite( (hid_t)*attr_id, (hid_t)*mem_type_id, buf);
+
+ if (ret < 0) return ret_value;
+ ret_value = 0;
+ return ret_value;
+}
+
+/****if* H5Af/h5aread_f_c
+ * NAME
+ * h5aread_f_c
+ * PURPOSE
+ * Call H5Awrite to write a dataset
+ * INPUTS
+ * attr_id - Identifier of an attribute to write.
+ * mem_type_id - Identifier of the attribute datatype (in memory).
+ * buf - data pointer buffer
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
+ * June 11, 2008
+ * HISTORY
+ *
+ *
+ * SOURCE
+*/
+int_f
+nh5aread_f_c (hid_t_f *attr_id, hid_t_f *mem_type_id, void *buf)
+/******/
+{
+ int ret_value = -1;
+ herr_t ret;
+
+ ret = H5Aread( (hid_t)*attr_id, (hid_t)*mem_type_id, buf);
+
+ if (ret < 0) return ret_value;
+ ret_value = 0;
+ return ret_value;
+}
+