diff options
Diffstat (limited to 'fortran/src/H5If.c')
| -rw-r--r-- | fortran/src/H5If.c | 181 |
1 files changed, 117 insertions, 64 deletions
diff --git a/fortran/src/H5If.c b/fortran/src/H5If.c index 5f11fde..55868dd 100644 --- a/fortran/src/H5If.c +++ b/fortran/src/H5If.c @@ -1,4 +1,9 @@ -/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * +/****h* H5If/H5If + * PURPOSE + * This file contains C stubs for H5I Fortran APIs + * + * COPYRIGHT + * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Copyright by The HDF Group. * * Copyright by the Board of Trustees of the University of Illinois. * * All rights reserved. * @@ -11,25 +16,34 @@ * 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 H5I Fortran APIs */ - + * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * + * + ****** +*/ #include "H5f90.h" #include "H5Eprivate.h" -/*---------------------------------------------------------------------------- - * Name: h5iget_type_c - * Purpose: Call H5Iget_type to get the type of an object - * Inputs: obj_id - object identifier - * Outputs: type - object type - * Returns: 0 on success, -1 on failure - * Programmer: Xiangyang Su - * Thursday, March 24, 2000 - * Modifications: - *---------------------------------------------------------------------------*/ +/****if* H5If/h5iget_type_c + * NAME + * h5iget_type_c + * PURPOSE + * Call H5Iget_type to get the type of an object + * INPUTS + * obj_id - object identifier + * OUTPUTS + * type - object type + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * Xiangyang Su + * Thursday, March 24, 2000 + * HISTORY + * + * SOURCE +*/ int_f nh5iget_type_c (hid_t_f *obj_id, int_f *type) +/******/ { int ret_value = -1; hid_t c_obj_id; @@ -45,23 +59,32 @@ nh5iget_type_c (hid_t_f *obj_id, int_f *type) ret_value = 0; return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5iget_name_c - * Purpose: Call H5Iget_name to get object's name - * Inputs: obj_id - object identifier +/****if* H5If/h5iget_name_c + * NAME + * h5iget_name_c + * PURPOSE + * Call H5Iget_name to get object's name + * INPUTS + * obj_id - object identifier * buf_size - size of the buffer - * Outputs: buf - buffer to hold the name - * Returns: length of the name on success, -1 on failure - * Programmer: Elena Pourmal + * OUTPUTS + * buf - buffer to hold the name + * RETURNS + * length of the name on success, -1 on failure + * AUTHOR + * Elena Pourmal * Wednesday, March 12, 2003 - * Modifications: + * HISTORY + * * Changed the size of c_buf_size to c_buf_size + 1, which * fixes the problem of truncating the string by 1 if the * exact size of the string (buf_size) is passed in. - * M.S. Breitenfeld, April 21, 2008 - *---------------------------------------------------------------------------*/ + * M. Scot Breitenfeld, April 21, 2008 + * SOURCE +*/ int_f nh5iget_name_c(hid_t_f *obj_id, _fcd buf, size_t_f *buf_size, size_t_f *name_size) +/******/ { int ret_value = -1; hid_t c_obj_id; @@ -95,18 +118,25 @@ DONE: return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5iinc_ref_c - * Purpose: Call H5Iinc_ref to increment object's reference count - * Inputs: obj_id - object identifier - * Outputs: ref_count - Reference count of ID - * Returns: current reference count on success, -1 on failure - * Programmer: Quincey Koziol - * Tuesday, December 9, 2003 - * Modifications: - *---------------------------------------------------------------------------*/ +/****if* H5If/h5iinc_ref_c + * NAME + * h5iinc_ref_c + * PURPOSE + * Call H5Iinc_ref to increment object's reference count + * INPUTS + * obj_id - object identifier + * OUTPUTS + * ref_count - Reference count of ID + * RETURNS + * current reference count on success, -1 on failure + * AUTHOR + * Quincey Koziol + * Tuesday, December 9, 2003 + * SOURCE +*/ int_f nh5iinc_ref_c(hid_t_f *obj_id, int_f *ref_count) +/******/ { int ret_value; @@ -124,18 +154,25 @@ done: return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5idec_ref_c - * Purpose: Call H5Idec_ref to decrement object's reference count - * Inputs: obj_id - object identifier - * Outputs: ref_count - Reference count of ID - * Returns: current reference count on success, -1 on failure - * Programmer: Quincey Koziol +/****if* H5If/h5idec_ref_c + * NAME + * h5idec_ref_c + * PURPOSE + * Call H5Idec_ref to decrement object's reference count + * INPUTS + * obj_id - object identifier + * OUTPUTS + * ref_count - Reference count of ID + * RETURNS + * current reference count on success, -1 on failure + * AUTHOR + * Quincey Koziol * Tuesday, December 9, 2003 - * Modifications: - *---------------------------------------------------------------------------*/ + * SOURCE +*/ int_f nh5idec_ref_c(hid_t_f *obj_id, int_f *ref_count) +/******/ { int ret_value; @@ -153,18 +190,26 @@ done: return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5iget_ref_c - * Purpose: Call H5Iget_ref to retrieve object's reference count - * Inputs: obj_id - object identifier - * Outputs: ref_count - Reference count of ID - * Returns: current reference count on success, -1 on failure - * Programmer: Quincey Koziol - * Tuesday, December 9, 2003 - * Modifications: - *---------------------------------------------------------------------------*/ +/****if* H5If/h5iget_ref_c + * NAME + * h5iget_ref_c + * PURPOSE + * Call H5Iget_ref to retrieve object's reference count + * INPUTS + * obj_id - object identifier + * OUTPUTS + * ref_count - Reference count of ID + * RETURNS + * current reference count on success, -1 on failure + * AUTHOR + * Quincey Koziol + * Tuesday, December 9, 2003 + * + * SOURCE +*/ int_f nh5iget_ref_c(hid_t_f *obj_id, int_f *ref_count) +/******/ { int ret_value; @@ -182,18 +227,26 @@ done: return ret_value; } -/*---------------------------------------------------------------------------- - * Name: h5iget_file_id_c - * Purpose: Call H5Iget_file_id to obtain file identifier from object identifier - * Inputs: obj_id - object identifier - * Outputs: file_id - file identifier - * Returns: 0 on success, -1 on failure - * Programmer: Elena Pourmal - * Tuesday, August 24, 2004 - * Modifications: - *---------------------------------------------------------------------------*/ +/****if* H5If/h5iget_file_id_c + * NAME + * h5iget_file_id_c + * PURPOSE + * Call H5Iget_file_id to obtain file identifier from object identifier + * INPUTS + * obj_id - object identifier + * OUTPUTS + * file_id - file identifier + * RETURNS + * 0 on success, -1 on failure + * AUTHOR + * Elena Pourmal + * Tuesday, August 24, 2004 + * + * SOURCE +*/ int_f nh5iget_file_id_c(hid_t_f *obj_id, hid_t_f *file_id) +/******/ { int ret_value; hid_t c_file_id; |