summaryrefslogtreecommitdiffstats
path: root/fortran/src/H5Pf.c
diff options
context:
space:
mode:
authorScot Breitenfeld <brtnfld@hdfgroup.org>2011-08-18 14:32:47 (GMT)
committerScot Breitenfeld <brtnfld@hdfgroup.org>2011-08-18 14:32:47 (GMT)
commita9c065c5ce65bb7dca560d53642574dba608dc78 (patch)
tree2d36b7afd3f3a83314db25aba081e95254d28841 /fortran/src/H5Pf.c
parenta968e2d409d975ac5b584680620d2589b0409f88 (diff)
downloadhdf5-a9c065c5ce65bb7dca560d53642574dba608dc78.zip
hdf5-a9c065c5ce65bb7dca560d53642574dba608dc78.tar.gz
hdf5-a9c065c5ce65bb7dca560d53642574dba608dc78.tar.bz2
[svn-r21248] Mereged the F2003 branch into the trunk.
Items merged: fortran directory, src/libhdf5.settings.in configure.in configure MANIFEST Tested: (all platforms used by daily tests, both with --enable-fortran and --enable-fortran2003)
Diffstat (limited to 'fortran/src/H5Pf.c')
-rw-r--r--fortran/src/H5Pf.c3325
1 files changed, 2188 insertions, 1137 deletions
diff --git a/fortran/src/H5Pf.c b/fortran/src/H5Pf.c
index cf5eb7d..6fc8487 100644
--- a/fortran/src/H5Pf.c
+++ b/fortran/src/H5Pf.c
@@ -1,4 +1,9 @@
-/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+/****h* H5Pf/H5Pf
+ * PURPOSE
+ * This file contains C stubs for H5P Fortran APIs
+ *
+ * COPYRIGHT
+ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by The HDF Group. *
* Copyright by the Board of Trustees of the University of Illinois. *
* All rights reserved. *
@@ -11,26 +16,35 @@
* 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 H5P Fortran APIs */
+ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+ *
+ ******
+*/
#include "H5f90.h"
#include "H5Eprivate.h"
-/*----------------------------------------------------------------------------
- * Name: h5pcreate_c
- * Purpose: Call H5Pcreate to create a property list
- * Inputs: cls - property list class identifier
- * Outputs: prp_id - identifier of the created property list
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
- * Wednesday, October 9, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+/****if* H5Pf/h5pcreate_c
+ * NAME
+ * h5pcreate_c
+ * PURPOSE
+ * Call H5Pcreate to create a property list
+ * INPUTS
+ * cls - property list class identifier
+ * OUTPUTS
+ * prp_id - identifier of the created property list
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
+ * Wednesday, October 9, 2002
+ *
+ * SOURCE
+*/
int_f
nh5pcreate_c ( hid_t_f *cls, hid_t_f *prp_id )
+/******/
{
hid_t c_prp_id;
int_f ret_value = 0;
@@ -45,18 +59,25 @@ done:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pclose_c
- * Purpose: Call H5Pclose to close property lis
- * Inputs: prp_id - identifier of the property list to be closed
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+/****if* H5Pf/h5pclose_c
+ * NAME
+ * h5pclose_c
+ * PURPOSE
+ * Call H5Pclose to close property lis
+ * INPUTS
+ * prp_id - identifier of the property list to be closed
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Saturday, August 14, 1999
- * Modifications:
- *---------------------------------------------------------------------------*/
+ *
+ * SOURCE
+*/
int_f
nh5pclose_c ( hid_t_f *prp_id )
+/******/
{
int_f ret_value = 0;
@@ -67,19 +88,26 @@ nh5pclose_c ( hid_t_f *prp_id )
}
-/*----------------------------------------------------------------------------
- * Name: h5pcopy_c
- * Purpose: Call H5Pcopy to copy property list
- * Inputs: prp_id - identifier of the property list to be copied
- * Outputs: new_prp_id - identifier of the new property list
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+/****if* H5Pf/h5pcopy_c
+ * NAME
+ * h5pcopy_c
+ * PURPOSE
+ * Call H5Pcopy to copy property list
+ * INPUTS
+ * prp_id - identifier of the property list to be copied
+ * OUTPUTS
+ * new_prp_id - identifier of the new property list
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Saturday, August 14, 1999
- * Modifications:
- *---------------------------------------------------------------------------*/
-
+ *
+ * SOURCE
+*/
int_f
nh5pcopy_c ( hid_t_f *prp_id , hid_t_f *new_prp_id)
+/******/
{
hid_t c_new_prp_id;
int_f ret_value = 0;
@@ -94,20 +122,27 @@ done:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pequal_c
- * Purpose: Call H5Pequal to check if two property lists are equal
- * Inputs: plist1_id - property list identifier
+/****if* H5Pf/h5pequal_c
+ * NAME
+ * h5pequal_c
+ * PURPOSE
+ * Call H5Pequal to check if two property lists are equal
+ * INPUTS
+ * plist1_id - property list identifier
* plist2_id - property list identifier
- * Outputs: c_flag - flag to indicate that lists are eqaul
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * OUTPUTS
+ * c_flag - flag to indicate that lists are eqaul
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Monday, September 30, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
-
+ *
+ * SOURCE
+*/
int_f
nh5pequal_c ( hid_t_f *plist1_id , hid_t_f *plist2_id, int_f * c_flag)
+/******/
{
htri_t c_c_flag;
int_f ret_value = 0;
@@ -123,25 +158,32 @@ done:
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_class_c
- * Purpose: Call H5Pget_class to determine property list class
- * Inputs: prp_id - identifier of the dataspace
- * Outputs: classtype - class type; possible values are:
+/****if* H5Pf/h5pget_class_c
+ * NAME
+ * h5pget_class_c
+ * PURPOSE
+ * Call H5Pget_class to determine property list class
+ * INPUTS
+ * prp_id - identifier of the dataspace
+ * OUTPUTS
+ * classtype - class type; possible values are:
* H5P_ROOT_F -1
* H5P_FILE_CREATE_F 0
* H5P_FILE_ACCESS_F 1
* H5P_DATASET_CREATE_F 2
* H5P_DATASET_XFER_F 3
* H5P_FILE_MOUNT_F 4
- * 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:
- *---------------------------------------------------------------------------*/
+ * SOURCE
+*/
int_f
nh5pget_class_c ( hid_t_f *prp_id , int_f *classtype)
+/******/
{
hid_t c_classtype;
int_f ret_value = 0;
@@ -158,20 +200,26 @@ done:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_preserve_c
- * Purpose: Call H5Pset_preserve to set transfer property for compound
+/****if* H5Pf/h5pset_preserve_c
+ * NAME
+ * h5pset_preserve_c
+ * PURPOSE
+ * Call H5Pset_preserve to set transfer property for compound
* datatype
- * Inputs: prp_id - property list identifier
+ * INPUTS
+ * prp_id - property list identifier
* flag - TRUE/FALSE flag
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
- * Thursday, February 17, 2000
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
+ * Thursday, February 17, 2000
+ * SOURCE
+*/
int_f
nh5pset_preserve_c ( hid_t_f *prp_id , int_f *flag)
+/******/
{
int ret_value = 0;
hid_t c_prp_id;
@@ -186,20 +234,27 @@ nh5pset_preserve_c ( hid_t_f *prp_id , int_f *flag)
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_preserve_c
- * Purpose: Call H5Pget_preserve to set transfer property for compound
+/****if* H5Pf/h5pget_preserve_c
+ * NAME
+ * h5pget_preserve_c
+ * PURPOSE
+ * Call H5Pget_preserve to set transfer property for compound
* datatype
- * Inputs: prp_id - property list identifier
- * Outputs: flag - TRUE/FALSE flag
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
- * Thursday, February 17, 2000
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * INPUTS
+ * prp_id - property list identifier
+ * OUTPUTS
+ * flag - TRUE/FALSE flag
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
+ * Thursday, February 17, 2000
+ * SOURCE
+*/
int_f
nh5pget_preserve_c ( hid_t_f *prp_id , int_f *flag)
+/******/
{
int ret_value = 0;
hid_t c_prp_id;
@@ -212,19 +267,25 @@ nh5pget_preserve_c ( hid_t_f *prp_id , int_f *flag)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_deflate_c
- * Purpose: Call H5Pset_deflate to set deflate level
- * Inputs: prp_id - property list identifier
+/****if* H5Pf/h5pset_deflate_c
+ * NAME
+ * h5pset_deflate_c
+ * PURPOSE
+ * Call H5Pset_deflate to set deflate level
+ * INPUTS
+ * prp_id - property list identifier
* level - level of deflation
- * 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:
- *---------------------------------------------------------------------------*/
+ * SOURCE
+*/
int_f
nh5pset_deflate_c ( hid_t_f *prp_id , int_f *level)
+/******/
{
int ret_value = 0;
hid_t c_prp_id;
@@ -240,21 +301,27 @@ nh5pset_deflate_c ( hid_t_f *prp_id , int_f *level)
-/*----------------------------------------------------------------------------
- * Name: h5pset_chunk_c
- * Purpose: Call H5Pset_chunk to set the sizes of chunks for a chunked
+/****if* H5Pf/h5pset_chunk_c
+ * NAME
+ * h5pset_chunk_c
+ * PURPOSE
+ * Call H5Pset_chunk to set the sizes of chunks for a chunked
* layout dataset
- * Inputs: prp_id - property list identifier
+ * INPUTS
+ * prp_id - property list identifier
* rank - number of dimensions of each chunk
* dims - array of the size of each chunk
- * Returns: 0 on success, -1 on failure
+ * RETURNS
+ * 0 on success, -1 on failure
* Saturday, August 14, 1999
- * Programmer: Elena Pourmal
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * AUTHOR
+ * Elena Pourmal
+ * SOURCE
+*/
int_f
nh5pset_chunk_c ( hid_t_f *prp_id, int_f *rank, hsize_t_f *dims )
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -285,21 +352,27 @@ DONE:
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_chunk_c
- * Purpose: Call H5Pget_chunk to get the sizes of chunks for a chunked
+/****if* H5Pf/h5pget_chunk_c
+ * NAME
+ * h5pget_chunk_c
+ * PURPOSE
+ * Call H5Pget_chunk to get the sizes of chunks for a chunked
* layout dataset for at list max_rank number of dimensions
- * Inputs: prp_id - property list identifier
+ * INPUTS
+ * prp_id - property list identifier
* max rank - maximum number of dimensions to return
* dims - array of the size of each chunk
- * Returns: number of chunk's dimnesion on success, -1 on failure
+ * RETURNS
+ * number of chunk's dimnesion on success, -1 on failure
* Saturday, August 14, 1999
- * Programmer: Elena Pourmal
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * AUTHOR
+ * Elena Pourmal
+ * SOURCE
+*/
int_f
nh5pget_chunk_c ( hid_t_f *prp_id, int_f *max_rank, hsize_t_f *dims )
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -327,21 +400,25 @@ nh5pget_chunk_c ( hid_t_f *prp_id, int_f *max_rank, hsize_t_f *dims )
return ret_value;
}
-
-
-/*----------------------------------------------------------------------------
- * Name: h5pset_fill_valuec_c
- * Purpose: Call h5pset_fill_value_c to a character fill value
- * Inputs: prp_id - property list identifier
+/****if* H5Pf/h5pset_fill_valuec_c
+ * NAME
+ * h5pset_fill_valuec_c
+ * PURPOSE
+ * Call h5pset_fill_value_c to a character fill value
+ * INPUTS
+ * prp_id - property list identifier
* type_id - datatype identifier (fill value is of type type_id)
* fillvalue - character value
- * Returns: 0 on success, -1 on failure
+ * RETURNS
+ * 0 on success, -1 on failure
* Saturday, August 14, 1999
- * Programmer: Elena Pourmal
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * AUTHOR
+ * Elena Pourmal
+ * SOURCE
+*/
int_f
nh5pset_fill_valuec_c (hid_t_f *prp_id, hid_t_f *type_id, _fcd fillvalue)
+/******/
{
int ret_value = -1;
@@ -353,19 +430,25 @@ nh5pset_fill_valuec_c (hid_t_f *prp_id, hid_t_f *type_id, _fcd fillvalue)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_fill_value_c
- * Purpose: Call H5Pset_fill_value to set a fillvalue for a dataset
- * Inputs: prp_id - property list identifier
+/****if* H5Pf/h5pset_fill_value_c
+ * NAME
+ * h5pset_fill_value_c
+ * PURPOSE
+ * Call H5Pset_fill_value to set a fillvalue for a dataset
+ * INPUTS
+ * prp_id - property list identifier
* type_id - datatype identifier (fill value is of type type_id)
* fillvalue - fillvalue
- * 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:
- *---------------------------------------------------------------------------*/
+ * SOURCE
+*/
int_f
nh5pset_fill_value_c (hid_t_f *prp_id, hid_t_f *type_id, void *fillvalue)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -386,6 +469,7 @@ nh5pset_fill_value_c (hid_t_f *prp_id, hid_t_f *type_id, void *fillvalue)
int_f
nh5pset_fill_value_integer_c (hid_t_f *prp_id, hid_t_f *type_id, void *fillvalue)
+/******/
{
/*
* Call h5pset_fill_value_c function.
@@ -411,20 +495,27 @@ nh5pset_fill_value_double_c (hid_t_f *prp_id, hid_t_f *type_id, void *fillvalue)
return nh5pset_fill_value_c(prp_id, type_id, fillvalue);
}
-
-/*----------------------------------------------------------------------------
- * Name: h5pget_fill_valuec_c
- * Purpose: Call h5pget_fill_value_c to a character fill value
- * Inputs: prp_id - property list identifier
+/****if* H5Pf/h5pget_fill_valuec_c
+ * NAME
+ * h5pget_fill_valuec_c
+ * PURPOSE
+ * Call h5pget_fill_value_c to a character fill value
+ * INPUTS
+ * prp_id - property list identifier
* type_id - datatype identifier (fill value is of type type_id)
* fillvalue - character value
- * Returns: 0 on success, -1 on failure
+ * RETURNS
+ * 0 on success, -1 on failure
* Saturday, August 14, 1999
- * Programmer: Elena Pourmal
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * AUTHOR
+ * Elena Pourmal
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_fill_valuec_c (hid_t_f *prp_id, hid_t_f *type_id, _fcd fillvalue)
+/******/
{
int ret_value = -1;
@@ -436,19 +527,25 @@ nh5pget_fill_valuec_c (hid_t_f *prp_id, hid_t_f *type_id, _fcd fillvalue)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_fill_value_c
- * Purpose: Call H5Pget_fill_value to set a fillvalue for a dataset
- * Inputs: prp_id - property list identifier
+/****if* H5Pf/h5pget_fill_value_c
+ * NAME
+ * h5pget_fill_value_c
+ * PURPOSE
+ * Call H5Pget_fill_value to set a fillvalue for a dataset
+ * INPUTS
+ * prp_id - property list identifier
* type_id - datatype identifier (fill value is of type type_id)
* fillvalue - fillvalue
- * 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:
- *---------------------------------------------------------------------------*/
+ * SOURCE
+*/
int_f
nh5pget_fill_value_c (hid_t_f *prp_id, hid_t_f *type_id, void *fillvalue)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -494,22 +591,31 @@ nh5pget_fill_value_double_c (hid_t_f *prp_id, hid_t_f *type_id, void *fillvalue)
return nh5pset_fill_value_c(prp_id, type_id, fillvalue);
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_version_c
- * Purpose: Call H5Pget_version to get the version information
+/****if* H5Pf/h5pget_version_c
+ * NAME
+ * h5pget_version_c
+ * PURPOSE
+ * Call H5Pget_version to get the version information
* of various objects for a file creation property list
- * Inputs: prp_id - property list identifier
- * Outputs: boot - array to put boot block version number
+ * INPUTS
+ * prp_id - property list identifier
+ * OUTPUTS
+ * boot - array to put boot block version number
* freelist - array to put global freelist version number
* stab - array to put symbol table version number
* shhdr - array to put shared object header version number
- * Returns: 0 on success, -1 on failure
- * Programmer: Xiangyang Su
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Xiangyang Su
* Wednesday, February 23, 2000
- * Modifications: Removed extra length parameters EP 7/6/00
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ * Removed extra length parameters EP 7/6/00
+ * SOURCE
+*/
int_f
nh5pget_version_c (hid_t_f *prp_id, int_f * boot,int_f * freelist, int_f * stab, int_f *shhdr)
+/******/
{
int ret_value = -1;
#ifndef H5_NO_DEPRECATED_SYMBOLS
@@ -543,19 +649,25 @@ nh5pget_version_c (hid_t_f *prp_id, int_f * boot,int_f * freelist, int_f * stab,
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_userblock_c
- * Purpose: Call H5Pget_userblock to get the size of a user block in
+/****if* H5Pf/h5pget_userblock_c
+ * NAME
+ * h5pget_userblock_c
+ * PURPOSE
+ * Call H5Pget_userblock to get the size of a user block in
* a file creation property list
- * Inputs: prp_id - property list identifier
+ * INPUTS
+ * prp_id - property list identifier
* Outputs size - Size of the user-block in bytes
- * Returns: 0 on success, -1 on failure
- * Programmer: Xiangyang Su
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Xiangyang Su
* Wednesday, February 23, 2000
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * SOURCE
+*/
int_f
nh5pget_userblock_c (hid_t_f *prp_id, hsize_t_f * size)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -575,19 +687,25 @@ nh5pget_userblock_c (hid_t_f *prp_id, hsize_t_f * size)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_userblock_c
- * Purpose: Call H5Pset_userblock to set the size of a user block in
+/****if* H5Pf/h5pset_userblock_c
+ * NAME
+ * h5pset_userblock_c
+ * PURPOSE
+ * Call H5Pset_userblock to set the size of a user block in
* a file creation property list
- * Inputs: prp_id - property list identifier
+ * INPUTS
+ * prp_id - property list identifier
* size - Size of the user-block in bytes
- * Returns: 0 on success, -1 on failure
- * Programmer: Xiangyang Su
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Xiangyang Su
* Wednesday, February 23, 2000
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * SOURCE
+*/
int_f
nh5pset_userblock_c (hid_t_f *prp_id, hsize_t_f * size)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -606,20 +724,28 @@ nh5pset_userblock_c (hid_t_f *prp_id, hsize_t_f * size)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_sizes_c
- * Purpose: Call H5Pget_sizes to get the size of the offsets
+/****if* H5Pf/h5pget_sizes_c
+ * NAME
+ * h5pget_sizes_c
+ * PURPOSE
+ * Call H5Pget_sizes to get the size of the offsets
* and lengths used in an HDF5 file
- * Inputs: prp_id - property list identifier
+ * INPUTS
+ * prp_id - property list identifier
* Outputs sizeof_addr - Size of an object offset in bytes
* sizeof_size - Size of an object length in bytes
- * Returns: 0 on success, -1 on failure
- * Programmer: Xiangyang Su
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Xiangyang Su
* Wednesday, February 23, 2000
- * Modifications: Deleted extra length parameters. EP 6/7/00
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ * Deleted extra length parameters. EP 6/7/00
+ * SOURCE
+*/
int_f
nh5pget_sizes_c (hid_t_f *prp_id, size_t_f * sizeof_addr, size_t_f * sizeof_size)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -641,19 +767,27 @@ nh5pget_sizes_c (hid_t_f *prp_id, size_t_f * sizeof_addr, size_t_f * sizeof_size
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_sizes_c
- * Purpose: Call H5Pset_sizes to set the size of the offsets
- * Inputs: prp_id - property list identifier
+/****if* H5Pf/h5pset_sizes_c
+ * NAME
+ * h5pset_sizes_c
+ * PURPOSE
+ * Call H5Pset_sizes to set the size of the offsets
+ * INPUTS
+ * prp_id - property list identifier
* sizeof_addr - Size of an object offset in bytes
* sizeof_size - Size of an object length in bytes
- * Returns: 0 on success, -1 on failure
- * Programmer: Xiangyang Su
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Xiangyang Su
* Wednesday, February 23, 2000
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_sizes_c (hid_t_f *prp_id, size_t_f * sizeof_addr, size_t_f * sizeof_size)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -673,20 +807,26 @@ nh5pset_sizes_c (hid_t_f *prp_id, size_t_f * sizeof_addr, size_t_f * sizeof_size
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_sym_k_c
- * Purpose: Call H5Pset_sym_k to set the size of parameters used
+/****if* H5Pf/h5pset_sym_k_c
+ * NAME
+ * h5pset_sym_k_c
+ * PURPOSE
+ * Call H5Pset_sym_k to set the size of parameters used
* to control the symbol table node
- * Inputs: prp_id - property list identifier
+ * INPUTS
+ * prp_id - property list identifier
* ik - Symbol table tree rank
* lk - Symbol table node size
- * Returns: 0 on success, -1 on failure
- * Programmer: Xiangyang Su
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Xiangyang Su
* Friday, February 25, 2000
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * SOURCE
+*/
int_f
nh5pset_sym_k_c (hid_t_f *prp_id, int_f* ik, int_f* lk)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -707,20 +847,29 @@ nh5pset_sym_k_c (hid_t_f *prp_id, int_f* ik, int_f* lk)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_sym_k_c
- * Purpose: Call H5Pget_sym_k to get the size of parameters used
+/****if* H5Pf/h5pget_sym_k_c
+ * NAME
+ * h5pget_sym_k_c
+ * PURPOSE
+ * Call H5Pget_sym_k to get the size of parameters used
* to control the symbol table node
- * Inputs: prp_id - property list identifier
- * Outputs: ik - Symbol table tree rank
+ * INPUTS
+ * prp_id - property list identifier
+ * OUTPUTS
+ * ik - Symbol table tree rank
* lk - Symbol table node size
- * Returns: 0 on success, -1 on failure
- * Programmer: Xiangyang Su
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Xiangyang Su
* Friday, February 25, 2000
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_sym_k_c (hid_t_f *prp_id, int_f* ik, int_f* lk)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -740,19 +889,27 @@ nh5pget_sym_k_c (hid_t_f *prp_id, int_f* ik, int_f* lk)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_istore_k_c
- * Purpose: Call H5Pset_istore_k to set the size of the parameter
+/****if* H5Pf/h5pset_istore_k_c
+ * NAME
+ * h5pset_istore_k_c
+ * PURPOSE
+ * Call H5Pset_istore_k to set the size of the parameter
* used to control the B-trees for indexing chunked datasets
- * Inputs: prp_id - property list identifier
+ * INPUTS
+ * prp_id - property list identifier
* ik - Symbol table tree rank
- * Returns: 0 on success, -1 on failure
- * Programmer: Xiangyang Su
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Xiangyang Su
* Friday, February 25, 2000
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_istore_k_c (hid_t_f *prp_id, int_f* ik)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -771,19 +928,28 @@ nh5pset_istore_k_c (hid_t_f *prp_id, int_f* ik)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_istore_k_c
- * Purpose: Call H5Pget_istore_k to get the size of parameters used
+/****if* H5Pf/h5pget_istore_k_c
+ * NAME
+ * h5pget_istore_k_c
+ * PURPOSE
+ * Call H5Pget_istore_k to get the size of parameters used
* to control the B-trees for indexing chunked datasets
- * Inputs: prp_id - property list identifier
- * Outputs: ik - Symbol table tree rank
- * Returns: 0 on success, -1 on failure
- * Programmer: Xiangyang Su
+ * INPUTS
+ * prp_id - property list identifier
+ * OUTPUTS
+ * ik - Symbol table tree rank
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Xiangyang Su
* Friday, February 25, 2000
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_istore_k_c (hid_t_f *prp_id, int_f* ik)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -801,18 +967,27 @@ nh5pget_istore_k_c (hid_t_f *prp_id, int_f* ik)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_driver_c
- * Purpose: Call H5Pget_driver to get low-level file driver identifier
- * Inputs: prp_id - property list identifier
- * Outputs: driver - low-level file driver identifier
- * Returns: 0 on success, -1 on failure
- * Programmer: Xiangyang Su
+/****if* H5Pf/h5pget_driver_c
+ * NAME
+ * h5pget_driver_c
+ * PURPOSE
+ * Call H5Pget_driver to get low-level file driver identifier
+ * INPUTS
+ * prp_id - property list identifier
+ * OUTPUTS
+ * driver - low-level file driver identifier
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Xiangyang Su
* Friday, February 25, 2000
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_driver_c (hid_t_f *prp_id, hid_t_f* driver)
+/******/
{
int ret_value = -1;
hid_t c_driver;
@@ -830,18 +1005,26 @@ DONE:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_fapl_stdio_c
- * Purpose: Call H5Pset_stdio to set the low level file driver to
+/****if* H5Pf/h5pset_fapl_stdio_c
+ * NAME
+ * h5pset_fapl_stdio_c
+ * PURPOSE
+ * Call H5Pset_stdio to set the low level file driver to
* use the functions declared in the stdio.h
- * Inputs: prp_id - property list identifier
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * INPUTS
+ * prp_id - property list identifier
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* March 7, 2001
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_fapl_stdio_c (hid_t_f *prp_id)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -856,20 +1039,29 @@ nh5pset_fapl_stdio_c (hid_t_f *prp_id)
return ret_value;
}
#ifdef NO_SUCH_F90_FUNCTION
-/*----------------------------------------------------------------------------
- * Name: h5pget_fapl_stdio_c
- * Purpose: Call H5Pget_fapl_stdio to determine whther the low level file driver
+/****if* H5Pf/h5pget_fapl_stdio_c
+ * NAME
+ * h5pget_fapl_stdio_c
+ * PURPOSE
+ * Call H5Pget_fapl_stdio to determine whther the low level file driver
* uses the functions declared in the stdio.h
- * Inputs: prp_id - property list identifier
- * Outputs: io - value indicates whether the file driver uses
+ * INPUTS
+ * prp_id - property list identifier
+ * OUTPUTS
+ * io - value indicates whether the file driver uses
* the functions declared in the stdio.h
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* March 9, 2001
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_fapl_stdio_c (hid_t_f *prp_id, int_f* io)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -887,18 +1079,26 @@ nh5pget_fapl_stdio_c (hid_t_f *prp_id, int_f* io)
#endif /*NO_SUCH_F90_FUNCTION*/
-/*----------------------------------------------------------------------------
- * Name: h5pset_fapl_sec2_c
- * Purpose: Call H5Pset_fapl_sec2 to set the low level file driver to
+/****if* H5Pf/h5pset_fapl_sec2_c
+ * NAME
+ * h5pset_fapl_sec2_c
+ * PURPOSE
+ * Call H5Pset_fapl_sec2 to set the low level file driver to
* use the functions declared in the unistd.h
- * Inputs: prp_id - property list identifier
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * INPUTS
+ * prp_id - property list identifier
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* March 9, 2001
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_fapl_sec2_c (hid_t_f *prp_id)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -914,20 +1114,29 @@ nh5pset_fapl_sec2_c (hid_t_f *prp_id)
}
#ifdef NO_SUCH_F90_FUNCTION
-/*----------------------------------------------------------------------------
- * Name: h5pget_fapl_sec2_c
- * Purpose: Call H5Pget_fapl_stdio to determine whther the low level file driver
+/****if* H5Pf/h5pget_fapl_sec2_c
+ * NAME
+ * h5pget_fapl_sec2_c
+ * PURPOSE
+ * Call H5Pget_fapl_stdio to determine whther the low level file driver
* uses the functions declared in the unistd.h
- * Inputs: prp_id - property list identifier
- * Outputs: sec2 - value indicates whether the file driver uses
+ * INPUTS
+ * prp_id - property list identifier
+ * OUTPUTS
+ * sec2 - value indicates whether the file driver uses
* the functions declared in the unistd.h
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* March 9, 2001
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_fapl_sec2_c (hid_t_f *prp_id, int_f* sec2)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -944,20 +1153,28 @@ nh5pget_fapl_sec2_c (hid_t_f *prp_id, int_f* sec2)
}
#endif /*NO_SUCH_F90_FUNCTION*/
-/*----------------------------------------------------------------------------
- * Name: h5pset_alignment_c
- * Purpose: Call H5Pset_alignment to set alignment properties of
+/****if* H5Pf/h5pset_alignment_c
+ * NAME
+ * h5pset_alignment_c
+ * PURPOSE
+ * Call H5Pset_alignment to set alignment properties of
* a file access property list
- * Inputs: prp_id - property list identifier
+ * INPUTS
+ * prp_id - property list identifier
* threshold - Threshold value
* alignment - Alignment value
- * Returns: 0 on success, -1 on failure
- * Programmer: Xiangyang Su
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Xiangyang Su
* Friday, February 25, 2000
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_alignment_c (hid_t_f *prp_id, hsize_t_f* threshold, hsize_t_f* alignment)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -975,20 +1192,28 @@ nh5pset_alignment_c (hid_t_f *prp_id, hsize_t_f* threshold, hsize_t_f* alignment
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_alignment_c
- * Purpose: Call H5Pget_alignment to get alignment properties of
+/****if* H5Pf/h5pget_alignment_c
+ * NAME
+ * h5pget_alignment_c
+ * PURPOSE
+ * Call H5Pget_alignment to get alignment properties of
* a file access property list
- * Inputs: prp_id - property list identifier
+ * INPUTS
+ * prp_id - property list identifier
* threshold - Threshold value
* alignment - Alignment value
- * Returns: 0 on success, -1 on failure
- * Programmer: Xiangyang Su
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Xiangyang Su
* Friday, February 25, 2000
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_alignment_c (hid_t_f *prp_id, hsize_t_f* threshold, hsize_t_f* alignment)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -1007,21 +1232,29 @@ nh5pget_alignment_c (hid_t_f *prp_id, hsize_t_f* threshold, hsize_t_f* alignment
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_fapl_core_c
- * Purpose: Call H5Pset_fapl_core to set the low-level file driver
+/****if* H5Pf/h5pset_fapl_core_c
+ * NAME
+ * h5pset_fapl_core_c
+ * PURPOSE
+ * Call H5Pset_fapl_core to set the low-level file driver
* to use malloc() and free()
- * Inputs: prp_id - property list identifier
+ * INPUTS
+ * prp_id - property list identifier
* increment - File block size in bytes
* flag - Boolean flag indicating whether to write the
* file contents to disk when the file is closed.
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* March 9, 2001
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_fapl_core_c (hid_t_f *prp_id, size_t_f* increment, int_f *flag)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -1041,19 +1274,27 @@ nh5pset_fapl_core_c (hid_t_f *prp_id, size_t_f* increment, int_f *flag)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_fapl_core_c
- * Purpose: Call H5Pget_fapl_core to determine whether the file access
+/****if* H5Pf/h5pget_fapl_core_c
+ * NAME
+ * h5pget_fapl_core_c
+ * PURPOSE
+ * Call H5Pget_fapl_core to determine whether the file access
* property list is set to the core drive
- * Inputs: prp_id - property list identifier
+ * INPUTS
+ * prp_id - property list identifier
* Outputs increment - File block size in bytes
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* March 9, 2001
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_fapl_core_c (hid_t_f *prp_id, size_t_f* increment, int_f *flag)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -1073,21 +1314,29 @@ nh5pget_fapl_core_c (hid_t_f *prp_id, size_t_f* increment, int_f *flag)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_fapl_family_c
- * Purpose: Call H5Pset_fapl_family to set the file access properties list
+/****if* H5Pf/h5pset_fapl_family_c
+ * NAME
+ * h5pset_fapl_family_c
+ * PURPOSE
+ * Call H5Pset_fapl_family to set the file access properties list
* to the family driver
- * Inputs: prp_id - property list identifier
+ * INPUTS
+ * prp_id - property list identifier
* memb_size - Logical size, in bytes, of each family member.
* memb_plist - Identifier of the file access property list
* for each member of the family
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* March 9, 2001
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_fapl_family_c(hid_t_f *prp_id, hsize_t_f* memb_size, hid_t_f* memb_plist )
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -1106,21 +1355,29 @@ nh5pset_fapl_family_c(hid_t_f *prp_id, hsize_t_f* memb_size, hid_t_f* memb_plist
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_fapl_family_c
- * Purpose: Call H5Pget_fapl_family to determine whether the file access
+/****if* H5Pf/h5pget_fapl_family_c
+ * NAME
+ * h5pget_fapl_family_c
+ * PURPOSE
+ * Call H5Pget_fapl_family to determine whether the file access
* property list is set to the family driver
- * Inputs: prp_id - property list identifier
+ * INPUTS
+ * prp_id - property list identifier
* memb_size - Logical size, in bytes, of each family member.
* memb_plist - Identifier of the file access property list
* for each member of the family
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* March 9, 2001
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_fapl_family_c(hid_t_f *prp_id, hsize_t_f* memb_size, hid_t_f* memb_plist)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -1140,24 +1397,32 @@ nh5pget_fapl_family_c(hid_t_f *prp_id, hsize_t_f* memb_size, hid_t_f* memb_plist
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_cache_c
- * Purpose: Call H5Pset_cache to set he number of elements in
+/****if* H5Pf/h5pset_cache_c
+ * NAME
+ * h5pset_cache_c
+ * PURPOSE
+ * Call H5Pset_cache to set he number of elements in
* the meta data cache and the total number of bytes in
* the raw data chunk cache
- * Inputs: prp_id - property list identifier
+ * INPUTS
+ * prp_id - property list identifier
* mdc_nelmts - Number of elements (objects) in the
* meta data cache
* rdcc_nbytes - Total size of the raw data chunk cache, in bytes
* rdcc_w0 - Preemption policy
- * Returns: 0 on success, -1 on failure
- * Programmer: Xiangyang Su
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Xiangyang Su
* Friday, February 25, 2000
- * Modifications: Changed the type of the rdcc_w0 parameter to be real_f EP 7/7/00
+ * HISTORY
+ * Changed the type of the rdcc_w0 parameter to be real_f EP 7/7/00
* instead of double
- *---------------------------------------------------------------------------*/
+ * SOURCE
+*/
int_f
nh5pset_cache_c(hid_t_f *prp_id, int_f* mdc_nelmts, size_t_f* rdcc_nelmts, size_t_f* rdcc_nbytes , real_f* rdcc_w0 )
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -1181,26 +1446,35 @@ nh5pset_cache_c(hid_t_f *prp_id, int_f* mdc_nelmts, size_t_f* rdcc_nelmts, size
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_cache_c
- * Purpose: Call H5Pget_cache to get he number of elements in
+/****if* H5Pf/h5pget_cache_c
+ * NAME
+ * h5pget_cache_c
+ * PURPOSE
+ * Call H5Pget_cache to get he number of elements in
* the meta data cache and the total number of bytes in
* the raw data chunk cache
- * Inputs: prp_id - property list identifier
- * Outputs: mdc_nelmts - Number of elements (objects) in the
+ * INPUTS
+ * prp_id - property list identifier
+ * OUTPUTS
+ * mdc_nelmts - Number of elements (objects) in the
* meta data cache
* rdcc_nelmts - Number of elements in the raw data chunk
* rdcc_nbytes - Total size of the raw data chunk cache, in bytes
* rdcc_w0 - Preemption policy
- * Returns: 0 on success, -1 on failure
- * Programmer: Xiangyang Su
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Xiangyang Su
* Friday, February 25, 2000
- * Modifications: Changed type of the rdcc_w0 parameter to be real_f instead of double
+ * HISTORY
+ * Changed type of the rdcc_w0 parameter to be real_f instead of double
* Changed type of the rdcc_nelmts parameter to be int_f.
* EIP October 10, 2003
- *---------------------------------------------------------------------------*/
+ * SOURCE
+*/
int_f
nh5pget_cache_c(hid_t_f *prp_id, int_f* mdc_nelmts, size_t_f* rdcc_nelmts, size_t_f* rdcc_nbytes , real_f* rdcc_w0)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -1224,24 +1498,32 @@ nh5pget_cache_c(hid_t_f *prp_id, int_f* mdc_nelmts, size_t_f* rdcc_nelmts, size_
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_fapl_split_c
- * Purpose: Call H5Pset_fapl_split to set he low-level driver to split meta data
+/****if* H5Pf/h5pset_fapl_split_c
+ * NAME
+ * h5pset_fapl_split_c
+ * PURPOSE
+ * Call H5Pset_fapl_split to set he low-level driver to split meta data
* from raw data
- * Inputs: prp_id - property list identifier
+ * INPUTS
+ * prp_id - property list identifier
* meta_len - Length of meta_ext
* meta_ext - Name of the extension for the metafile filename.
* meta_plist - Identifier of the meta file access property list
* raw_len - Length of raw _ext
* raw_ext - Name of the extension for the raw file filename.
* raw_plist - Identifier of the raw file access property list
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* March 9, 2001
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_fapl_split_c(hid_t_f *prp_id, int_f* meta_len, _fcd meta_ext, hid_t_f* meta_plist, int_f* raw_len, _fcd raw_ext, hid_t_f * raw_plist)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -1277,26 +1559,35 @@ DONE:
#ifdef NO_SUCH_F90_FUNCTION
-/*----------------------------------------------------------------------------
- * Name: h5pget_fapl_split_c
- * Purpose: Call H5Pget_fapl_split to determine whether the file access
+/****if* H5Pf/h5pget_fapl_split_c
+ * NAME
+ * h5pget_fapl_split_c
+ * PURPOSE
+ * Call H5Pget_fapl_split to determine whether the file access
* property list is set to the split driver
- * Inputs: prp_id - property list identifier
+ * INPUTS
+ * prp_id - property list identifier
* meta_ext_size - Number of characters of the meta file extension
* to be copied to the meta_ext buffer
* raw_ext_size - Number of characters of the raw file extension
* to be copied to the raw_ext buffer
- *Outputs: meta_ext - Name of the extension for the metafile filename.
+ *OUTPUT
+ * meta_ext - Name of the extension for the metafile filename.
* meta_plist - Identifier of the meta file access property list
* raw_ext - Name of the extension for the raw file filename.
* raw_plist - Identifier of the raw file access property list
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* March 9 , 2001
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_fapl_split_c(hid_t_f *prp_id, size_t_f* meta_ext_size , _fcd meta_ext, hid_t_f* meta_plist, size_t_f* raw_ext_size, _fcd raw_ext, hid_t_f * raw_plist)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -1331,20 +1622,28 @@ nh5pget_fapl_split_c(hid_t_f *prp_id, size_t_f* meta_ext_size , _fcd meta_ext, h
}
#endif /*NO_SUCH_F90_FUNCTION*/
-/*----------------------------------------------------------------------------
- * Name: h5pset_gc_references_c
- * Purpose: Call H5Pset_gc_references to set garbage
+/****if* H5Pf/h5pset_gc_references_c
+ * NAME
+ * h5pset_gc_references_c
+ * PURPOSE
+ * Call H5Pset_gc_references to set garbage
* collecting references flag
- * Inputs: prp_id - property list identifier
+ * INPUTS
+ * prp_id - property list identifier
* gc_reference - flag for garbage collecting references
* for the file
- * Returns: 0 on success, -1 on failure
- * Programmer: Xiangyang Su
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Xiangyang Su
* Friday, February 25, 2000
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_gc_references_c (hid_t_f *prp_id, int_f* gc_references)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -1363,20 +1662,28 @@ nh5pset_gc_references_c (hid_t_f *prp_id, int_f* gc_references)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_gc_references_c
- * Purpose: Call H5Pget_gc_references to set garbage
+/****if* H5Pf/h5pget_gc_references_c
+ * NAME
+ * h5pget_gc_references_c
+ * PURPOSE
+ * Call H5Pget_gc_references to set garbage
* collecting references flag
- * Inputs: prp_id - property list identifier
+ * INPUTS
+ * prp_id - property list identifier
* Outputs gc_reference - flag for garbage collecting references
* for the file
- * Returns: 0 on success, -1 on failure
- * Programmer: Xiangyang Su
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Xiangyang Su
* Friday, February 25, 2000
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_gc_references_c (hid_t_f *prp_id, int_f* gc_references)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -1393,19 +1700,27 @@ nh5pget_gc_references_c (hid_t_f *prp_id, int_f* gc_references)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_layout_c
- * Purpose: Call H5Pset_layout to the type of storage used
+/****if* H5Pf/h5pset_layout_c
+ * NAME
+ * h5pset_layout_c
+ * PURPOSE
+ * Call H5Pset_layout to the type of storage used
* store the raw data for a dataset
- * Inputs: prp_id - property list identifier
+ * INPUTS
+ * prp_id - property list identifier
* layout - Type of storage layout for raw data.
- * Returns: 0 on success, -1 on failure
- * Programmer: Xiangyang Su
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Xiangyang Su
* Friday, February 25, 2000
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_layout_c (hid_t_f *prp_id, int_f* layout)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -1423,19 +1738,28 @@ nh5pset_layout_c (hid_t_f *prp_id, int_f* layout)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_layout_c
- * Purpose: Call H5Pget_layout to the type of storage used
+/****if* H5Pf/h5pget_layout_c
+ * NAME
+ * h5pget_layout_c
+ * PURPOSE
+ * Call H5Pget_layout to the type of storage used
* store the raw data for a dataset
- * Inputs: prp_id - property list identifier
- * Outputs: layout - Type of storage layout for raw data.
- * Returns: 0 on success, -1 on failure
- * Programmer: Xiangyang Su
+ * INPUTS
+ * prp_id - property list identifier
+ * OUTPUTS
+ * layout - Type of storage layout for raw data.
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Xiangyang Su
* Friday, February 25, 2000
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_layout_c (hid_t_f *prp_id, int_f* layout)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -1451,22 +1775,30 @@ nh5pget_layout_c (hid_t_f *prp_id, int_f* layout)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_filter_c
- * Purpose: Call H5Pset_filter to add a filter to the filter pipeline.
- * Inputs: prp_id - property list identifier
+/****if* H5Pf/h5pset_filter_c
+ * NAME
+ * h5pset_filter_c
+ * PURPOSE
+ * Call H5Pset_filter to add a filter to the filter pipeline.
+ * INPUTS
+ * prp_id - property list identifier
* filter - Filter to be added to the pipeline.
* flags - Bit vector specifying certain general
* properties of the filter.
* cd_nelmts - Number of elements in cd_values.
* cd_values - Auxiliary data for the filter.
- * Returns: 0 on success, -1 on failure
- * Programmer: Xiangyang Su
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Xiangyang Su
* Wednesday, February 23, 2000
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_filter_c (hid_t_f *prp_id, int_f* filter, int_f* flags, size_t_f* cd_nelmts, int_f* cd_values )
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -1499,19 +1831,26 @@ DONE:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_nfilters_c
- * Purpose: Call H5Pget_nfilters to get the number of filters
- * in the pipeline
- * Inputs: prp_id - property list identifier
- * Outputs: nfilters - number of filters defined in the filter pipline
- * Returns: 0 on success, -1 on failure
- * Programmer: Xiangyang Su
- * Friday, February 25, 2000
- * Modifications:
- *---------------------------------------------------------------------------*/
+/****if* H5Pf/h5pget_nfilters_c
+ * NAME
+ * h5pget_nfilters_c
+ * PURPOSE
+ * Call H5Pget_nfilters to get the number of filters
+ * in the pipeline
+ * INPUTS
+ * prp_id - property list identifier
+ * OUTPUTS
+ * nfilters - number of filters defined in the filter pipline
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Xiangyang Su
+ * Friday, February 25, 2000
+ * SOURCE
+*/
int_f
nh5pget_nfilters_c (hid_t_f *prp_id, int_f* nfilters)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -1554,9 +1893,10 @@ nh5pget_nfilters_c (hid_t_f *prp_id, int_f* nfilters)
*---------------------------------------------------------------------------*/
int_f
nh5pget_filter_c(hid_t_f *prp_id, int_f* filter_number, int_f* flags, size_t_f* cd_nelmts, int_f* cd_values, size_t_f *namelen, _fcd name, int_f* filter_id)
+/******/
{
unsigned int c_flags;
- size_t c_cd_nelmts;
+ size_t c_cd_nelmts = 0;
H5Z_filter_t c_filter;
unsigned int *c_cd_values = NULL;
char *c_name = NULL;
@@ -1595,23 +1935,31 @@ DONE:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_external_c
- * Purpose: Call H5Pset_external to add an external file to the
+/****if* H5Pf/h5pset_external_c
+ * NAME
+ * h5pset_external_c
+ * PURPOSE
+ * Call H5Pset_external to add an external file to the
* list of external files.
- * Inputs: prp_id - property list identifier
+ * INPUTS
+ * prp_id - property list identifier
* name - Name of an external file
* namelen - length of name
* offset - Offset, in bytes, from the beginning of the file
* to the location in the file where the data starts.
* bytes - Number of bytes reserved in the file for the data.
- * Returns: 0 on success, -1 on failure
- * Programmer: Xiangyang Su
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Xiangyang Su
* Wednesday, February 23, 2000
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_external_c (hid_t_f *prp_id, _fcd name, int_f* namelen, int_f* offset, hsize_t_f*bytes)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -1642,19 +1990,28 @@ DONE:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_external_count_c
- * Purpose: Call H5Pget_external_count to get the number of external
+/****if* H5Pf/h5pget_external_count_c
+ * NAME
+ * h5pget_external_count_c
+ * PURPOSE
+ * Call H5Pget_external_count to get the number of external
* files for the specified dataset.
- * Inputs: prp_id - property list identifier
- * Outputs: count - number of external files
- * Returns: 0 on success, -1 on failure
- * Programmer: Xiangyang Su
+ * INPUTS
+ * prp_id - property list identifier
+ * OUTPUTS
+ * count - number of external files
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Xiangyang Su
* Friday, February 25, 2000
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_external_count_c (hid_t_f *prp_id, int_f* count)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -1670,23 +2027,32 @@ nh5pget_external_count_c (hid_t_f *prp_id, int_f* count)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_external_c
- * Purpose: Call H5Pget_external to get nformation about an external file.
- * Inputs: prp_id - property list identifier
- * name_size - length of name
- * idx - External file index.
- *Outputs: name - Name of an external file
- * offset - Offset, in bytes, from the beginning of the file
- * to the location in the file where the data starts.
- * bytes - Number of bytes reserved in the file for the data.
- * Returns: 0 on success, -1 on failure
- * Programmer: Xiangyang Su
- * Wednesday, February 23, 2000
- * Modifications:
- *---------------------------------------------------------------------------*/
+/****if* H5Pf/h5pget_external_c
+ * NAME
+ * h5pget_external_c
+ * PURPOSE
+ * Call H5Pget_external to get nformation about an external file.
+ * INPUTS
+ * prp_id - property list identifier
+ * name_size - length of name
+ * idx - External file index.
+ *OUTPUT
+ * name - Name of an external file
+ * offset - Offset, in bytes, from the beginning of the file
+ * to the location in the file where the data starts.
+ * bytes - Number of bytes reserved in the file for the data.
+ * RETURNS
+ * on success, -1 on failure
+ * AUTHOR
+ * Xiangyang Su
+ * Wednesday, February 23, 2000
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_external_c(hid_t_f *prp_id, int_f *idx, size_t_f* name_size, _fcd name, int_f* offset, hsize_t_f*bytes)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -1727,22 +2093,30 @@ DONE:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_btree_ratios_c
- * Purpose: Call H5Pset_btree_ratios to set B-tree split ratios for B-tree split ratios for a dataset transfer property list. a
+/****if* H5Pf/h5pset_btree_ratios_c
+ * NAME
+ * h5pset_btree_ratios_c
+ * PURPOSE
+ * Call H5Pset_btree_ratios to set B-tree split ratios for B-tree split ratios for a dataset transfer property list. a
* dataset transfer property list.
- * Inputs: prp_id - property list identifier
+ * INPUTS
+ * prp_id - property list identifier
* left - The B-tree split ratio for left-most nodes.
* middle - The B-tree split ratio for all other nodes
* right - The B-tree split ratio for right-most nodes
* and lone nodes.
- * Returns: 0 on success, -1 on failure
- * Programmer: Xiangyang Su
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Xiangyang Su
* Friday, February 25, 2000
- * Modifications: Changed the type of the last three parameters from double to real_f
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ * Changed the type of the last three parameters from double to real_f
+ * SOURCE
+*/
int_f
nh5pset_btree_ratios_c(hid_t_f *prp_id, real_f* left, real_f* middle, real_f* right)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -1764,22 +2138,30 @@ nh5pset_btree_ratios_c(hid_t_f *prp_id, real_f* left, real_f* middle, real_f* ri
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_btree_ratios_c
- * Purpose: Call H5Pget_btree_ratios to Gets B-tree split ratios
+/****if* H5Pf/h5pget_btree_ratios_c
+ * NAME
+ * h5pget_btree_ratios_c
+ * PURPOSE
+ * Call H5Pget_btree_ratios to Gets B-tree split ratios
* for a dataset transfer property list.
- * Inputs: prp_id - property list identifier
+ * INPUTS
+ * prp_id - property list identifier
* left - The B-tree split ratio for left-most nodes.
* middle - The B-tree split ratio for all other nodes
* right - The B-tree split ratio for right-most nodes
* and lone nodes.
- * Returns: 0 on success, -1 on failure
- * Programmer: Xiangyang Su
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Xiangyang Su
* Friday, February 25, 2000
- * Modifications: Changed the type of the last three parameters from double to real_f
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ * Changed the type of the last three parameters from double to real_f
+ * SOURCE
+*/
int_f
nh5pget_btree_ratios_c(hid_t_f *prp_id, real_f* left, real_f* middle, real_f* right)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -1798,24 +2180,33 @@ nh5pget_btree_ratios_c(hid_t_f *prp_id, real_f* left, real_f* middle, real_f* ri
ret_value = 0;
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_fclose_degree_c
- * Purpose: Call H5Pget_fclose_degree to determine file close behavior
- * Inputs: fapl_id - file access identifier
- * Outputs:
+/****if* H5Pf/h5pget_fclose_degree_c
+ * NAME
+ * h5pget_fclose_degree_c
+ * PURPOSE
+ * Call H5Pget_fclose_degree to determine file close behavior
+ * INPUTS
+ * fapl_id - file access identifier
+ * OUTPUTS
+ *
* degree - possible values are:
* H5F_CLOSE_DEFAULT
* H5F_CLOSE_WEAK
* H5F_CLOSE_SEMI
* H5F_CLOSE_STRONG
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Thursday, September 26, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_fclose_degree_c ( hid_t_f *fapl_id , int_f *degree)
+/******/
{
int ret_value = -1;
hid_t c_fapl_id;
@@ -1829,23 +2220,31 @@ nh5pget_fclose_degree_c ( hid_t_f *fapl_id , int_f *degree)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_fclose_degree_c
- * Purpose: Call H5Pset_fclose_degree to set file close behavior
- * Inputs: fapl_id - file access identifier
+/****if* H5Pf/h5pset_fclose_degree_c
+ * NAME
+ * h5pset_fclose_degree_c
+ * PURPOSE
+ * Call H5Pset_fclose_degree to set file close behavior
+ * INPUTS
+ * fapl_id - file access identifier
* degree - possible values are:
* H5F_CLOSE_DEFAULT
* H5F_CLOSE_WEAK
* H5F_CLOSE_SEMI
* H5F_CLOSE_STRONG
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Thursday, September 26, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_fclose_degree_c ( hid_t_f *fapl_id , int_f *degree)
+/******/
{
int ret_value = -1;
hid_t c_fapl_id;
@@ -1859,20 +2258,29 @@ nh5pset_fclose_degree_c ( hid_t_f *fapl_id , int_f *degree)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_buffer_c
- * Purpose: Call H5Pset_buffer to set size of conversion buffer
- * Inputs: prp_id - t`dataset trasfer property list identifier
+/****if* H5Pf/h5pset_buffer_c
+ * NAME
+ * h5pset_buffer_c
+ * PURPOSE
+ * Call H5Pset_buffer to set size of conversion buffer
+ * INPUTS
+ * prp_id - t`dataset trasfer property list identifier
* size - size of the buffer
- * Outputs: NONE
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * OUTPUTS
+ * NONE
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Wednesday, October 2, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_buffer_c ( hid_t_f *prp_id , hsize_t_f *size)
+/******/
{
int ret_value = 0;
hid_t c_prp_id;
@@ -1884,19 +2292,28 @@ nh5pset_buffer_c ( hid_t_f *prp_id , hsize_t_f *size)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_buffer_c
- * Purpose: Call H5Pget_buffer to get size of conversion buffer
- * Inputs: prp_id - t`dataset trasfer property list identifier
- * Outputs: size - size of conversion buffer
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+/****if* H5Pf/h5pget_buffer_c
+ * NAME
+ * h5pget_buffer_c
+ * PURPOSE
+ * Call H5Pget_buffer to get size of conversion buffer
+ * INPUTS
+ * prp_id - t`dataset trasfer property list identifier
+ * OUTPUTS
+ * size - size of conversion buffer
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Wednesday, October 2, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_buffer_c ( hid_t_f *prp_id , hsize_t_f *size)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -1909,19 +2326,28 @@ nh5pget_buffer_c ( hid_t_f *prp_id , hsize_t_f *size)
ret_value = 0;
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pfill_value_defined_c
- * Purpose: Call H5Pfill_value_defined to check if fill value is defined
- * Inputs: prp_id - dataset creation property list identifier
- * Outputs: flag - fill value status flag
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+/****if* H5Pf/h5pfill_value_defined_c
+ * NAME
+ * h5pfill_value_defined_c
+ * PURPOSE
+ * Call H5Pfill_value_defined to check if fill value is defined
+ * INPUTS
+ * prp_id - dataset creation property list identifier
+ * OUTPUTS
+ * flag - fill value status flag
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Friday, October 4, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pfill_value_defined_c ( hid_t_f *prp_id , int_f *flag)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -1933,20 +2359,29 @@ nh5pfill_value_defined_c ( hid_t_f *prp_id , int_f *flag)
ret_value = 0;
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_alloc_time_c
- * Purpose: Call H5Pget_alloc_time to get space allocation
+/****if* H5Pf/h5pget_alloc_time_c
+ * NAME
+ * h5pget_alloc_time_c
+ * PURPOSE
+ * Call H5Pget_alloc_time to get space allocation
* time for dataset during creation
- * Inputs: prp_id - dataset creation property list identifier
- * Outputs: flag - allocation time flag
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * INPUTS
+ * prp_id - dataset creation property list identifier
+ * OUTPUTS
+ * flag - allocation time flag
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Friday, October 4, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_alloc_time_c ( hid_t_f *prp_id , int_f *flag)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -1958,20 +2393,28 @@ nh5pget_alloc_time_c ( hid_t_f *prp_id , int_f *flag)
ret_value = 0;
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_alloc_time_c
- * Purpose: Call H5Pset_alloc_time to get space allocation
+/****if* H5Pf/h5pset_alloc_time_c
+ * NAME
+ * h5pset_alloc_time_c
+ * PURPOSE
+ * Call H5Pset_alloc_time to get space allocation
* time for dataset during creation
- * Inputs: prp_id - dataset creation property list identifier
+ * INPUTS
+ * prp_id - dataset creation property list identifier
* flag - allocation time flag
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Friday, October 4, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_alloc_time_c ( hid_t_f *prp_id , int_f *flag)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -1983,20 +2426,29 @@ nh5pset_alloc_time_c ( hid_t_f *prp_id , int_f *flag)
ret_value = 0;
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_fill_time_c
- * Purpose: Call H5Pget_fill_time to get fill value writing
+/****if* H5Pf/h5pget_fill_time_c
+ * NAME
+ * h5pget_fill_time_c
+ * PURPOSE
+ * Call H5Pget_fill_time to get fill value writing
* time for dataset during creation
- * Inputs: prp_id - dataset creation property list identifier
- * Outputs: flag - fill value writing time flag
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * INPUTS
+ * prp_id - dataset creation property list identifier
+ * OUTPUTS
+ * flag - fill value writing time flag
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Friday, October 4, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_fill_time_c ( hid_t_f *prp_id , int_f *flag)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -2008,20 +2460,28 @@ nh5pget_fill_time_c ( hid_t_f *prp_id , int_f *flag)
ret_value = 0;
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_fill_time_c
- * Purpose: Call H5Pset_fill_time to set fill value writing
+/****if* H5Pf/h5pset_fill_time_c
+ * NAME
+ * h5pset_fill_time_c
+ * PURPOSE
+ * Call H5Pset_fill_time to set fill value writing
* time for dataset during creation
- * Inputs: prp_id - dataset creation property list identifier
+ * INPUTS
+ * prp_id - dataset creation property list identifier
* flag - fill value writing time flag
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Friday, October 4, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_fill_time_c ( hid_t_f *prp_id , int_f *flag)
+/******/
{
int ret_value = -1;
hid_t c_prp_id;
@@ -2033,20 +2493,29 @@ nh5pset_fill_time_c ( hid_t_f *prp_id , int_f *flag)
ret_value = 0;
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_meta_block_size_c
- * Purpose: Call H5Pset_meta_block_size to set size of metadata block
- * Inputs: prp_id - file access property list identifier
+/****if* H5Pf/h5pset_meta_block_size_c
+ * NAME
+ * h5pset_meta_block_size_c
+ * PURPOSE
+ * Call H5Pset_meta_block_size to set size of metadata block
+ * INPUTS
+ * prp_id - file access property list identifier
* size - size of the metadata block
- * Outputs: NONE
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * OUTPUTS
+ * NONE
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Monday, October 7, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_meta_block_size_c ( hid_t_f *prp_id , hsize_t_f *size)
+/******/
{
int ret_value = 0;
hid_t c_prp_id;
@@ -2057,20 +2526,29 @@ nh5pset_meta_block_size_c ( hid_t_f *prp_id , hsize_t_f *size)
if ( H5Pset_meta_block_size(c_prp_id, c_size) < 0 ) ret_value = -1;
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_meta_block_size_c
- * Purpose: Call H5Pget_meta_block_size to get size of metadata block
- * Inputs: prp_id - file access property list identifier
- * Outputs:
+/****if* H5Pf/h5pget_meta_block_size_c
+ * NAME
+ * h5pget_meta_block_size_c
+ * PURPOSE
+ * Call H5Pget_meta_block_size to get size of metadata block
+ * INPUTS
+ * prp_id - file access property list identifier
+ * OUTPUTS
+ *
* size - size of the metadata block
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Monday, October 7, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_meta_block_size_c ( hid_t_f *prp_id , hsize_t_f *size)
+/******/
{
int ret_value = 0;
hid_t c_prp_id;
@@ -2081,20 +2559,29 @@ nh5pget_meta_block_size_c ( hid_t_f *prp_id , hsize_t_f *size)
*size = (hsize_t_f)c_size;
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_sieve_buf_size_c
- * Purpose: Call H5Pset_sieve_buf_size to set size of datasieve buffer
- * Inputs: prp_id - file access property list identifier
+/****if* H5Pf/h5pset_sieve_buf_size_c
+ * NAME
+ * h5pset_sieve_buf_size_c
+ * PURPOSE
+ * Call H5Pset_sieve_buf_size to set size of datasieve buffer
+ * INPUTS
+ * prp_id - file access property list identifier
* size - size of the buffer
- * Outputs: NONE
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * OUTPUTS
+ * NONE
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Monday, October 7, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_sieve_buf_size_c ( hid_t_f *prp_id , size_t_f *size)
+/******/
{
int ret_value = 0;
hid_t c_prp_id;
@@ -2105,20 +2592,29 @@ nh5pset_sieve_buf_size_c ( hid_t_f *prp_id , size_t_f *size)
if ( H5Pset_sieve_buf_size(c_prp_id, c_size) < 0 ) ret_value = -1;
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_sieve_buf_size_c
- * Purpose: Call H5Pget_sieve_buf_size to get size of datasieve buffer
- * Inputs: prp_id - file access property list identifier
- * Outputs:
+/****if* H5Pf/h5pget_sieve_buf_size_c
+ * NAME
+ * h5pget_sieve_buf_size_c
+ * PURPOSE
+ * Call H5Pget_sieve_buf_size to get size of datasieve buffer
+ * INPUTS
+ * prp_id - file access property list identifier
+ * OUTPUTS
+ *
* size - size of the buffer
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Monday, October 7, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_sieve_buf_size_c ( hid_t_f *prp_id , size_t_f *size)
+/******/
{
int ret_value = 0;
hid_t c_prp_id;
@@ -2129,20 +2625,29 @@ nh5pget_sieve_buf_size_c ( hid_t_f *prp_id , size_t_f *size)
*size = (size_t_f)c_size;
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_small_data_block_size_c
- * Purpose: Call H5Pset_small_data_block_size to set size of raw small data block
- * Inputs: prp_id - file access property list identifier
+/****if* H5Pf/h5pset_small_data_block_size_c
+ * NAME
+ * h5pset_small_data_block_size_c
+ * PURPOSE
+ * Call H5Pset_small_data_block_size to set size of raw small data block
+ * INPUTS
+ * prp_id - file access property list identifier
* size - size of the block
- * Outputs: NONE
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * OUTPUTS
+ * NONE
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Monday, October 7, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_small_data_block_size_c ( hid_t_f *prp_id , hsize_t_f *size)
+/******/
{
int ret_value = 0;
hid_t c_prp_id;
@@ -2153,20 +2658,29 @@ nh5pset_small_data_block_size_c ( hid_t_f *prp_id , hsize_t_f *size)
if ( H5Pset_small_data_block_size(c_prp_id, c_size) < 0 ) ret_value = -1;
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_small_data_block_size_c
- * Purpose: Call H5Pget_small_data_block_size to get size of raw small data block
- * Inputs: prp_id - file access property list identifier
- * Outputs:
+/****if* H5Pf/h5pget_small_data_block_size_c
+ * NAME
+ * h5pget_small_data_block_size_c
+ * PURPOSE
+ * Call H5Pget_small_data_block_size to get size of raw small data block
+ * INPUTS
+ * prp_id - file access property list identifier
+ * OUTPUTS
+ *
* size - size of the block
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Monday, October 7, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_small_data_block_size_c ( hid_t_f *prp_id , hsize_t_f *size)
+/******/
{
int ret_value = 0;
hid_t c_prp_id;
@@ -2177,20 +2691,29 @@ nh5pget_small_data_block_size_c ( hid_t_f *prp_id , hsize_t_f *size)
*size = (hsize_t_f)c_size;
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_hyper_vector_size_c
- * Purpose: Call H5Pset_hyper_vector_size to set size of the hyper vector
- * Inputs: prp_id - dataset transfer property list identifier
+/****if* H5Pf/h5pset_hyper_vector_size_c
+ * NAME
+ * h5pset_hyper_vector_size_c
+ * PURPOSE
+ * Call H5Pset_hyper_vector_size to set size of the hyper vector
+ * INPUTS
+ * prp_id - dataset transfer property list identifier
* size - size of the vector
- * Outputs: NONE
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * OUTPUTS
+ * NONE
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Monday, October 7, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_hyper_vector_size_c ( hid_t_f *prp_id , size_t_f *size)
+/******/
{
int ret_value = 0;
hid_t c_prp_id;
@@ -2201,20 +2724,29 @@ nh5pset_hyper_vector_size_c ( hid_t_f *prp_id , size_t_f *size)
if ( H5Pset_hyper_vector_size(c_prp_id, c_size) < 0 ) ret_value = -1;
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_hyper_vector_size_c
- * Purpose: Call H5Pget_hyper_vector_size to get size of the hyper vector
- * Inputs: prp_id - dataset transfer property list identifier
- * Outputs:
+/****if* H5Pf/h5pget_hyper_vector_size_c
+ * NAME
+ * h5pget_hyper_vector_size_c
+ * PURPOSE
+ * Call H5Pget_hyper_vector_size to get size of the hyper vector
+ * INPUTS
+ * prp_id - dataset transfer property list identifier
+ * OUTPUTS
+ *
* size - size of the vector
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Monday, October 7, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_hyper_vector_size_c ( hid_t_f *prp_id , size_t_f *size)
+/******/
{
int ret_value = 0;
hid_t c_prp_id;
@@ -2225,34 +2757,48 @@ nh5pget_hyper_vector_size_c ( hid_t_f *prp_id , size_t_f *size)
*size = (size_t_f)c_size;
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pcreate_class_c
- * Purpose: Call H5Pcreate_class ito create a new property class
- * Inputs: parent - property list class identifier
+
+/****if* H5Pf/h5pcreate_class_c
+ * NAME
+ * h5pcreate_class_c
+ * PURPOSE
+ * Call H5Pcreate_class ito create a new property class
+ * INPUTS
+ * parent - property list class identifier
* name - name of the new class
* name_len - lenght of the "name" buffer
- * Outputs: cls - new class identifier
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
- * October 11, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
-int_f
-nh5pcreate_class_c(hid_t_f *parent, _fcd name, int_f *name_len, hid_t_f *cls)
+ * OUTPUTS
+ * class - new class identifier
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
+ * October 11, 2002
+ *
+ * HISTORY
+ * Added the callback parameters (FORTRAN 2003 compilers only)
+ * M. Scot Breitenfeld, July 3, 2008
+ * SOURCE
+*/
+int_f
+nh5pcreate_class_c(hid_t_f *parent, _fcd name, int_f *name_len, hid_t_f *cls,
+ H5P_cls_create_func_t create, void *create_data,
+ H5P_cls_copy_func_t copy, void *copy_data,
+ H5P_cls_close_func_t close, void *close_data)
+/******/
{
int ret_value = -1;
- hid_t c_parent;
hid_t c_class;
char* c_name;
c_name = (char *)HD5f2cstring(name, (size_t)*name_len);
if (c_name == NULL) goto DONE;
- c_parent = (hid_t)*parent;
/*
* Call H5Pcreate_class function.
*/
- c_class = H5Pcreate_class(c_parent, c_name, NULL, NULL,NULL,NULL,NULL,NULL);
+ c_class = H5Pcreate_class((hid_t)*parent, c_name, create, create_data, copy, copy_data, close, close_data);
+
if (c_class < 0) goto DONE;
*cls = (hid_t_f)c_class;
ret_value = 0;
@@ -2262,21 +2808,30 @@ DONE:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pregisterc_c
- * Purpose: Call h5pregister_c to registers a permanent property
- * Inputs: cls - property list class identifier
+
+/****if* H5Pf/h5pregisterc_c
+ * NAME
+ * h5pregisterc_c
+ * PURPOSE
+ * Call h5pregister_c to registers a permanent property
+ * INPUTS
+ * class - property list class identifier
* name - name of the new property
* name_len - length of the "name" buffer
* size - property size
* value - property value of character type
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
- * October 11, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
+ * October 11, 2002
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pregisterc_c(hid_t_f *cls, _fcd name, int_f *name_len, size_t_f *size, _fcd value, int_f UNUSED *value_len)
+/******/
{
int ret_value = -1;
@@ -2287,21 +2842,29 @@ nh5pregisterc_c(hid_t_f *cls, _fcd name, int_f *name_len, size_t_f *size, _fcd v
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pregister_c
- * Purpose: Call H5Pregister2 to registers a permanent property
- * Inputs: cls - property list class identifier
+/****if* H5Pf/h5pregister_c
+ * NAME
+ * h5pregister_c
+ * PURPOSE
+ * Call H5Pregister2 to registers a permanent property
+ * INPUTS
+ * class - property list class identifier
* name - name of the new property
* name_len - length of the "name" buffer
* size - property size
* value - property value
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* October 11, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pregister_c(hid_t_f *cls, _fcd name, int_f *name_len, size_t_f *size, void UNUSED *value)
+/******/
{
char* c_name = NULL;
int_f ret_value = -1;
@@ -2349,21 +2912,29 @@ nh5pregister_double_c(hid_t_f *cls, _fcd name, int_f *name_len, size_t_f *size,
return nh5pregister_c(cls, name, name_len, size, value);
}
-/*----------------------------------------------------------------------------
- * Name: h5pinsertc_c
- * Purpose: Call h5pinsert_c to register a temporary property
- * Inputs: plist - property list identifier
+/****if* H5Pf/h5pinsertc_c
+ * NAME
+ * h5pinsertc_c
+ * PURPOSE
+ * Call h5pinsert_c to register a temporary property
+ * INPUTS
+ * plist - property list identifier
* name - name of the new property
* name_len - length of the "name" buffer
* size - property size
* value - property value of character type
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* October 11, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pinsertc_c(hid_t_f *plist, _fcd name, int_f *name_len, size_t_f *size, _fcd value, int_f UNUSED *value_len)
+/******/
{
int_f ret_value = -1;
@@ -2374,21 +2945,29 @@ nh5pinsertc_c(hid_t_f *plist, _fcd name, int_f *name_len, size_t_f *size, _fcd v
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pinsert_c
- * Purpose: Call H5Pinsert2 to iinsert a temporary property
- * Inputs: plist - property list class identifier
+/****if* H5Pf/h5pinsert_c
+ * NAME
+ * h5pinsert_c
+ * PURPOSE
+ * Call H5Pinsert2 to iinsert a temporary property
+ * INPUTS
+ * plist - property list class identifier
* name - name of the new property
* name_len - length of the "name" buffer
* size - property size
* value - property value
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* October 11, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pinsert_c(hid_t_f *plist, _fcd name, int_f *name_len, size_t_f *size, void UNUSED *value)
+/******/
{
char* c_name = NULL;
int_f ret_value = -1;
@@ -2436,20 +3015,28 @@ nh5pinsert_double_c(hid_t_f *plist, _fcd name, int_f *name_len, size_t_f *size,
return nh5pinsert_c(plist, name, name_len, size, value);
}
-/*----------------------------------------------------------------------------
- * Name: h5pexist_c
- * Purpose: Call H5Pexist to querie whether a property name exists
+/****if* H5Pf/h5pexist_c
+ * NAME
+ * h5pexist_c
+ * PURPOSE
+ * Call H5Pexist to querie whether a property name exists
* in a property list or class
- * Inputs: plist - property list or property class identifier
+ * INPUTS
+ * plist - property list or property class identifier
* name - name of the new property
* name_len - length of the "name" buffer
- * Returns: nonnegative on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * nonnegative on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* October 11, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pexist_c(hid_t_f *cls, _fcd name, int_f *name_len)
+/******/
{
int_f ret_value = -1;
hid_t c_class;
@@ -2470,19 +3057,27 @@ DONE:
if(c_name != NULL) HDfree(c_name);
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pisa_class_c
- * Purpose: Call H5Pisa_class to querie whether a property is a
+/****if* H5Pf/h5pisa_class_c
+ * NAME
+ * h5pisa_class_c
+ * PURPOSE
+ * Call H5Pisa_class to querie whether a property is a
* member of a class
- * Inputs: plist - property list identifier
+ * INPUTS
+ * plist - property list identifier
* cls - property class identifier
- * Returns: nonnegative on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * nonnegative on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* October 11, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pisa_class_c(hid_t_f *plist, hid_t_f *cls)
+/******/
{
int_f ret_value = -1;
hid_t c_class;
@@ -2499,20 +3094,29 @@ nh5pisa_class_c(hid_t_f *plist, hid_t_f *cls)
ret_value = status;
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_size_c
- * Purpose: Call H5Pget_size to querie the size of the property
- * Inputs: plist - property list to query
+/****if* H5Pf/h5pget_size_c
+ * NAME
+ * h5pget_size_c
+ * PURPOSE
+ * Call H5Pget_size to querie the size of the property
+ * INPUTS
+ * plist - property list to query
* name - name of the property
* name_len - length of the "name" buffer
- * Outputs: size - size of the property in bytes
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * OUTPUTS
+ * size - size of the property in bytes
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* October 11, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_size_c(hid_t_f *plist, _fcd name, int_f *name_len, size_t_f *size)
+/******/
{
int_f ret_value = -1;
hid_t c_plist;
@@ -2534,18 +3138,27 @@ DONE:
if(c_name != NULL) HDfree(c_name);
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_nprops_c
- * Purpose: Call H5Pget_nporps to get number of the properties in the list
- * Inputs: plist - property list to query
- * Outputs: nprops - number of properties in the list
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+/****if* H5Pf/h5pget_nprops_c
+ * NAME
+ * h5pget_nprops_c
+ * PURPOSE
+ * Call H5Pget_nporps to get number of the properties in the list
+ * INPUTS
+ * plist - property list to query
+ * OUTPUTS
+ * nprops - number of properties in the list
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* October 11, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_nprops_c(hid_t_f *plist, size_t_f *nprops)
+/******/
{
int_f ret_value = -1;
hid_t c_plist;
@@ -2562,19 +3175,28 @@ nh5pget_nprops_c(hid_t_f *plist, size_t_f *nprops)
ret_value = 0;
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_class_parent_c
- * Purpose: Call H5Pget_class_parent to get the parent class of
+/****if* H5Pf/h5pget_class_parent_c
+ * NAME
+ * h5pget_class_parent_c
+ * PURPOSE
+ * Call H5Pget_class_parent to get the parent class of
* a genereic property class
- * Inputs: prp_id - property list to query
- * Outputs: parent_id - parent classs identifier
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * INPUTS
+ * prp_id - property list to query
+ * OUTPUTS
+ * parent_id - parent classs identifier
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* October 11, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_class_parent_c(hid_t_f *prp_id, hid_t_f *parent_id)
+/******/
{
int_f ret_value = -1;
hid_t c_prp_id;
@@ -2592,21 +3214,29 @@ nh5pget_class_parent_c(hid_t_f *prp_id, hid_t_f *parent_id)
ret_value = 0;
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pcopy_prop_c
- * Purpose: Call H5Pcopy_prop to copy a property from one list or
+/****if* H5Pf/h5pcopy_prop_c
+ * NAME
+ * h5pcopy_prop_c
+ * PURPOSE
+ * Call H5Pcopy_prop to copy a property from one list or
* class to another
- * Inputs: dst_id - identifier of destination property list
+ * INPUTS
+ * dst_id - identifier of destination property list
* src_id - identifier of source property list
* name - name of the property
* name_len - length of the "name" buffer
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* October 11, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pcopy_prop_c(hid_t_f *dst_id, hid_t_f *src_id, _fcd name, int_f *name_len)
+/******/
{
int_f ret_value = -1;
hid_t c_dst_id, c_src_id;
@@ -2627,19 +3257,27 @@ DONE:
if(c_name != NULL) HDfree(c_name);
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5premove_c
- * Purpose: Call H5Premove to remove a property from a list
- * Inputs: plid - identifier of property list
+/****if* H5Pf/h5premove_c
+ * NAME
+ * h5premove_c
+ * PURPOSE
+ * Call H5Premove to remove a property from a list
+ * INPUTS
+ * plid - identifier of property list
* name - name of the property to remove
* name_len - length of the "name" buffer
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* October 11, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5premove_c(hid_t_f *plid, _fcd name, int_f *name_len)
+/******/
{
int_f ret_value = -1;
hid_t c_plid;
@@ -2659,19 +3297,27 @@ DONE:
if(c_name != NULL) HDfree(c_name);
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5punregister_c
- * Purpose: Call H5Punregister to remove a property from a property class
- * Inputs: cls - identifier of property class
+/****if* H5Pf/h5punregister_c
+ * NAME
+ * h5punregister_c
+ * PURPOSE
+ * Call H5Punregister to remove a property from a property class
+ * INPUTS
+ * cls - identifier of property class
* name - name of the property to unregister
* name_len - length of the "name" buffer
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
- * October 11, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
+ * October 11, 2002
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5punregister_c(hid_t_f *cls, _fcd name, int_f *name_len)
+/******/
{
int_f ret_value = -1;
hid_t c_class;
@@ -2691,17 +3337,25 @@ DONE:
if(c_name != NULL) HDfree(c_name);
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pclose_class_c
- * Purpose: Call H5Pclose_class to close property class
- * Inputs: cls - identifier of property class to close
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
- * October 11, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+/****if* H5Pf/h5pclose_class_c
+ * NAME
+ * h5pclose_class_c
+ * PURPOSE
+ * Call H5Pclose_class to close property class
+ * INPUTS
+ * class - identifier of property class to close
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
+ * October 11, 2002
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pclose_class_c(hid_t_f *cls)
+/******/
{
int_f ret_value = -1;
hid_t c_class;
@@ -2714,19 +3368,27 @@ nh5pclose_class_c(hid_t_f *cls)
ret_value = 0;
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_class_name_c
- * Purpose: Call H5Pget_class_name to get property class name
- * Inputs: cls - identifier of property class
+/****if* H5Pf/h5pget_class_name_c
+ * NAME
+ * h5pget_class_name_c
+ * PURPOSE
+ * Call H5Pget_class_name to get property class name
+ * INPUTS
+ * cls - identifier of property class
* name - ibuffer to retrieve name in
* name_len - length of the "name" buffer
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
- * October 11, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
+ * October 11, 2002
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_class_name_c(hid_t_f *cls, _fcd name, int_f *name_len)
+/******/
{
int_f ret_value = -1;
char *c_name = NULL; /* Buffer to hold C string */
@@ -2753,21 +3415,28 @@ DONE:
HDfree(c_name);
return ret_value;
}
-
-/*----------------------------------------------------------------------------
- * Name: h5pset_c
- * Purpose: Call h5setc_c to set property with the character string value
- * Inputs: plist - property list identifier
+/****if* H5Pf/h5psetc_c
+ * NAME
+ * h5psetc_c
+ * PURPOSE
+ * Call h5setc_c to set property with the character string value
+ * INPUTS
+ * plist - property list identifier
* name - name of property
* name_len - length of the "name" buffer
* value - property value of character type
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* October 11, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5psetc_c(hid_t_f *plist, _fcd name, int_f *name_len, _fcd value, int_f UNUSED *value_len)
+/******/
{
int_f ret_value = -1;
@@ -2778,33 +3447,39 @@ nh5psetc_c(hid_t_f *plist, _fcd name, int_f *name_len, _fcd value, int_f UNUSED
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_c
- * Purpose: Call H5Pset to set property value
- * Inputs: plist - property list class identifier
+/****if* H5Pf/h5pset_c
+ * NAME
+ * h5pset_c
+ * PURPOSE
+ * Call H5Pset to set property value
+ * INPUTS
+ * plist - property list class identifier
* name - name of the new property
* name_len - length of the "name" buffer
* value - property value
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
- * October 11, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
+ * October 11, 2002
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
-nh5pset_c(hid_t_f *plist, _fcd name, int_f *name_len, void UNUSED *value)
+nh5pset_c(hid_t_f *plist, _fcd name, int_f *name_len, void *value)
+/******/
{
int_f ret_value = -1;
- hid_t c_plist;
char* c_name;
c_name = (char *)HD5f2cstring(name, (size_t)*name_len);
if (c_name == NULL) goto DONE;
- c_plist = (hid_t)*plist;
/*
* Call H5Pset function.
*/
- if( H5Pset(c_plist, c_name, value) <0) goto DONE;
+ if( H5Pset((hid_t)*plist, c_name, value) <0) goto DONE;
ret_value = 0;
DONE:
@@ -2838,20 +3513,28 @@ nh5pset_double_c(hid_t_f *plist, _fcd name, int_f *name_len, void *value)
*/
return nh5pset_c(plist, name, name_len, value);
}
-/*----------------------------------------------------------------------------
- * Name: h5pgetc_c
- * Purpose: Call h5set_c to set property with the character string value
- * Inputs: plist - property list identifier
+/****if* H5Pf/h5pgetc_c
+ * NAME
+ * h5pgetc_c
+ * PURPOSE
+ * Call h5set_c to set property with the character string value
+ * INPUTS
+ * plist - property list identifier
* name - name of property
* name_len - length of the "name" buffer
* Output: value - property value of character type
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* October 11, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pgetc_c(hid_t_f *plist, _fcd name, int_f *name_len, _fcd value, int_f UNUSED *value_len)
+/******/
{
int_f ret_value = -1;
@@ -2862,33 +3545,39 @@ nh5pgetc_c(hid_t_f *plist, _fcd name, int_f *name_len, _fcd value, int_f UNUSED
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_c
- * Purpose: Call H5Pget to set property value
- * Inputs: plist - property list class identifier
+/****if* H5Pf/h5pget_c
+ * NAME
+ * h5pget_c
+ * PURPOSE
+ * Call H5Pget to set property value
+ * INPUTS
+ * plist - property list class identifier
* name - name of the new property
* name_len - length of the "name" buffer
* Output: value - property value
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* October 11, 2002
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
-nh5pget_c(hid_t_f *plist, _fcd name, int_f *name_len, void UNUSED *value)
+nh5pget_c(hid_t_f *plist, _fcd name, int_f *name_len, void *value)
+/******/
{
int_f ret_value = -1;
- hid_t c_plist;
char* c_name;
c_name = (char *)HD5f2cstring(name, (size_t)*name_len);
if (c_name == NULL) goto DONE;
- c_plist = (hid_t)*plist;
/*
* Call H5Pset function.
*/
- if( H5Pget(c_plist, c_name, value) <0) goto DONE;
+ if( H5Pget((hid_t)*plist, c_name, value) <0) goto DONE;
ret_value = 0;
DONE:
@@ -2924,19 +3613,27 @@ nh5pget_double_c(hid_t_f *plist, _fcd name, int_f *name_len, void *value)
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_shuffle_c
- * Purpose: Call H5Pset_shuffle
- * Inputs: prp_id - property list identifier
+/****if* H5Pf/h5pset_shuffle_c
+ * NAME
+ * h5pset_shuffle_c
+ * PURPOSE
+ * Call H5Pset_shuffle
+ * INPUTS
+ * prp_id - property list identifier
* type_size - size of the datatype in bytes
- * 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
nh5pset_shuffle_c ( hid_t_f *prp_id )
+/******/
{
int_f ret_value = 0;
hid_t c_prp_id;
@@ -2947,18 +3644,26 @@ nh5pset_shuffle_c ( hid_t_f *prp_id )
if ( status < 0 ) ret_value = -1;
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_fletcher32_c
- * Purpose: Call H5Pset_fletcher32 to enable EDC
- * Inputs: prp_id - dataset creation property list identifier
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+/****if* H5Pf/h5pset_fletcher32_c
+ * NAME
+ * h5pset_fletcher32_c
+ * PURPOSE
+ * Call H5Pset_fletcher32 to enable EDC
+ * INPUTS
+ * prp_id - dataset creation property list identifier
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Thursday, March 13, 2003
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_fletcher32_c ( hid_t_f *prp_id )
+/******/
{
int_f ret_value = 0;
hid_t c_prp_id;
@@ -2970,19 +3675,27 @@ nh5pset_fletcher32_c ( hid_t_f *prp_id )
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_edc_check_c
- * Purpose: Call H5Pset_edc_check to enable EDC
- * Inputs: prp_id - dataset transfer property list identifier
+/****if* H5Pf/h5pset_edc_check_c
+ * NAME
+ * h5pset_edc_check_c
+ * PURPOSE
+ * Call H5Pset_edc_check to enable EDC
+ * INPUTS
+ * prp_id - dataset transfer property list identifier
* flag - EDC flag
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Thursday, March 13, 2003
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_edc_check_c ( hid_t_f *prp_id, int_f *flag )
+/******/
{
int_f ret_value = 0;
hid_t c_prp_id;
@@ -2996,19 +3709,27 @@ nh5pset_edc_check_c ( hid_t_f *prp_id, int_f *flag )
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_edc_check_c
- * Purpose: Call H5Pget_edc_check to query EDC
- * Inputs: prp_id - dataset transfer property list identifier
+/****if* H5Pf/h5pget_edc_check_c
+ * NAME
+ * h5pget_edc_check_c
+ * PURPOSE
+ * Call H5Pget_edc_check to query EDC
+ * INPUTS
+ * prp_id - dataset transfer property list identifier
* Outouts: flag - EDC flag
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Thursday, March 13, 2003
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_edc_check_c ( hid_t_f *prp_id, int_f *flag )
+/******/
{
int_f ret_value = 0;
hid_t c_prp_id;
@@ -3020,19 +3741,27 @@ nh5pget_edc_check_c ( hid_t_f *prp_id, int_f *flag )
*flag = (int_f)c_flag;
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_family_offset_c
- * Purpose: Call H5Pset_family_offset to set and offset for family driver
- * Inputs: prp_id - property list identifier
+/****if* H5Pf/h5pset_family_offset_c
+ * NAME
+ * h5pset_family_offset_c
+ * PURPOSE
+ * Call H5Pset_family_offset to set and offset for family driver
+ * INPUTS
+ * prp_id - property list identifier
* offset - offset in bytes
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Wednesday, 19 March 2003
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_family_offset_c ( hid_t_f *prp_id , hsize_t_f *offset)
+/******/
{
int_f ret_value = 0;
hid_t c_prp_id;
@@ -3046,25 +3775,33 @@ nh5pset_family_offset_c ( hid_t_f *prp_id , hsize_t_f *offset)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_fapl_multi_c
- * Purpose: Call H5Pset_fapl_multi to set multi file dirver
- * Inputs: prp_id - file_creation property list identifier
+/****if* H5Pf/h5pset_fapl_multi_c
+ * NAME
+ * h5pset_fapl_multi_c
+ * PURPOSE
+ * Call H5Pset_fapl_multi to set multi file dirver
+ * INPUTS
+ * prp_id - file_creation property list identifier
* mem_map - memory mapping array
* memb_fapl - property list for each memory usage type
* memb_name - array with members names
* len - array with the lenght of each name
* lenmax - lenght of the name a sdeclared in Fortran
* flag - flag allowing partila access when one of the files is missing
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Monday 24, March 2003
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
/*nh5pset_fapl_multi_c ( hid_t_f *prp_id , int_f *memb_map, hid_t_f *memb_fapl, _fcd memb_name, int_f *len, int_f *lenmax, haddr_t_f *memb_addr, int_f *flag) */
nh5pset_fapl_multi_c ( hid_t_f *prp_id , int_f *memb_map, hid_t_f *memb_fapl, _fcd memb_name, int_f *len, int_f *lenmax, real_f *memb_addr, int_f *flag)
+/******/
{
int_f ret_value = -1;
hid_t c_prp_id;
@@ -3126,18 +3863,26 @@ DONE:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_fapl_multi_sc
- * Purpose: Call H5Pset_fapl_multi to set multi file dirver
- * Inputs: prp_id - file_creation property list identifier
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+/****if* H5Pf/h5pset_fapl_multi_sc
+ * NAME
+ * h5pset_fapl_multi_sc
+ * PURPOSE
+ * Call H5Pset_fapl_multi to set multi file dirver
+ * INPUTS
+ * prp_id - file_creation property list identifier
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* March 31 2003
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_fapl_multi_sc ( hid_t_f *prp_id , int_f *flag)
+/******/
{
int_f ret_value = -1;
hid_t c_prp_id;
@@ -3155,24 +3900,33 @@ nh5pset_fapl_multi_sc ( hid_t_f *prp_id , int_f *flag)
ret_value = 0;
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_fapl_multi_c
- * Purpose: Call H5Pget_fapl_multi to set multi file dirver
- * Inputs: prp_id - file_creation property list identifier
+/****if* H5Pf/h5pget_fapl_multi_c
+ * NAME
+ * h5pget_fapl_multi_c
+ * PURPOSE
+ * Call H5Pget_fapl_multi to set multi file dirver
+ * INPUTS
+ * prp_id - file_creation property list identifier
* lenmax - lenght of the name a sdeclared in Fortran
- * Outputs: memb_map - memory mapping array
+ * OUTPUTS
+ * memb_map - memory mapping array
* memb_fapl - property list for each memory usage type
* memb_name - array with members names
* len - array with the lenght of each name
* flag - flag allowing partila access when one of the files is missing
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* Monday 24, March 2003
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_fapl_multi_c ( hid_t_f *prp_id , int_f *memb_map, hid_t_f *memb_fapl, _fcd memb_name, int_f *len, int_f *lenmax, real_f *memb_addr, int_f *flag, int_f *maxlen_out)
+/******/
{
int_f ret_value = -1;
hid_t c_prp_id;
@@ -3230,20 +3984,28 @@ HD5packFstring(tmp, _fcdtocp(memb_name), (size_t)(c_lenmax*H5FD_MEM_NTYPES));
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_szip_c
- * Purpose: Call H5Pset_szip to set szip compression
- * Inputs: prp_id - dataset creation property list identifier
+/****if* H5Pf/h5pset_szip_c
+ * NAME
+ * h5pset_szip_c
+ * PURPOSE
+ * Call H5Pset_szip to set szip compression
+ * INPUTS
+ * prp_id - dataset creation property list identifier
* options_mask
* pixels_per_block -szip compression parameters
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* April 8 2003
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_szip_c ( hid_t_f *prp_id , int_f *options_mask, int_f *pixels_per_block)
+/******/
{
int_f ret_value = -1;
hid_t c_prp_id;
@@ -3263,19 +4025,28 @@ nh5pset_szip_c ( hid_t_f *prp_id , int_f *options_mask, int_f *pixels_per_block)
ret_value = 0;
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pall_filters_avail_c
- * Purpose: Call H5Pall_filters_avail
- * Inputs: prp_id - dataset creation property list identifier
- * Outputs: status - logical flag
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+/****if* H5Pf/h5pall_filters_avail_c
+ * NAME
+ * h5pall_filters_avail_c
+ * PURPOSE
+ * Call H5Pall_filters_avail
+ * INPUTS
+ * prp_id - dataset creation property list identifier
+ * OUTPUTS
+ * status - logical flag
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* April 10 2003
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pall_filters_avail_c ( hid_t_f *prp_id , int_f *status)
+/******/
{
int_f ret_value = -1;
hid_t c_prp_id;
@@ -3295,25 +4066,34 @@ nh5pall_filters_avail_c ( hid_t_f *prp_id , int_f *status)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_filter_by_id_c
- * Purpose: Call H5Pget_filter_by_id2 to get information about a filter
+/****if* H5Pf/h5pget_filter_by_id_c
+ * NAME
+ * h5pget_filter_by_id_c
+ * PURPOSE
+ * Call H5Pget_filter_by_id2 to get information about a filter
* in a pipeline
- * Inputs: prp_id - property list identifier
+ * INPUTS
+ * prp_id - property list identifier
* filter_id - filter id
* namelen - Anticipated number of characters in name.
- *Outputs: flags - Bit vector specifying certain general
+ *OUTPUT
+ * flags - Bit vector specifying certain general
* properties of the filter.
* cd_nelmts - Number of elements in cd_value
* cd_values - Auxiliary data for the filter.
* name - Name of the filter
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena POurmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena POurmal
* April 10, 2003
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_filter_by_id_c(hid_t_f *prp_id, int_f* filter_id, int_f* flags, size_t_f* cd_nelmts, int_f* cd_values, size_t_f *namelen, _fcd name)
+/******/
{
unsigned int c_flags;
size_t c_cd_nelmts = (size_t)*cd_nelmts;
@@ -3353,22 +4133,30 @@ DONE:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pmodify_filter_c
- * Purpose: Call H5Pmodify_filter to modify a filter
- * Inputs: prp_id - property list identifier
+/****if* H5Pf/h5pmodify_filter_c
+ * NAME
+ * h5pmodify_filter_c
+ * PURPOSE
+ * Call H5Pmodify_filter to modify a filter
+ * INPUTS
+ * prp_id - property list identifier
* filter - Filter to be modified
* flags - Bit vector specifying certain general
* properties of the filter.
* cd_nelmts - Number of elements in cd_values.
* cd_values - Auxiliary data for the filter.
- * Returns: 0 on success, -1 on failure
- * Programmer: Elena Pourmal
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Elena Pourmal
* April 10 2003
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pmodify_filter_c (hid_t_f *prp_id, int_f* filter, int_f* flags, size_t_f* cd_nelmts, int_f* cd_values )
+/******/
{
int_f ret_value = -1;
hid_t c_prp_id;
@@ -3401,18 +4189,26 @@ DONE:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5premove_filter_c
- * Purpose: Call H5Premove_filter to delete one or more filters
- * Inputs: prp_id - property list identifier
+/****if* H5Pf/h5premove_filter_c
+ * NAME
+ * h5premove_filter_c
+ * PURPOSE
+ * Call H5Premove_filter to delete one or more filters
+ * INPUTS
+ * prp_id - property list identifier
* filter - Filter to be deleted
- * Returns: 0 on success, -1 on failure
- * Programmer: Quincey Koziol
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * Quincey Koziol
* January 27 2004
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5premove_filter_c (hid_t_f *prp_id, int_f* filter)
+/******/
{
int_f ret_value = -1;
hid_t c_prp_id;
@@ -3431,20 +4227,28 @@ DONE:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_attr_phase_change_c
- * Purpose: Calls H5Pget_attr_phase_change
+/****if* H5Pf/h5pget_attr_phase_change_c
+ * NAME
+ * h5pget_attr_phase_change_c
+ * PURPOSE
+ * Calls H5Pget_attr_phase_change
*
- * Inputs: ocpl_id - Object (dataset or group) creation property list identifier
+ * INPUTS
+ * ocpl_id - Object (dataset or group) creation property list identifier
* Outputs max_compact - Maximum number of attributes to be stored in compact storage
* min_dense - Minimum number of attributes to be stored in dense storage
- * 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:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_attr_phase_change_c(hid_t_f *ocpl_id, int_f *max_compact, int_f *min_dense )
+/******/
{
int ret_value = -1;
hid_t c_ocpl_id;
@@ -3464,19 +4268,27 @@ nh5pget_attr_phase_change_c(hid_t_f *ocpl_id, int_f *max_compact, int_f *min_den
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_attr_creation_order_c
- * Purpose: Calls H5Ppset_attr_creation_order
+/****if* H5Pf/h5pset_attr_creation_order_c
+ * NAME
+ * h5pset_attr_creation_order_c
+ * PURPOSE
+ * Calls H5Ppset_attr_creation_order
*
- * Inputs: ocpl_id - Object (dataset or group) creation property list identifier
+ * INPUTS
+ * ocpl_id - Object (dataset or group) creation property list identifier
* Outputs crt_order_flags - Flags specifying whether to track and index attribute creation order
- * 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:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_attr_creation_order_c(hid_t_f *ocpl_id, int_f *crt_order_flags )
+/******/
{
int ret_value = -1;
unsigned c_crt_order_flags;
@@ -3493,23 +4305,32 @@ nh5pset_attr_creation_order_c(hid_t_f *ocpl_id, int_f *crt_order_flags )
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_shared_mesg_nindexes_c
- * Purpose: Calls h5pset_shared_mesg_nindexes
+/****if* H5Pf/h5pset_shared_mesg_nindexes_c
+ * NAME
+ * h5pset_shared_mesg_nindexes_c
+ * PURPOSE
+ * Calls h5pset_shared_mesg_nindexes
+ *
+ * INPUTS
*
- * Inputs:
* plist_id - file creation property list
* nindexes - Number of shared object header message indexes
* available in files created WITH this property list
*
- * Outputs:
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * OUTPUTS
+ *
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* January, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_shared_mesg_nindexes_c(hid_t_f *plist_id, int_f *nindexes )
+/******/
{
int ret_value = -1;
hid_t c_plist_id;
@@ -3527,24 +4348,33 @@ nh5pset_shared_mesg_nindexes_c(hid_t_f *plist_id, int_f *nindexes )
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_shared_mesg_index_c
- * Purpose: Calls H5Pset_shared_mesg_index
+/****if* H5Pf/h5pset_shared_mesg_index_c
+ * NAME
+ * h5pset_shared_mesg_index_c
+ * PURPOSE
+ * Calls H5Pset_shared_mesg_index
+ *
+ * INPUTS
*
- * Inputs:
* fcpl_id - File creation property list identifier.
* index_num - Index being configured.
* mesg_type_flags - Types of messages that should be stored in this index.
* min_mesg_size - Minimum message size.
*
- * Outputs:
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * OUTPUTS
+ *
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* January, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_shared_mesg_index_c(hid_t_f *fcpl_id, int_f *index_num, int_f *mesg_type_flags, int_f *min_mesg_size)
+/******/
{
int ret_value = -1;
herr_t ret;
@@ -3558,22 +4388,31 @@ nh5pset_shared_mesg_index_c(hid_t_f *fcpl_id, int_f *index_num, int_f *mesg_type
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_attr_creation_order_c
- * Purpose: Calls H5Pget_attr_creation_order
+/****if* H5Pf/h5pget_attr_creation_order_c
+ * NAME
+ * h5pget_attr_creation_order_c
+ * PURPOSE
+ * Calls H5Pget_attr_creation_order
+ *
+ * INPUTS
*
- * Inputs:
* ocpl_id - Object (group or dataset) creation property list identifier
- * Outputs:
+ * OUTPUTS
+ *
* crt_order_flags - Flags specifying whether to track and index attribute creation order
*
- * 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
nh5pget_attr_creation_order_c(hid_t_f *ocpl_id, int_f *crt_order_flags)
+/******/
{
int ret_value = -1;
herr_t ret;
@@ -3591,23 +4430,32 @@ nh5pget_attr_creation_order_c(hid_t_f *ocpl_id, int_f *crt_order_flags)
ret_value = 0;
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_libver_bounds_c
- * Purpose: Calls H5Pset_libver_bounds
+/****if* H5Pf/h5pset_libver_bounds_c
+ * NAME
+ * h5pset_libver_bounds_c
+ * PURPOSE
+ * Calls H5Pset_libver_bounds
+ *
+ * INPUTS
*
- * Inputs:
* fapl_id - File access property list identifier
* low - The earliest version of the library that will be used for writing objects.
* high - The latest version of the library that will be used for writing objects.
- * Outputs:
+ * OUTPUTS
*
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ *
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* February 18, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_libver_bounds_c(hid_t_f *fapl_id, int_f *low, int_f *high )
+/******/
{
int ret_value = -1;
herr_t ret;
@@ -3622,20 +4470,29 @@ nh5pset_libver_bounds_c(hid_t_f *fapl_id, int_f *low, int_f *high )
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_link_creation_order_c
- * Purpose: Calls H5Pset_link_creation_order
+/****if* H5Pf/h5pset_link_creation_order_c
+ * NAME
+ * h5pset_link_creation_order_c
+ * PURPOSE
+ * Calls H5Pset_link_creation_order
*
- * Inputs: gcpl_id - Group creation property list identifier
+ * INPUTS
+ * gcpl_id - Group creation property list identifier
* crt_order_flags - Creation order flag(s)
- * Outputs:
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * OUTPUTS
+ *
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* February 18, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_link_creation_order_c(hid_t_f *gcpl_id, int_f *crt_order_flags )
+/******/
{
int ret_value = -1;
herr_t ret;
@@ -3649,20 +4506,28 @@ nh5pset_link_creation_order_c(hid_t_f *gcpl_id, int_f *crt_order_flags )
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_link_phase_change_c
- * Purpose: Calls H5Pget_link_phase_change
+/****if* H5Pf/h5pget_link_phase_change_c
+ * NAME
+ * h5pget_link_phase_change_c
+ * PURPOSE
+ * Calls H5Pget_link_phase_change
*
- * Inputs: gcpl_id - Group creation property list identifier
+ * INPUTS
+ * gcpl_id - Group creation property list identifier
* Outputs max_compact - Maximum number of attributes to be stored in compact storage
* min_dense - Minimum number of attributes to be stored in dense storage
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* February 20, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_link_phase_change_c(hid_t_f *gcpl_id, int_f *max_compact, int_f *min_dense )
+/******/
{
int ret_value = -1;
unsigned c_max_compact;
@@ -3681,21 +4546,30 @@ nh5pget_link_phase_change_c(hid_t_f *gcpl_id, int_f *max_compact, int_f *min_den
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_obj_track_times_c
- * Purpose: Call H5Pget_obj_track_times
+/****if* H5Pf/h5pget_obj_track_times_c
+ * NAME
+ * h5pget_obj_track_times_c
+ * PURPOSE
+ * Call H5Pget_obj_track_times
+ *
+ * INPUTS
+ * plist_id - property list id
+ * OUTPUTS
*
- * Inputs: plist_id - property list id
- * Outputs:
* flag - TRUE/FALSE flag
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* February 22, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_obj_track_times_c(hid_t_f *plist_id, int_f *flag)
+/******/
{
int ret_value = -1;
hbool_t c_track_times=0;
@@ -3714,20 +4588,28 @@ nh5pget_obj_track_times_c(hid_t_f *plist_id, int_f *flag)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_obj_track_times_c
- * Purpose: Call H5Pset_obj_track_times
+/****if* H5Pf/h5pset_obj_track_times_c
+ * NAME
+ * h5pset_obj_track_times_c
+ * PURPOSE
+ * Call H5Pset_obj_track_times
*
- * Inputs: plist_id - property list id
+ * INPUTS
+ * plist_id - property list id
* flag - TRUE/FALSE flag
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* February 22, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_obj_track_times_c(hid_t_f *plist_id, int_f *flag)
+/******/
{
int ret_value = -1;
hbool_t c_track_times;
@@ -3746,23 +4628,31 @@ nh5pset_obj_track_times_c(hid_t_f *plist_id, int_f *flag)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_create_inter_group_c
- * Purpose: Calls H5Pset_create_intermediate_group
+/****if* H5Pf/h5pset_create_inter_group_c
+ * NAME
+ * h5pset_create_inter_group_c
+ * PURPOSE
+ * Calls H5Pset_create_intermediate_group
+ *
+ * INPUTS
*
- * Inputs:
* lcpl_id - Link creation property list identifier
* crt_intermed_group - crt_intermed_group specifying whether
* to create intermediate groups upon the
* creation of an object
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* February 22, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_create_inter_group_c(hid_t_f *lcpl_id, int_f *crt_intermed_group)
+/******/
{
int ret_value = -1;
herr_t ret;
@@ -3777,22 +4667,31 @@ nh5pset_create_inter_group_c(hid_t_f *lcpl_id, int_f *crt_intermed_group)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_link_creation_order_c
- * Purpose: Calls H5Pget_link_creation_order
+/****if* H5Pf/h5pget_link_creation_order_c
+ * NAME
+ * h5pget_link_creation_order_c
+ * PURPOSE
+ * Calls H5Pget_link_creation_order
+ *
+ * INPUTS
*
- * Inputs:
* gcpl_id - Group creation property list identifier
- * Outputs:
+ * OUTPUTS
+ *
* crt_order_flags - Creation order flag(s)
*
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* March 3, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_link_creation_order_c(hid_t_f *gcpl_id, int_f *crt_order_flags)
+/******/
{
int ret_value = -1;
herr_t ret;
@@ -3811,24 +4710,33 @@ nh5pget_link_creation_order_c(hid_t_f *gcpl_id, int_f *crt_order_flags)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_char_encoding_c
- * Purpose: Calls H5Pset_char_encoding
+/****if* H5Pf/h5pset_char_encoding_c
+ * NAME
+ * h5pset_char_encoding_c
+ * PURPOSE
+ * Calls H5Pset_char_encoding
+ *
+ * INPUTS
*
- * Inputs:
* plist_id - Property list identifier
* encoding - String encoding character set:
* H5T_CSET_ASCII_F -> US ASCII
* H5T_CSET_UTF8_F -> UTF-8 Unicode encoding
- * Outputs: NONE
+ * OUTPUTS
+ * NONE
*
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* March 3, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_char_encoding_c(hid_t_f *plist_id, int_f *encoding)
+/******/
{
int ret_value = -1;
herr_t ret;
@@ -3844,24 +4752,33 @@ nh5pset_char_encoding_c(hid_t_f *plist_id, int_f *encoding)
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_char_encoding_c
- * Purpose: Calls H5Pget_char_encoding
+/****if* H5Pf/h5pget_char_encoding_c
+ * NAME
+ * h5pget_char_encoding_c
+ * PURPOSE
+ * Calls H5Pget_char_encoding
+ *
+ * INPUTS
*
- * Inputs:
* plist_id - Property list identifier
- * Outputs:
+ * OUTPUTS
+ *
* encoding - Encoding character set:
* H5T_CSET_ASCII_F -> US ASCII
* H5T_CSET_UTF8_F -> UTF-8 Unicode encoding
*
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* March 3, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_char_encoding_c(hid_t_f *plist_id, int_f *encoding)
+/******/
{
int ret_value = -1;
H5T_cset_t c_encoding;
@@ -3878,24 +4795,33 @@ nh5pget_char_encoding_c(hid_t_f *plist_id, int_f *encoding)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_copy_object_c
- * Purpose: Calls H5Pset_copy_object
+/****if* H5Pf/h5pset_copy_object_c
+ * NAME
+ * h5pset_copy_object_c
+ * PURPOSE
+ * Calls H5Pset_copy_object
+ *
+ * INPUTS
*
- * Inputs:
* ocp_plist_id - Object copy property list identifier
* copy_options - Copy option(s) to be set
*
- * Outputs:
+ * OUTPUTS
+ *
* NONE
*
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* March 3, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_copy_object_c(hid_t_f *ocp_plist_id, int_f *copy_options)
+/******/
{
int ret_value = -1;
herr_t ret;
@@ -3909,23 +4835,32 @@ nh5pset_copy_object_c(hid_t_f *ocp_plist_id, int_f *copy_options)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_copy_object_c
- * Purpose: Calls H5Pget_copy_object
+/****if* H5Pf/h5pget_copy_object_c
+ * NAME
+ * h5pget_copy_object_c
+ * PURPOSE
+ * Calls H5Pget_copy_object
+ *
+ * INPUTS
*
- * Inputs:
* ocp_plist_id - Object copy property list identifier
*
- * Outputs:
+ * OUTPUTS
+ *
* copy_options - Copy option(s) to be get
*
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* March 3, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_copy_object_c(hid_t_f *ocp_plist_id, int_f *copy_options)
+/******/
{
int ret_value = -1;
unsigned c_copy_options;
@@ -3942,26 +4877,34 @@ nh5pget_copy_object_c(hid_t_f *ocp_plist_id, int_f *copy_options)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_data_transform_c
- * Purpose: Calls H5Pget_data_transform
- * Inputs:
+/****if* H5Pf/h5pget_data_transform_c
+ * NAME
+ * h5pget_data_transform_c
+ * PURPOSE
+ * Calls H5Pget_data_transform
+ * INPUTS
+ *
* prp_id - property list identifier to query
* expression_len - buffer size transorm expression
*
* Output:
* expression - buffer to hold transform expression
*
- * Returns:
+ * RETURNS
+ *
* Success: 0
* Failure: -1
*
- * Programmer: M.S. Breitenfeld
+ * AUTHOR
+ * M. Scot Breitenfeld
* March 19, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_data_transform_c(hid_t_f *plist_id, _fcd expression, int_f *expression_len, size_t_f *size)
+/******/
{
char *c_expression = NULL; /* Buffer to hold C string */
size_t c_expression_len;
@@ -3998,26 +4941,34 @@ done:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_data_transform_c
- * Purpose: Calls H5Pset_data_transform
- * Inputs:
+/****if* H5Pf/h5pset_data_transform_c
+ * NAME
+ * h5pset_data_transform_c
+ * PURPOSE
+ * Calls H5Pset_data_transform
+ * INPUTS
+ *
* prp_id - property list identifier to query
* expression - buffer to hold transform expression
* expression_len - buffer size transorm expression
*
* Output:
*
- * Returns:
+ * RETURNS
+ *
* Success: 0
* Failure: -1
*
- * Programmer: M.S. Breitenfeld
+ * AUTHOR
+ * M. Scot Breitenfeld
* March 19, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_data_transform_c(hid_t_f *plist_id, _fcd expression, int_f *expression_len)
+/******/
{
char* c_expression = NULL; /* Buffer to hold C string */
int_f ret_value = 0; /* Return value */
@@ -4041,24 +4992,32 @@ done:
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_local_heap_size_hint_c
- * Purpose: Calls H5Pget_local_heap_size_hint
- * Inputs:
+/****if* H5Pf/h5pget_local_heap_size_hint_c
+ * NAME
+ * h5pget_local_heap_size_hint_c
+ * PURPOSE
+ * Calls H5Pget_local_heap_size_hint
+ * INPUTS
+ *
* gcpl_id - Group creation property list identifier
*
* Output:
* size_hint - Hint for size of local heap
- * Returns:
+ * RETURNS
+ *
* Success: 0
* Failure: -1
*
- * Programmer: M.S. Breitenfeld
+ * AUTHOR
+ * M. Scot Breitenfeld
* March 21, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_local_heap_size_hint_c(hid_t_f *gcpl_id, size_t_f *size_hint)
+/******/
{
int_f ret_value = -1; /* Return value */
size_t c_size_hint;
@@ -4074,25 +5033,33 @@ nh5pget_local_heap_size_hint_c(hid_t_f *gcpl_id, size_t_f *size_hint)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_est_link_info_c
- * Purpose: Calls H5Pget_est_link_info
- * Inputs:
+/****if* H5Pf/h5pget_est_link_info_c
+ * NAME
+ * h5pget_est_link_info_c
+ * PURPOSE
+ * Calls H5Pget_est_link_info
+ * INPUTS
+ *
* gcpl_id - Group creation property list identifier
*
* Output:
* est_num_entries - Estimated number of links to be inserted into group
* est_name_len - Estimated average length of link names
- * Returns:
+ * RETURNS
+ *
* Success: 0
* Failure: -1
*
- * Programmer: M.S. Breitenfeld
+ * AUTHOR
+ * M. Scot Breitenfeld
* March 21, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_est_link_info_c(hid_t_f *gcpl_id, int_f *est_num_entries, int_f *est_name_len)
+/******/
{
int_f ret_value = -1; /* Return value */
unsigned c_est_num_entries;
@@ -4111,25 +5078,33 @@ nh5pget_est_link_info_c(hid_t_f *gcpl_id, int_f *est_num_entries, int_f *est_nam
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_local_heap_size_hint_c
- * Purpose: Calls H5Pset_local_heap_size_hint
- * Inputs:
+/****if* H5Pf/h5pset_local_heap_size_hint_c
+ * NAME
+ * h5pset_local_heap_size_hint_c
+ * PURPOSE
+ * Calls H5Pset_local_heap_size_hint
+ * INPUTS
+ *
* gcpl_id - Group creation property list identifier
* size_hint - Hint for size of local heap
*
* Output:
*
- * Returns:
+ * RETURNS
+ *
* Success: 0
* Failure: -1
*
- * Programmer: M.S. Breitenfeld
+ * AUTHOR
+ * M. Scot Breitenfeld
* March 21, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_local_heap_size_hint_c(hid_t_f *gcpl_id, size_t_f *size_hint)
+/******/
{
int_f ret_value = -1; /* Return value */
herr_t ret;
@@ -4143,25 +5118,33 @@ nh5pset_local_heap_size_hint_c(hid_t_f *gcpl_id, size_t_f *size_hint)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_est_link_info_c
- * Purpose: Calls H5Pset_est_link_info
- * Inputs:
+/****if* H5Pf/h5pset_est_link_info_c
+ * NAME
+ * h5pset_est_link_info_c
+ * PURPOSE
+ * Calls H5Pset_est_link_info
+ * INPUTS
+ *
* gcpl_id - Group creation property list identifier
* est_num_entries - Estimated number of links to be inserted into group
* est_name_len - Estimated average length of link names
*
* Output:
- * Returns:
+ * RETURNS
+ *
* Success: 0
* Failure: -1
*
- * Programmer: M.S. Breitenfeld
+ * AUTHOR
+ * M. Scot Breitenfeld
* March 21, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_est_link_info_c(hid_t_f *gcpl_id, int_f *est_num_entries, int_f *est_name_len)
+/******/
{
int_f ret_value = -1; /* Return value */
herr_t ret;
@@ -4175,21 +5158,29 @@ nh5pset_est_link_info_c(hid_t_f *gcpl_id, int_f *est_num_entries, int_f *est_nam
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_link_phase_change_c
- * Purpose: Calls H5Pset_link_phase_change
+/****if* H5Pf/h5pset_link_phase_change_c
+ * NAME
+ * h5pset_link_phase_change_c
+ * PURPOSE
+ * Calls H5Pset_link_phase_change
*
- * Inputs: gcpl_id - Group creation property list identifier
+ * INPUTS
+ * gcpl_id - Group creation property list identifier
* max_compact - Maximum number of attributes to be stored in compact storage
* min_dense - Minimum number of attributes to be stored in dense storage
* Outputs
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* March 21, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_link_phase_change_c(hid_t_f *gcpl_id, int_f *max_compact, int_f *min_dense )
+/******/
{
int ret_value = -1;
herr_t ret;
@@ -4204,23 +5195,31 @@ nh5pset_link_phase_change_c(hid_t_f *gcpl_id, int_f *max_compact, int_f *min_den
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_fapl_direct_c
- * Purpose: Calls H5Pset_fapl_direct
+/****if* H5Pf/h5pset_fapl_direct_c
+ * NAME
+ * h5pset_fapl_direct_c
+ * PURPOSE
+ * Calls H5Pset_fapl_direct
+ *
+ * INPUTS
*
- * Inputs:
* fapl_id - File access property list identifier
* alignment - Required memory alignment boundary
* block_size - File system block size
* cbuf_size - Copy buffer size
* Outputs
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* March 21, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_fapl_direct_c(hid_t_f UNUSED *fapl_id, size_t_f UNUSED *alignment, size_t_f UNUSED *block_size, size_t_f UNUSED *cbuf_size)
+/******/
{
int ret_value = -1;
#ifdef H5_HAVE_DIRECT
@@ -4238,23 +5237,32 @@ nh5pset_fapl_direct_c(hid_t_f UNUSED *fapl_id, size_t_f UNUSED *alignment, size_
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_fapl_direct_c
- * Purpose: Calls H5Pget_fapl_direct
+/****if* H5Pf/h5pget_fapl_direct_c
+ * NAME
+ * h5pget_fapl_direct_c
+ * PURPOSE
+ * Calls H5Pget_fapl_direct
+ *
+ * INPUTS
*
- * Inputs:
* fapl_id - File access property list identifier
- * Outputs:
+ * OUTPUTS
+ *
* alignment - Required memory alignment boundary
* block_size - File system block size
* cbuf_size - Copy buffer size
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* March 21, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_fapl_direct_c(hid_t_f UNUSED *fapl_id, size_t_f UNUSED *alignment, size_t_f UNUSED *block_size, size_t_f UNUSED *cbuf_size)
+/******/
{
int ret_value = -1;
#ifdef H5_HAVE_DIRECT
@@ -4278,21 +5286,30 @@ nh5pget_fapl_direct_c(hid_t_f UNUSED *fapl_id, size_t_f UNUSED *alignment, size_
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_attr_phase_change_c
- * Purpose: Calls H5Pset_attr_phase_change
+/****if* H5Pf/h5pset_attr_phase_change_c
+ * NAME
+ * h5pset_attr_phase_change_c
+ * PURPOSE
+ * Calls H5Pset_attr_phase_change
*
- * Inputs: ocpl_id - Object (dataset or group) creation property list identifier
+ * INPUTS
+ * ocpl_id - Object (dataset or group) creation property list identifier
* max_compact - Maximum number of attributes to be stored in compact storage
* min_dense - Minimum number of attributes to be stored in dense storage
- * Outputs:
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * OUTPUTS
+ *
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* March 21, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_attr_phase_change_c(hid_t_f *ocpl_id, int_f *max_compact, int_f *min_dense )
+/******/
{
int ret_value = -1;
herr_t ret;
@@ -4306,19 +5323,28 @@ nh5pset_attr_phase_change_c(hid_t_f *ocpl_id, int_f *max_compact, int_f *min_den
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_nbit_c
- * Purpose: Calls H5Pset_nbit
+/****if* H5Pf/h5pset_nbit_c
+ * NAME
+ * h5pset_nbit_c
+ * PURPOSE
+ * Calls H5Pset_nbit
*
- * Inputs: plist_id - Dataset creation property list identifier
- * Outputs:
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * INPUTS
+ * plist_id - Dataset creation property list identifier
+ * OUTPUTS
+ *
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* March 21, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pset_nbit_c(hid_t_f *plist_id )
+/******/
{
int ret_value = -1;
herr_t ret;
@@ -4331,22 +5357,27 @@ nh5pset_nbit_c(hid_t_f *plist_id )
ret_value = 0;
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_scaleoffset_c
- * Purpose: Calls H5Pset_scaleoffset
+/****if* H5Pf/h5pset_scaleoffset_c
+ * NAME
+ * h5pset_scaleoffset_c
+ * PURPOSE
+ * Calls H5Pset_scaleoffset
*
- * Inputs:
- * plist_id - Dataset creation property list identifier
- * scale_type - Flag indicating compression method.
+ * INPUTS
+ * plist_id - Dataset creation property list identifier
+ * scale_type - Flag indicating compression method.
* scale_factor - Parameter related to scale.
- * Outputs:
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
- * March 21, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ *
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
+ * March 21, 2008
+ * SOURCE
+*/
int_f
nh5pset_scaleoffset_c(hid_t_f *plist_id, int_f *scale_type, int_f *scale_factor )
+/******/
{
int ret_value = -1;
H5Z_SO_scale_type_t c_scale_type;
@@ -4363,21 +5394,25 @@ nh5pset_scaleoffset_c(hid_t_f *plist_id, int_f *scale_type, int_f *scale_factor
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pset_nlinks
- * Purpose: Calls H5Pset_nlinks
+/****if* H5Pf/h5pset_nlinks
+ * NAME
+ * h5pset_nlinks
+ * PURPOSE
+ * Calls H5Pset_nlinks
*
- * Inputs:
- * lapl_id - File access property list identifier
- * nlinks - Maximum number of links to traverse
- * Outputs:
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
- * March 24, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * INPUTS
+ * lapl_id - File access property list identifier
+ * nlinks - Maximum number of links to traverse
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
+ * March 24, 2008
+ * SOURCE
+*/
int_f
nh5pset_nlinks_c(hid_t_f *lapl_id, size_t_f *nlinks)
+/******/
{
int ret_value = -1;
herr_t ret;
@@ -4391,23 +5426,32 @@ nh5pset_nlinks_c(hid_t_f *lapl_id, size_t_f *nlinks)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_nlinks
- * Purpose: Calls H5Pget_nlinks
+/****if* H5Pf/h5pget_nlinks
+ * NAME
+ * h5pget_nlinks
+ * PURPOSE
+ * Calls H5Pget_nlinks
+ *
+ * INPUTS
*
- * Inputs:
* lapl_id - File access property list identifier
*
- * Outputs:
+ * OUTPUTS
+ *
* nlinks - Maximum number of links to traverse
*
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* March 24, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_nlinks_c(hid_t_f *lapl_id, size_t_f *nlinks)
+/******/
{
int ret_value = -1;
herr_t ret;
@@ -4423,22 +5467,29 @@ nh5pget_nlinks_c(hid_t_f *lapl_id, size_t_f *nlinks)
return ret_value;
}
-/*----------------------------------------------------------------------------
- * Name: h5pget_create_inter_group_c
- * Purpose: Calls H5Pget_create_intermediate_group
+/****if* H5Pf/h5pget_create_inter_group_c
+ * NAME
+ * h5pget_create_inter_group_c
+ * PURPOSE
+ * Calls H5Pget_create_intermediate_group
+ *
+ * INPUTS
*
- * Inputs:
* lcpl_id - Link creation property list identifier
* crt_intermed_group - Specifying whether to create intermediate groups upon
* the creation of an object
- * Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * RETURNS
+ * 0 on success, -1 on failure
+ * AUTHOR
+ * M. Scot Breitenfeld
* April 4, 2008
- * Modifications:
- *---------------------------------------------------------------------------*/
-
+ * HISTORY
+ *
+ * SOURCE
+*/
int_f
nh5pget_create_inter_group_c(hid_t_f *lcpl_id, int_f *crt_intermed_group)
+/******/
{
int ret_value = -1;
herr_t ret;
@@ -4466,7 +5517,7 @@ nh5pget_create_inter_group_c(hid_t_f *lcpl_id, int_f *crt_intermed_group)
* rdcc_w0 -
*
* Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * Programmer: M. Scot Breitenfeld
* April 13, 2009
* Modifications:
*---------------------------------------------------------------------------*/
@@ -4497,7 +5548,7 @@ nh5pset_chunk_cache_c(hid_t_f *dapl_id, size_t_f *rdcc_nslots, size_t_f *rdcc_nb
* rdcc_w0 -
*
* Returns: 0 on success, -1 on failure
- * Programmer: M.S. Breitenfeld
+ * Programmer: M. Scot Breitenfeld
* April 13, 2009
* Modifications:
*---------------------------------------------------------------------------*/
generated by cgit v0.12 at 2024-11-20 09:44:37 (GMT)