diff options
Diffstat (limited to 'fortran/src/H5Tf.c')
| -rw-r--r-- | fortran/src/H5Tf.c | 1615 |
1 files changed, 1084 insertions, 531 deletions
diff --git a/fortran/src/H5Tf.c b/fortran/src/H5Tf.c index 37cfca0..c8ff6e0 100644 --- a/fortran/src/H5Tf.c +++ b/fortran/src/H5Tf.c @@ -1,4 +1,9 @@ -/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * +/****h* H5Tf/H5Tf + * PURPOSE + * This file contains C stubs for H5T Fortran APIs + * + * COPYRIGHT + * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Copyright by The HDF Group. * * Copyright by the Board of Trustees of the University of Illinois. * * All rights reserved. * @@ -11,28 +16,38 @@ * 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 H5T Fortran APIs */ + * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * + * + ****** +*/ #include "H5f90.h" -/*---------------------------------------------------------------------------- - * Name: h5topen_c - * Purpose: Call H5Topen2 to open a datatype - * Inputs: loc_id - file or group identifier +/****if* H5Tf/h5topen_c + * NAME + * h5topen_c + * 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 - * Outputs: type_id - dataset identifier - * Returns: 0 on success, -1 on failure - * Programmer: Elena Pourmal + * OUTPUTS + * type_id - dataset identifier + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * Elena Pourmal * Saturday, August 14, 1999 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5topen_c (hid_t_f *loc_id, _fcd name, int_f *namelen, hid_t_f *type_id, hid_t_f *tapl_id) +/******/ { char *c_name = NULL; hid_t c_type_id; @@ -61,26 +76,34 @@ done: } -/*---------------------------------------------------------------------------- - * Name: h5tcommit_c - * Purpose: Call H5Tcommit2 to commit a datatype - * Inputs: loc_id - file or group identifier +/****if* H5Tf/h5tcommit_c + * NAME + * h5tcommit_c + * 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 - * Returns: 0 on success, -1 on failure - * Programmer: Elena Pourmal + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * Elena Pourmal * Saturday, August 14, 1999 - * Modifications: + * HISTORY + * * - Added passing optional parameters for version 1.8 - * M.S. Breitenfeld - *---------------------------------------------------------------------------*/ + * M. Scot Breitenfeld + * SOURCE +*/ int_f nh5tcommit_c(hid_t_f *loc_id, _fcd name, int_f *namelen, hid_t_f *type_id, hid_t_f *lcpl_id, hid_t_f *tcpl_id, hid_t_f *tapl_id) +/******/ { char *c_name = NULL; int ret_value = -1; @@ -101,18 +124,26 @@ done: return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tclose_c - * Purpose: Call H5Tclose to close the datatype - * Inputs: type_id - identifier of the datatype to be closed - * Returns: 0 on success, -1 on failure - * Programmer: Elena Pourmal +/****if* H5Tf/h5tclose_c + * NAME + * h5tclose_c + * PURPOSE + * Call H5Tclose to close the datatype + * INPUTS + * type_id - identifier of the datatype to be closed + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * Elena Pourmal * Saturday, August 14, 1999 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tclose_c ( hid_t_f *type_id ) +/******/ { int ret_value = 0; hid_t c_type_id; @@ -123,19 +154,28 @@ nh5tclose_c ( hid_t_f *type_id ) } -/*---------------------------------------------------------------------------- - * Name: h5tcopy_c - * Purpose: Call H5Tcopy to copy a datatype - * Inputs: type_id - identifier of the datatype to be copied - * Outputs: new_type_id - identifier of the new datatype - * Returns: 0 on success, -1 on failure - * Programmer: Elena Pourmal +/****if* H5Tf/h5tcopy_c + * NAME + * h5tcopy_c + * PURPOSE + * Call H5Tcopy to copy a datatype + * INPUTS + * type_id - identifier of the datatype to be copied + * OUTPUTS + * new_type_id - identifier of the new datatype + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * Elena Pourmal * Saturday, August 14, 1999 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tcopy_c ( hid_t_f *type_id , hid_t_f *new_type_id) +/******/ { int ret_value = 0; hid_t c_type_id; @@ -148,20 +188,29 @@ nh5tcopy_c ( hid_t_f *type_id , hid_t_f *new_type_id) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tequal_c - * Purpose: Call H5Tequal to copy a datatype - * Inputs: type1_id - datatype identifier +/****if* H5Tf/h5tequal_c + * NAME + * h5tequal_c + * PURPOSE + * Call H5Tequal to copy a datatype + * INPUTS + * type1_id - datatype identifier * type2_id - datatype identifier - * Outputs: c_flag - flag; indicates if two datatypes are equal or not. - * Returns: 0 on success, -1 on failure - * Programmer: Elena Pourmal + * OUTPUTS + * c_flag - flag; indicates if two datatypes are equal or not. + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * Elena Pourmal * Tuesday, February 22, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tequal_c ( hid_t_f *type1_id , hid_t_f *type2_id, int_f *c_flag) +/******/ { int ret_value = -1; hid_t c_type1_id, c_type2_id; @@ -177,11 +226,15 @@ nh5tequal_c ( hid_t_f *type1_id , hid_t_f *type2_id, int_f *c_flag) } -/*---------------------------------------------------------------------------- - * Name: h5tget_class_c - * Purpose: Call H5Tget_class to determine the datatype class - * Inputs: type_id - identifier of the dataspace - * Outputs: classtype - class type; possible values are: +/****if* H5Tf/h5tget_class_c + * NAME + * h5tget_class_c + * PURPOSE + * Call H5Tget_class to determine the datatype class + * INPUTS + * type_id - identifier of the dataspace + * OUTPUTS + * classtype - class type; possible values are: * H5T_NO_CLASS_F (-1) * H5T_INTEGER_F (0) * H5T_FLOAT_F (1) @@ -192,14 +245,19 @@ nh5tequal_c ( hid_t_f *type1_id , hid_t_f *type2_id, int_f *c_flag) * H5T_COMPOUNDF (6) * H5T_REFERENCE_F (7) * H5T_ENUMF (8) - * Returns: 0 on success, -1 on failure - * Programmer: Elena Pourmal + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * Elena Pourmal * Saturday, August 14, 1999 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tget_class_c ( hid_t_f *type_id , int_f *classtype) +/******/ { int ret_value = 0; hid_t c_type_id; @@ -228,22 +286,31 @@ nh5tget_class_c ( hid_t_f *type_id , int_f *classtype) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tget_order_c - * Purpose: Call H5Tget_order to determine byte order - * Inputs: type_id - identifier of the dataspace - * Outputs: order; possible values are: +/****if* H5Tf/h5tget_order_c + * NAME + * h5tget_order_c + * PURPOSE + * Call H5Tget_order to determine byte order + * INPUTS + * type_id - identifier of the dataspace + * OUTPUTS + * 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 - * Programmer: Elena Pourmal + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * Elena Pourmal * Saturday, August 14, 1999 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tget_order_c ( hid_t_f *type_id , int_f *order) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -263,22 +330,30 @@ nh5tget_order_c ( hid_t_f *type_id , int_f *order) } -/*---------------------------------------------------------------------------- - * Name: h5tset_order_c - * Purpose: Call H5Tset_order to set byte order - * Inputs: type_id - identifier of the dataspace +/****if* H5Tf/h5tset_order_c + * NAME + * h5tset_order_c + * PURPOSE + * Call H5Tset_order to set byte order + * INPUTS + * 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 - * Programmer: Elena Pourmal + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * Elena Pourmal * Saturday, August 14, 1999 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tset_order_c ( hid_t_f *type_id , int_f *order) +/******/ { int ret_value = 0; hid_t c_type_id; @@ -296,19 +371,28 @@ nh5tset_order_c ( hid_t_f *type_id , int_f *order) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tget_size_c - * Purpose: Call H5Tget_size to get size of the datatype - * Inputs: type_id - identifier of the dataspace - * Outputs: size (in bytes) - * Returns: 0 on success, -1 on failure - * Programmer: Elena Pourmal +/****if* H5Tf/h5tget_size_c + * NAME + * h5tget_size_c + * PURPOSE + * Call H5Tget_size to get size of the datatype + * INPUTS + * type_id - identifier of the dataspace + * OUTPUTS + * size (in bytes) + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * Elena Pourmal * Saturday, August 14, 1999 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tget_size_c ( hid_t_f *type_id , size_t_f *size) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -322,19 +406,28 @@ nh5tget_size_c ( hid_t_f *type_id , size_t_f *size) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tset_size_c - * Purpose: Call H5Tget_size to get size of the datatype - * Inputs: type_id - identifier of the dataspace - * Outputs: size (in bytes) - * Returns: 0 on success, -1 on failure - * Programmer: Elena Pourmal +/****if* H5Tf/h5tset_size_c + * NAME + * h5tset_size_c + * PURPOSE + * Call H5Tget_size to get size of the datatype + * INPUTS + * type_id - identifier of the dataspace + * OUTPUTS + * size (in bytes) + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * Elena Pourmal * Saturday, August 14, 1999 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tset_size_c ( hid_t_f *type_id , size_t_f *size) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -349,19 +442,28 @@ nh5tset_size_c ( hid_t_f *type_id , size_t_f *size) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tget_precision_c - * Purpose: Call H5Tget_precision to get precision of the datatype - * Inputs: type_id - identifier of the dataspace - * Outputs: precision - number of significant bits - * Returns: 0 on success, -1 on failure - * Programmer: XIANGYANG SU +/****if* H5Tf/h5tget_precision_c + * NAME + * h5tget_precision_c + * PURPOSE + * Call H5Tget_precision to get precision of the datatype + * INPUTS + * type_id - identifier of the dataspace + * OUTPUTS + * precision - number of significant bits + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * XIANGYANG SU * Tuesday, January 25, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tget_precision_c ( hid_t_f *type_id , size_t_f *precision) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -375,19 +477,27 @@ nh5tget_precision_c ( hid_t_f *type_id , size_t_f *precision) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tset_precision_c - * Purpose: Call H5Tset_precision to set precision of the datatype - * Inputs: type_id - identifier of the dataspace +/****if* H5Tf/h5tset_precision_c + * NAME + * h5tset_precision_c + * PURPOSE + * Call H5Tset_precision to set precision of the datatype + * INPUTS + * type_id - identifier of the dataspace * precision - number of significant bits - * Returns: 0 on success, -1 on failure - * Programmer: XIANGYANG SU + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * XIANGYANG SU * Tuesday, January 25, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tset_precision_c ( hid_t_f *type_id , size_t_f *precision) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -402,20 +512,29 @@ nh5tset_precision_c ( hid_t_f *type_id , size_t_f *precision) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tget_offset_c - * Purpose: Call H5Tget_offset to get bit offset of the first +/****if* H5Tf/h5tget_offset_c + * NAME + * h5tget_offset_c + * PURPOSE + * Call H5Tget_offset to get bit offset of the first * significant bit of the datatype - * Inputs: type_id - identifier of the dataspace - * Outputs: offset - bit offset of the first significant bit - * Returns: 0 on success, -1 on failure - * Programmer: XIANGYANG SU + * INPUTS + * type_id - identifier of the dataspace + * OUTPUTS + * offset - bit offset of the first significant bit + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * XIANGYANG SU * Tuesday, January 25, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tget_offset_c ( hid_t_f *type_id , size_t_f *offset) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -430,20 +549,28 @@ nh5tget_offset_c ( hid_t_f *type_id , size_t_f *offset) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tset_offset_c - * Purpose: Call H5Tset_offset to set bit offset of the first +/****if* H5Tf/h5tset_offset_c + * NAME + * h5tset_offset_c + * PURPOSE + * Call H5Tset_offset to set bit offset of the first * significant bit of the datatype - * Inputs: type_id - identifier of the dataspace + * INPUTS + * type_id - identifier of the dataspace * offset - bit offset of the first significant bit - * Returns: 0 on success, -1 on failure - * Programmer: XIANGYANG SU + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * XIANGYANG SU * Tuesday, January 25, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tset_offset_c ( hid_t_f *type_id , size_t_f *offset) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -458,22 +585,31 @@ nh5tset_offset_c ( hid_t_f *type_id , size_t_f *offset) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tget_pad_c - * Purpose: Call H5Tget_pad to get the padding type of the least and +/****if* H5Tf/h5tget_pad_c + * NAME + * h5tget_pad_c + * PURPOSE + * Call H5Tget_pad to get the padding type of the least and * most-significant bit padding * - * Inputs: type_id - identifier of the dataspace - * Outputs: lsbpad - padding type of the least significant bit + * INPUTS + * type_id - identifier of the dataspace + * OUTPUTS + * lsbpad - padding type of the least significant bit * msbpad - padding type of the least significant bit - * Returns: 0 on success, -1 on failure - * Programmer: XIANGYANG SU + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * XIANGYANG SU * Wednesday, January 26, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tget_pad_c ( hid_t_f *type_id , int_f * lsbpad, int_f * msbpad) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -490,23 +626,32 @@ nh5tget_pad_c ( hid_t_f *type_id , int_f * lsbpad, int_f * msbpad) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tset_pad_c - * Inputs: type_id - identifier of the dataspace - * Purpose: Call H5Tset_pad to set the padding type of the least and +/****if* H5Tf/h5tset_pad_c + * NAME + * h5tset_pad_c + * INPUTS + * type_id - identifier of the dataspace + * PURPOSE + * Call H5Tset_pad to set the padding type of the least and * most-significant bit padding * - * Inputs: type_id - identifier of the dataspace + * INPUTS + * 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 - * Programmer: XIANGYANG SU + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * XIANGYANG SU * Wednesday, January 26, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tset_pad_c ( hid_t_f *type_id, int_f * lsbpad, int_f* msbpad ) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -522,19 +667,28 @@ nh5tset_pad_c ( hid_t_f *type_id, int_f * lsbpad, int_f* msbpad ) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tget_sign_c - * Purpose: Call H5Tget_sign to get sign type for an integer type - * Inputs: type_id - identifier of the dataspace - * Outputs: sign - sign type for an integer type - * Returns: 0 on success, -1 on failure - * Programmer: XIANGYANG SU +/****if* H5Tf/h5tget_sign_c + * NAME + * h5tget_sign_c + * PURPOSE + * Call H5Tget_sign to get sign type for an integer type + * INPUTS + * type_id - identifier of the dataspace + * OUTPUTS + * sign - sign type for an integer type + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * XIANGYANG SU * Wednesday, January 26, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tget_sign_c ( hid_t_f *type_id , int_f *sign) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -548,19 +702,27 @@ nh5tget_sign_c ( hid_t_f *type_id , int_f *sign) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tset_sign_c - * Purpose: Call H5Tset_sign to set sign type for an integer type - * Inputs: type_id - identifier of the dataspace +/****if* H5Tf/h5tset_sign_c + * NAME + * h5tset_sign_c + * 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 - * Returns: 0 on success, -1 on failure - * Programmer: XIANGYANG SU + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * XIANGYANG SU * Wednesday, January 26, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tset_sign_c ( hid_t_f *type_id , int_f* sign) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -576,23 +738,32 @@ nh5tset_sign_c ( hid_t_f *type_id , int_f* sign) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tget_fields_c - * Purpose: Call H5Tget_fields to get floating point datatype +/****if* H5Tf/h5tget_fields_c + * NAME + * h5tget_fields_c + * PURPOSE + * Call H5Tget_fields to get floating point datatype * bit field information - * Inputs: type_id - identifier of the dataspace - * Outputs: epos - exponent bit-position + * INPUTS + * 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 - * Returns: 0 on success, -1 on failure - * Programmer: XIANGYANG SU + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * XIANGYANG SU * Thursday, January 27, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tget_fields_c ( hid_t_f *type_id , size_t_f *spos, size_t_f *epos, size_t_f* esize, size_t_f* mpos, size_t_f* msize) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -611,23 +782,31 @@ nh5tget_fields_c ( hid_t_f *type_id , size_t_f *spos, size_t_f *epos, size_t_f* return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tset_fields_c - * Purpose: Call H5Tset_fields to set floating point datatype +/****if* H5Tf/h5tset_fields_c + * NAME + * h5tset_fields_c + * PURPOSE + * Call H5Tset_fields to set floating point datatype * bit field information - * Inputs: type_id - identifier of the dataspace + * 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 - * Returns: 0 on success, -1 on failure - * Programmer: XIANGYANG SU + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * XIANGYANG SU * Wednesday, January 26, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tset_fields_c ( hid_t_f *type_id, size_t_f *spos, size_t_f *epos, size_t_f* esize, size_t_f* mpos, size_t_f* msize) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -647,20 +826,29 @@ nh5tset_fields_c ( hid_t_f *type_id, size_t_f *spos, size_t_f *epos, size_t_f* e return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tget_ebias_c - * Purpose: Call H5Tget_ebias to get exponent bias of a +/****if* H5Tf/h5tget_ebias_c + * NAME + * h5tget_ebias_c + * PURPOSE + * Call H5Tget_ebias to get exponent bias of a * floating-point type of the datatype - * Inputs: type_id - identifier of the dataspace - * Outputs: ebias - exponent bias of a floating-point type of the datatype - * Returns: 0 on success, -1 on failure - * Programmer: Xiangyang Su + * INPUTS + * type_id - identifier of the dataspace + * OUTPUTS + * ebias - exponent bias of a floating-point type of the datatype + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * Xiangyang Su * Friday, January 27, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tget_ebias_c ( hid_t_f *type_id , size_t_f *ebias) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -675,20 +863,28 @@ nh5tget_ebias_c ( hid_t_f *type_id , size_t_f *ebias) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tset_ebias_c - * Purpose: Call H5Tset_ebias to set exponent bias of a +/****if* H5Tf/h5tset_ebias_c + * NAME + * h5tset_ebias_c + * PURPOSE + * Call H5Tset_ebias to set exponent bias of a * floating-point type of the datatype - * Inputs: type_id - identifier of the dataspace + * INPUTS + * type_id - identifier of the dataspace * ebias - exponent bias of a floating-point type of the datatyp - * Returns: 0 on success, -1 on failure - * Programmer: Xiangyang Su + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * Xiangyang Su * Friday, January 27, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tset_ebias_c ( hid_t_f *type_id , size_t_f *ebias) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -704,20 +900,29 @@ nh5tset_ebias_c ( hid_t_f *type_id , size_t_f *ebias) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tget_norm_c - * Purpose: Call H5Tget_norm to get mantissa normalization +/****if* H5Tf/h5tget_norm_c + * NAME + * h5tget_norm_c + * PURPOSE + * Call H5Tget_norm to get mantissa normalization * of a floating-point datatype - * Inputs: type_id - identifier of the dataspace - * Outputs: norm - mantissa normalization of a floating-point type - * Returns: 0 on success, -1 on failure - * Programmer: Xiangyang Su + * INPUTS + * type_id - identifier of the dataspace + * OUTPUTS + * norm - mantissa normalization of a floating-point type + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * Xiangyang Su * Friday, January 27, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tget_norm_c ( hid_t_f *type_id , int_f *norm) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -732,20 +937,28 @@ nh5tget_norm_c ( hid_t_f *type_id , int_f *norm) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tset_norm_c - * Purpose: Call H5Tset_norm to set mantissa normalization of +/****if* H5Tf/h5tset_norm_c + * NAME + * h5tset_norm_c + * PURPOSE + * Call H5Tset_norm to set mantissa normalization of * floating-point type of the datatype - * Inputs: type_id - identifier of the dataspace + * INPUTS + * type_id - identifier of the dataspace * norm - mantissa normalization of a floating-point type - * Returns: 0 on success, -1 on failure - * Programmer: Xiangyang Su + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * Xiangyang Su * Friday, January 27, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tset_norm_c ( hid_t_f *type_id , int_f *norm) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -761,22 +974,31 @@ nh5tset_norm_c ( hid_t_f *type_id , int_f *norm) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tget_inpad_c - * Purpose: Call H5Tget_inpad to get the padding type for +/****if* H5Tf/h5tget_inpad_c + * NAME + * h5tget_inpad_c + * PURPOSE + * Call H5Tget_inpad to get the padding type for * unused bits in floating-point datatypes * - * Inputs: type_id - identifier of the dataspace - * Outputs: padtype - padding type for + * INPUTS + * type_id - identifier of the dataspace + * OUTPUTS + * padtype - padding type for * unused bits in floating-point datatype - * Returns: 0 on success, -1 on failure - * Programmer: XIANGYANG SU + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * XIANGYANG SU * Wednesday, January 26, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tget_inpad_c ( hid_t_f *type_id , int_f * padtype) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -791,23 +1013,32 @@ nh5tget_inpad_c ( hid_t_f *type_id , int_f * padtype) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tset_inpad_c - * Inputs: type_id - identifier of the dataspace - * Purpose: Call H5Tset_inpad to set the padding type +/****if* H5Tf/h5tset_inpad_c + * NAME + * h5tset_inpad_c + * INPUTS + * type_id - identifier of the dataspace + * PURPOSE + * Call H5Tset_inpad to set the padding type * unused bits in floating-point datatype * - * Inputs: type_id - identifier of the dataspace + * INPUTS + * type_id - identifier of the dataspace * padtype - padding type for unused bits * in floating-point datatypes - * Returns: 0 on success, -1 on failure - * Programmer: XIANGYANG SU + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * XIANGYANG SU * Wednesday, January 26, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tset_inpad_c ( hid_t_f *type_id, int_f * padtype) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -823,21 +1054,30 @@ nh5tset_inpad_c ( hid_t_f *type_id, int_f * padtype) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tget_cset_c - * Purpose: Call H5Tget_cset to get character set +/****if* H5Tf/h5tget_cset_c + * NAME + * h5tget_cset_c + * PURPOSE + * Call H5Tget_cset to get character set * type of a string datatype * - * Inputs: type_id - identifier of the dataspace - * Outputs: cset - character set type of a string datatype - * Returns: 0 on success, -1 on failure - * Programmer: XIANGYANG SU + * INPUTS + * type_id - identifier of the dataspace + * OUTPUTS + * cset - character set type of a string datatype + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * XIANGYANG SU * Wednesday, January 26, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tget_cset_c ( hid_t_f *type_id , int_f * cset) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -852,22 +1092,31 @@ nh5tget_cset_c ( hid_t_f *type_id , int_f * cset) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tset_cset_c - * Inputs: type_id - identifier of the dataspace - * Purpose: Call H5Tset_cset to set character set +/****if* H5Tf/h5tset_cset_c + * NAME + * h5tset_cset_c + * INPUTS + * type_id - identifier of the dataspace + * PURPOSE + * Call H5Tset_cset to set character set * type of a string datatype * - * Inputs: type_id - identifier of the dataspace + * INPUTS + * type_id - identifier of the dataspace * cset - character set type of a string datatype - * Returns: 0 on success, -1 on failure - * Programmer: XIANGYANG SU + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * XIANGYANG SU * Wednesday, January 26, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tset_cset_c ( hid_t_f *type_id, int_f * cset) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -883,20 +1132,28 @@ nh5tset_cset_c ( hid_t_f *type_id, int_f * cset) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tget_strpad_c - * Purpose: Call H5Tget_strpad to get string padding method +/****if* H5Tf/h5tget_strpad_c + * NAME + * h5tget_strpad_c + * PURPOSE + * Call H5Tget_strpad to get string padding method * for a string datatype - * Inputs: type_id - identifier of the dataspace - * Outputs: strpad - string padding method for a string datatype - * Returns: 0 on success, -1 on failure - * Programmer: XIANGYANG SU + * INPUTS + * type_id - identifier of the dataspace + * OUTPUTS + * strpad - string padding method for a string datatype + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * XIANGYANG SU * Wednesday, January 26, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ - + * HISTORY + * + * SOURCE +*/ int_f nh5tget_strpad_c ( hid_t_f *type_id , int_f * strpad) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -911,22 +1168,31 @@ nh5tget_strpad_c ( hid_t_f *type_id , int_f * strpad) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tset_strpad_c - * Inputs: type_id - identifier of the dataspace - * Purpose: Call H5Tset_strpad to set string padding method +/****if* H5Tf/h5tset_strpad_c + * NAME + * h5tset_strpad_c + * INPUTS + * type_id - identifier of the dataspace + * PURPOSE + * Call H5Tset_strpad to set string padding method * for a string datatype * - * Inputs: type_id - identifier of the dataspace + * INPUTS + * type_id - identifier of the dataspace * strpad - string padding method for a string datatype - * Returns: 0 on success, -1 on failure - * Programmer: XIANGYANG SU + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * XIANGYANG SU * Wednesday, January 26, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tset_strpad_c ( hid_t_f *type_id, int_f * strpad) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -942,20 +1208,29 @@ nh5tset_strpad_c ( hid_t_f *type_id, int_f * strpad) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tget_nmembers_c - * Purpose: Call H5Tget_nmembers to get number of fields +/****if* H5Tf/h5tget_nmembers_c + * NAME + * h5tget_nmembers_c + * PURPOSE + * Call H5Tget_nmembers to get number of fields * in a compound datatype - * Inputs: type_id - identifier of the dataspace - * Outputs: num_members - number of fields in a compound datatype - * Returns: 0 on success, -1 on failure - * Programmer: XIANGYANG SU + * INPUTS + * type_id - identifier of the dataspace + * OUTPUTS + * num_members - number of fields in a compound datatype + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * XIANGYANG SU * Thursday, February 3, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tget_nmembers_c ( hid_t_f *type_id , int_f * num_members) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -968,21 +1243,30 @@ nh5tget_nmembers_c ( hid_t_f *type_id , int_f * num_members) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tget_member_name_c - * Purpose: Call H5Tget_member_name to get name +/****if* H5Tf/h5tget_member_name_c + * NAME + * h5tget_member_name_c + * PURPOSE + * Call H5Tget_member_name to get name * of a compound datatype - * Inputs: type_id - identifier of the dataspace - * Outputs: member_name - name of a field of a compound datatype - * Returns: 0 on success, -1 on failure - * Programmer: XIANGYANG SU + * INPUTS + * type_id - identifier of the dataspace + * OUTPUTS + * member_name - name of a field of a compound datatype + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * XIANGYANG SU * Thursday, February 3, 2000 - * Modifications: Elena Pourmal + * HISTORY + * Elena Pourmal * Added namelen parameter to return length of the name to Fortran user - *---------------------------------------------------------------------------*/ + * SOURCE +*/ int_f nh5tget_member_name_c ( hid_t_f *type_id ,int_f* idx, _fcd member_name, int_f *namelen) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -1000,21 +1284,30 @@ nh5tget_member_name_c ( hid_t_f *type_id ,int_f* idx, _fcd member_name, int_f *n ret_value = 0; return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tget_member_index_c - * Purpose: Call H5Tget_member_index to get an index of +/****if* H5Tf/h5tget_member_index_c + * NAME + * h5tget_member_index_c + * PURPOSE + * Call H5Tget_member_index to get an index of * the specified datatype filed or member. - * Inputs: type_id - datatype identifier + * INPUTS + * type_id - datatype identifier * name - name of the datatype within file or group * namelen - name length - * Outputs: index - 0-based index - * Returns: 0 on success, -1 on failure - * Programmer: Elena Pourmal + * OUTPUTS + * index - 0-based index + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * Elena Pourmal * Thursday, September 26, 2002 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tget_member_index_c (hid_t_f *type_id, _fcd name, int_f *namelen, int_f *idx) +/******/ { int ret_value = -1; char *c_name; @@ -1044,23 +1337,32 @@ DONE: } -/*---------------------------------------------------------------------------- - * Name: h5tget_member_offset_c - * Purpose: Call H5Tget_member_offset to get byte offset of the +/****if* H5Tf/h5tget_member_offset_c + * NAME + * 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 - * Inputs: type_id - identifier of the dataspace + * INPUTS + * 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 + * OUTPUTS + * offset - byte offset of the the beginning of the field of * a compound datatype - * Returns: always 0 - * Programmer: XIANGYANG SU + * RETURNS + * always 0 + * AUTHOR + * XIANGYANG SU * Thursday, February 3, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tget_member_offset_c ( hid_t_f *type_id ,int_f* member_no, size_t_f * offset) +/******/ { int ret_value = -1; size_t c_offset; @@ -1075,20 +1377,29 @@ nh5tget_member_offset_c ( hid_t_f *type_id ,int_f* member_no, size_t_f * offset) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tget_array_dims_c - * Purpose: Call H5Tget_array_dims2 to get +/****if* H5Tf/h5tget_array_dims_c + * NAME + * h5tget_array_dims_c + * PURPOSE + * Call H5Tget_array_dims2 to get * dimensions of array datatype - * Inputs: type_id - identifier of the array datatype - * Outputs: dims - dimensions(sizes of dimensions) of the array - * Returns: 0 on success, -1 on failure - * Programmer: Elena Pourmal + * INPUTS + * type_id - identifier of the array datatype + * OUTPUTS + * dims - dimensions(sizes of dimensions) of the array + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * Elena Pourmal * Thursday, November 16, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tget_array_dims_c ( hid_t_f *type_id , hsize_t_f * dims) +/******/ { hsize_t c_dims[H5S_MAX_RANK]; int rank, i; @@ -1109,20 +1420,29 @@ DONE: return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tget_array_ndims_c - * Purpose: Call H5Tget_array_ndims to get number +/****if* H5Tf/h5tget_array_ndims_c + * NAME + * h5tget_array_ndims_c + * PURPOSE + * Call H5Tget_array_ndims to get number * of dimensions of array datatype - * Inputs: type_id - identifier of the array datatype - * Outputs: ndims - number of dimensions of the array - * Returns: 0 on success, -1 on failure - * Programmer: Elena Pourmal + * INPUTS + * type_id - identifier of the array datatype + * OUTPUTS + * ndims - number of dimensions of the array + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * Elena Pourmal * Thursday, November 16, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tget_array_ndims_c ( hid_t_f *type_id , int_f * ndims) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -1137,20 +1457,29 @@ nh5tget_array_ndims_c ( hid_t_f *type_id , int_f * ndims) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tget_super_c - * Purpose: Call H5Tget_super to get base datatype from which +/****if* H5Tf/h5tget_super_c + * NAME + * h5tget_super_c + * PURPOSE + * Call H5Tget_super to get base datatype from which * datatype was derived - * Inputs: type_id - identifier of the array datatype - * Outputs: base_type_id - base datatype identifier - * Returns: 0 on success, -1 on failure - * Programmer: Elena Pourmal + * INPUTS + * type_id - identifier of the array datatype + * OUTPUTS + * base_type_id - base datatype identifier + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * Elena Pourmal * Thursday, November 16, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tget_super_c ( hid_t_f *type_id , hid_t_f *base_type_id) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -1166,21 +1495,30 @@ nh5tget_super_c ( hid_t_f *type_id , hid_t_f *base_type_id) } -/*---------------------------------------------------------------------------- - * Name: h5tget_member_type_c - * Purpose: Call H5Tget_member_type to get the identifier of a copy of +/****if* H5Tf/h5tget_member_type_c + * NAME + * h5tget_member_type_c + * PURPOSE + * Call H5Tget_member_type to get the identifier of a copy of * the datatype of the field - * Inputs: type_id - identifier of the datatype + * INPUTS + * 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 - * Returns: 0 on success, -1 on failure - * Programmer: XIANGYANG SU + * OUTPUTS + * datatype - identifier of a copy of the datatype of the field + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * XIANGYANG SU * Thursday, February 3, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tget_member_type_c ( hid_t_f *type_id ,int_f* field_idx, hid_t_f * datatype) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -1196,19 +1534,27 @@ nh5tget_member_type_c ( hid_t_f *type_id ,int_f* field_idx, hid_t_f * datatype) } -/*---------------------------------------------------------------------------- - * Name: h5tcreate_c - * Purpose: Call H5Tcreate to create a datatype - * Inputs: cls - class type - * size - size of the class memeber - * Returns: 0 on success, -1 on failure - * Programmer: Elena Pourmal - * Thursday, February 17, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ +/****if* H5Tf/h5tcreate_c + * NAME + * h5tcreate_c + * PURPOSE + * Call H5Tcreate to create a datatype + * INPUTS + * cls - class type + * size - size of the class memeber + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * Elena Pourmal + * Thursday, February 17, 2000 + * HISTORY + * + * SOURCE +*/ int_f nh5tcreate_c(int_f *cls, size_t_f *size, hid_t_f *type_id) +/******/ { int ret_value = -1; H5T_class_t c_class; @@ -1224,22 +1570,30 @@ nh5tcreate_c(int_f *cls, size_t_f *size, hid_t_f *type_id) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tinsert_c - * Purpose: Call H5Tinsert to adds another member to the compound datatype - * Inputs: type_id - identifier of the datatype +/****if* H5Tf/h5tinsert_c + * NAME + * h5tinsert_c + * PURPOSE + * Call H5Tinsert to adds another member to the compound datatype + * INPUTS + * type_id - identifier of the datatype * name - Name of the field to insert * namelen - length of the name * offset - Offset in memory structure of the field to insert * field_id - datatype identifier of the new member - * Returns: 0 on success, -1 on failure - * Programmer: XIANGYANG SU + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * XIANGYANG SU * Thursday, February 3, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tinsert_c(hid_t_f *type_id, _fcd name, int_f* namelen, size_t_f *offset, hid_t_f * field_id) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -1264,20 +1618,28 @@ nh5tinsert_c(hid_t_f *type_id, _fcd name, int_f* namelen, size_t_f *offset, hid_ } -/*---------------------------------------------------------------------------- - * Name: h5tpack_c - * Purpose: Call H5Tpack tor ecursively remove padding from +/****if* H5Tf/h5tpack_c + * NAME + * h5tpack_c + * PURPOSE + * Call H5Tpack tor ecursively remove padding from * within a compound datatype to make it more efficient * (space-wise) to store that data - * Inputs: type_id - identifier of the datatype - * Returns: 0 on success, -1 on failure - * Programmer: XIANGYANG SU + * INPUTS + * type_id - identifier of the datatype + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * XIANGYANG SU * Thursday, February 3, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tpack_c(hid_t_f * type_id) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -1291,20 +1653,28 @@ nh5tpack_c(hid_t_f * type_id) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tarray_create_c - * Purpose: Call H5Tarray_create2 to create array datatype - * Inputs: base_id - identifier of array base datatype +/****if* H5Tf/h5tarray_create_c + * NAME + * h5tarray_create_c + * 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 - * Returns: 0 on success, -1 on failure - * Programmer: Elena Pourmal + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * Elena Pourmal * Thursday, November 16, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tarray_create_c(hid_t_f * base_id, int_f *rank, hsize_t_f* dims, hid_t_f* type_id) +/******/ { hsize_t c_dims[H5S_MAX_RANK]; hid_t c_type_id; @@ -1329,20 +1699,29 @@ DONE: } -/*---------------------------------------------------------------------------- - * Name: h5tenum_create_c - * Purpose: Call H5Tenum_create to create a new enumeration datatype - * Inputs: parent_id - Datatype identifier for the base datatype - * Outputs: new_type_id - datatype identifier for the new +/****if* H5Tf/h5tenum_create_c + * NAME + * h5tenum_create_c + * PURPOSE + * Call H5Tenum_create to create a new enumeration datatype + * INPUTS + * parent_id - Datatype identifier for the base datatype + * OUTPUTS + * new_type_id - datatype identifier for the new * enumeration datatype - * Returns: 0 on success, -1 on failure - * Programmer: Xiangyang Su + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * Xiangyang Su * Tuesday, February 15, 1999 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tenum_create_c ( hid_t_f *parent_id , hid_t_f *new_type_id) +/******/ { int ret_value = 0; hid_t c_parent_id; @@ -1356,21 +1735,29 @@ nh5tenum_create_c ( hid_t_f *parent_id , hid_t_f *new_type_id) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tenum_insert_c - * Purpose: Call H5Tenum_insert to insert a new enumeration datatype member. - * Inputs: type_id - identifier of the datatype +/****if* H5Tf/h5tenum_insert_c + * NAME + * h5tenum_insert_c + * PURPOSE + * Call H5Tenum_insert to insert a new enumeration datatype member. + * INPUTS + * type_id - identifier of the datatype * name - Name of the new member * namelen - length of the name * value - value of the new member - * Returns: 0 on success, -1 on failure - * Programmer: XIANGYANG SU + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * XIANGYANG SU * Thursday, February 3, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tenum_insert_c(hid_t_f *type_id, _fcd name, int_f* namelen, int_f* value) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -1394,22 +1781,30 @@ nh5tenum_insert_c(hid_t_f *type_id, _fcd name, int_f* namelen, int_f* value) } -/*---------------------------------------------------------------------------- - * Name: h5tenum_nameof_c - * Purpose: Call H5Tenum_nameof to find the symbol name that corresponds to +/****if* H5Tf/h5tenum_nameof_c + * NAME + * h5tenum_nameof_c + * PURPOSE + * Call H5Tenum_nameof to find the symbol name that corresponds to * the specified value of the enumeration datatype type - * Inputs: type_id - identifier of the datatype + * 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 - * Returns: 0 on success, -1 on failure - * Programmer: XIANGYANG SU + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * XIANGYANG SU * Thursday, February 3, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tenum_nameof_c(hid_t_f *type_id, int_f* value, _fcd name, size_t_f* namelen) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -1430,22 +1825,30 @@ nh5tenum_nameof_c(hid_t_f *type_id, int_f* value, _fcd name, size_t_f* namelen) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tenum_valueof_c - * Purpose: Call H5Tenum_valueof to find the value of that corresponds to +/****if* H5Tf/h5tenum_valueof_c + * NAME + * h5tenum_valueof_c + * PURPOSE + * Call H5Tenum_valueof to find the value of that corresponds to * the specified name of the enumeration datatype type - * Inputs: type_id - identifier of the datatype + * INPUTS + * 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 - * Programmer: XIANGYANG SU + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * XIANGYANG SU * Thursday, February 3, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tenum_valueof_c(hid_t_f *type_id, _fcd name, int_f* namelen, int_f* value) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -1466,21 +1869,29 @@ nh5tenum_valueof_c(hid_t_f *type_id, _fcd name, int_f* namelen, int_f* value) } -/*---------------------------------------------------------------------------- - * Name: h5tget_member_value_c - * Purpose: Call H5Tget_member_value to get the value of an +/****if* H5Tf/h5tget_member_value_c + * NAME + * h5tget_member_value_c + * PURPOSE + * Call H5Tget_member_value to get the value of an * enumeration datatype member - * Inputs: type_id - identifier of the datatype + * INPUTS + * 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 - * Programmer: XIANGYANG SU + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * XIANGYANG SU * Thursday, February 3, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tget_member_value_c(hid_t_f *type_id, int_f* member_no, int_f* value) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -1498,21 +1909,30 @@ nh5tget_member_value_c(hid_t_f *type_id, int_f* member_no, int_f* value) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tset_tag_c - * Inputs: type_id - identifier of the dataspace - * Purpose: Call H5Tset_tag to set an opaque datatype tag - * Inputs: type_id - identifier of the dataspace +/****if* H5Tf/h5tset_tag_c + * NAME + * h5tset_tag_c + * INPUTS + * 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 - * Returns: 0 on success, -1 on failure - * Programmer: XIANGYANG SU + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * XIANGYANG SU * Wednesday, January 26, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tset_tag_c(hid_t_f* type_id, _fcd tag, int_f* namelen) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -1532,20 +1952,29 @@ nh5tset_tag_c(hid_t_f* type_id, _fcd tag, int_f* namelen) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tget_tag_c - * Purpose: Call H5Tset_tag to set an opaque datatype tag - * Inputs: type_id - identifier of the datatype - * Outputs: tag - Unique ASCII string with which the opaque +/****if* H5Tf/h5tget_tag_c + * NAME + * h5tget_tag_c + * PURPOSE + * Call H5Tset_tag to set an opaque datatype tag + * 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 - * Returns: 0 on success, -1 on failure - * Programmer: XIANGYANG SU - * Wednesday, January 26, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ + * taglen - length of tag + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * XIANGYANG SU + * Wednesday, January 26, 2000 + * HISTORY + * + * SOURCE +*/ int_f -nh5tget_tag_c(hid_t_f* type_id, _fcd tag, int_f* taglen) +nh5tget_tag_c(hid_t_f* type_id, _fcd tag, size_t_f* tag_size, int_f* taglen) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -1555,24 +1984,33 @@ nh5tget_tag_c(hid_t_f* type_id, _fcd tag, int_f* taglen) c_tag = H5Tget_tag(c_type_id); if (c_tag == NULL ) return ret_value; - HD5packFstring(c_tag, _fcdtocp(tag), strlen(c_tag)); + HD5packFstring(c_tag, _fcdtocp(tag), (size_t)*tag_size); *taglen = (int_f)HDstrlen(c_tag); HDfree(c_tag); ret_value = 0; return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tvlen_create_c - * Purpose: Call H5Tvlen_create to create VL dtatype - * Inputs: type_id - identifier of the base datatype - * Outputs: vltype_id - identifier of the VL datatype - * Returns: 0 on success, -1 on failure - * Programmer: Elena Pourmal +/****if* H5Tf/h5tvlen_create_c + * NAME + * h5tvlen_create_c + * PURPOSE + * Call H5Tvlen_create to create VL dtatype + * INPUTS + * type_id - identifier of the base datatype + * OUTPUTS + * vltype_id - identifier of the VL datatype + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * Elena Pourmal * Wednesday, October 23, 2002 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tvlen_create_c(hid_t_f* type_id, hid_t_f *vltype_id) +/******/ { int ret_value = -1; hid_t c_type_id; @@ -1585,21 +2023,30 @@ nh5tvlen_create_c(hid_t_f* type_id, hid_t_f *vltype_id) ret_value = 0; return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tis_variable_str_c - * Purpose: Call H5Tis_variable_str to detrmine if the datatype +/****if* H5Tf/h5tis_variable_str_c + * NAME + * h5tis_variable_str_c + * PURPOSE + * Call H5Tis_variable_str to detrmine if the datatype * is a variable string. - * Inputs: type_id - identifier of the dataspace - * Outputs: flag - 0 if not VL str, 1 if is not + * INPUTS + * type_id - identifier of the dataspace + * OUTPUTS + * flag - 0 if not VL str, 1 if is not * and negative on failure. - * Returns: 0 on success, -1 on failure - * Programmer: Elena Pourmal + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * Elena Pourmal * Wednesday, March 12 , 2003 - * Modifications: - *---------------------------------------------------------------------------*/ + * HISTORY + * + * SOURCE +*/ int_f nh5tis_variable_str_c ( hid_t_f *type_id , int_f *flag ) +/******/ { int ret_value = 0; hid_t c_type_id; @@ -1611,22 +2058,31 @@ nh5tis_variable_str_c ( hid_t_f *type_id , int_f *flag ) if ( status < 0 ) ret_value = -1; return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tget_member_class_c - * Purpose: Call H5Tget_member_class to detrmine ithe class of the compound +/****if* H5Tf/h5tget_member_class_c + * NAME + * h5tget_member_class_c + * PURPOSE + * Call H5Tget_member_class to detrmine ithe class of the compound * datatype member - * Inputs: type_id - identifier of the dataspace + * INPUTS + * type_id - identifier of the dataspace * member_no - member's index - * Outputs: cls - member's class - * and negative on failure. - * Returns: 0 on success, -1 on failure - * Programmer: Elena Pourmal - * Wednesday, April 6, 2005 - * Modifications: - *---------------------------------------------------------------------------*/ + * OUTPUTS + * class - member's class + * and negative on failure. + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * Elena Pourmal + * Wednesday, April 6, 2005 + * HISTORY + * + * SOURCE +*/ int_f nh5tget_member_class_c ( hid_t_f *type_id , int_f *member_no, int_f *cls ) +/******/ { int ret_value = 0; hid_t c_type_id; @@ -1642,21 +2098,29 @@ nh5tget_member_class_c ( hid_t_f *type_id , int_f *member_no, int_f *cls ) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tcommit_anon_c - * Purpose: Call H5Tcommit_anon - * Inputs: loc_id - file or group identifier +/****if* H5Tf/h5tcommit_anon_c + * NAME + * h5tcommit_anon_c + * 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 - * Returns: 0 on success, -1 on failure - * Programmer: M.S. Breitenfeld - * February 25, 2008 - * Modifications: - *---------------------------------------------------------------------------*/ + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * M. Scot Breitenfeld + * February 25, 2008 + * HISTORY + * + * SOURCE +*/ int_f nh5tcommit_anon_c(hid_t_f *loc_id, hid_t_f *dtype_id, hid_t_f *tcpl_id, hid_t_f *tapl_id) +/******/ { int ret_value = -1; @@ -1670,19 +2134,26 @@ nh5tcommit_anon_c(hid_t_f *loc_id, hid_t_f *dtype_id, return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tcommitted_c - * Purpose: Call H5Tcommitted +/****if* H5Tf/h5tcommitted_c + * NAME + * h5tcommitted_c + * PURPOSE + * Call H5Tcommitted * dtype_id - dataset identifier - * Returns: a positive value, for TRUE, if the datatype has been committed, + * RETURNS + * 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. - * Programmer: M.S. Breitenfeld - * February 25, 2008 - * Modifications: - *---------------------------------------------------------------------------*/ + * AUTHOR + * M. Scot Breitenfeld + * February 25, 2008 + * HISTORY + * + * SOURCE +*/ int_f nh5tcommitted_c(hid_t_f *dtype_id) +/******/ { int_f ret_value; @@ -1694,22 +2165,31 @@ nh5tcommitted_c(hid_t_f *dtype_id) } -/*---------------------------------------------------------------------------- - * Name: h5tdecode_c - * Purpose: Call H5Tdecode - * Inputs: +/****if* H5Tf/h5tdecode_c + * NAME + * h5tdecode_c + * PURPOSE + * Call H5Tdecode + * INPUTS + * * buf - Buffer for the data space object to be decoded. - * Outputs: + * OUTPUTS + * * obj_id - Object_id (non-negative) * - * Returns: 0 on success, -1 on failure - * Programmer: M.S. Breitenfeld - * April 9, 2008 - * Modifications: - *---------------------------------------------------------------------------*/ + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * M. Scot Breitenfeld + * April 9, 2008 + * HISTORY + * + * SOURCE +*/ int_f nh5tdecode_c ( _fcd buf, hid_t_f *obj_id ) +/******/ { int ret_value = -1; unsigned char *c_buf = NULL; /* Buffer to hold C string */ @@ -1731,21 +2211,29 @@ nh5tdecode_c ( _fcd buf, hid_t_f *obj_id ) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tencode_c - * Purpose: Call H5Tencode - * Inputs: +/****if* H5Tf/h5tencode_c + * NAME + * h5tencode_c + * PURPOSE + * Call H5Tencode + * INPUTS + * * 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. - * Returns: 0 on success, -1 on failure - * Programmer: M.S. Breitenfeld - * April 9, 2008 - * Modifications: - *---------------------------------------------------------------------------*/ + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * M. Scot Breitenfeld + * April 9, 2008 + * HISTORY + * + * SOURCE +*/ int_f nh5tencode_c (_fcd buf, hid_t_f *obj_id, size_t_f *nalloc ) +/******/ { int ret_value = -1; unsigned char *c_buf = NULL; /* Buffer to hold C string */ @@ -1793,19 +2281,28 @@ nh5tencode_c (_fcd buf, hid_t_f *obj_id, size_t_f *nalloc ) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tget_create_plist_c - * Purpose: Call H5Tget_create_plist - * Inputs: dtype_id - Datatype identifier - * Outputs: dtpl_id - Datatype property list identifier - * Returns: 0 on success, -1 on failure - * Programmer: M.S. Breitenfeld - * April 9, 2008 - * Modifications: N/A - *---------------------------------------------------------------------------*/ +/****if* H5Tf/h5tget_create_plist_c + * NAME + * h5tget_create_plist_c + * PURPOSE + * Call H5Tget_create_plist + * INPUTS + * dtype_id - Datatype identifier + * OUTPUTS + * dtpl_id - Datatype property list identifier + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * M. Scot Breitenfeld + * April 9, 2008 + * HISTORY + * N/A + * SOURCE +*/ int_f nh5tget_create_plist_c ( hid_t_f *dtype_id, hid_t_f *dtpl_id) +/******/ { int_f ret_value=-1; /* Return value */ @@ -1816,21 +2313,30 @@ nh5tget_create_plist_c ( hid_t_f *dtype_id, hid_t_f *dtpl_id) return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tcompiler_conv_c - * Purpose: Call H5Tcompiler_conv - * Inputs: +/****if* H5Tf/h5tcompiler_conv_c + * NAME + * h5tcompiler_conv_c + * PURPOSE + * Call H5Tcompiler_conv + * INPUTS + * * 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 - * Returns: 0 on success, -1 on failure - * Programmer: M.S. Breitenfeld - * April 9, 2008 - * Modifications: - *---------------------------------------------------------------------------*/ + * OUTPUTS + * c_flag - flag; TRUE for compiler conversion, FALSE for library conversion + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * M.Scot Breitenfeld + * April 9, 2008 + * HISTORY + * + * SOURCE +*/ int_f nh5tcompiler_conv_c ( hid_t_f *src_id, hid_t_f *dst_id, int_f *c_flag) +/******/ { int ret_value = -1; htri_t status; @@ -1841,21 +2347,30 @@ nh5tcompiler_conv_c ( hid_t_f *src_id, hid_t_f *dst_id, int_f *c_flag) ret_value = 0; return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5tget_native_type_c - * Purpose: Call H5Tget_native_type - * Inputs: +/****if* H5Tf/h5tget_native_type_c + * NAME + * h5tget_native_type_c + * PURPOSE + * Call H5Tget_native_type + * INPUTS + * * 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 - * Returns: 0 on success, -1 on failure - * Programmer: M.S. Breitenfeld - * June 18, 2008 - * Modifications: - *---------------------------------------------------------------------------*/ + * OUTPUTS + * native_dtype_id - The native datatype identifier for the specified dataset datatype + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * M. Scot Breitenfeld + * June 18, 2008 + * HISTORY + * + * SOURCE +*/ int_f nh5tget_native_type_c(hid_t_f *dtype_id, int_f *direction, hid_t_f *native_dtype_id) +/******/ { int ret_value = -1; hid_t status; @@ -1867,3 +2382,41 @@ nh5tget_native_type_c(hid_t_f *dtype_id, int_f *direction, hid_t_f *native_dtype return ret_value; } +/****if* H5Tf/h5tconvert_c + * NAME + * h5tconvert_c + * PURPOSE + * Call H5Tconvert + * INPUTS + * + * src_id - Identifier for the source datatype. + * dst_id - Identifier for the destination datatype. + * nelmts - Size of array buf. + * buf - Array containing pre-conversion values. + * background - Optional background buffer. + * plist_id - Dataset transfer property list identifier. + * + * OUTPUTS + * buf - Array containing post-conversion values. + * + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * M. Scot Breitenfeld + * December 8, 2008 + * + * SOURCE +*/ +int_f +nh5tconvert_c(hid_t_f *src_id, hid_t_f *dst_id, size_t_f *nelmts, void *buf, void *background, hid_t_f *plist_id) +/******/ +{ + int ret_value = -1; + hid_t status; + + status = H5Tconvert( (hid_t)*src_id, (hid_t)*dst_id, (size_t)*nelmts, buf, background, (hid_t)*plist_id ); + if ( status < 0 ) return ret_value; + ret_value = 0; + return ret_value; +} + |