summaryrefslogtreecommitdiffstats
path: root/fortran/src/H5Lf.c
diff options
context:
space:
mode:
Diffstat (limited to 'fortran/src/H5Lf.c')
-rw-r--r--fortran/src/H5Lf.c294
1 files changed, 147 insertions, 147 deletions
diff --git a/fortran/src/H5Lf.c b/fortran/src/H5Lf.c
index f4ad1d4..0d3aac2 100644
--- a/fortran/src/H5Lf.c
+++ b/fortran/src/H5Lf.c
@@ -1,6 +1,6 @@
/****h* H5Lf/H5Lf
* PURPOSE
- * This file contains C stubs for H5L Fortran APIs
+ * This file contains C stubs for H5L Fortran APIs
*
* COPYRIGHT
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
@@ -26,27 +26,27 @@
/****if* H5Lf/h5lcopy_c
* NAME
- * h5lcopy_c
+ * h5lcopy_c
* PURPOSE
- * Call H5Lcopy
+ * Call H5Lcopy
* INPUTS
*
- * src_loc_id - Location identifier of the source link
- * src_name - Name of the link to be copied
- * src_namelen - length of the name
- * dest_loc_id - Location identifier specifying the destination of the copy
- * dest_name - Name to be assigned to the NEW copy
- * dest_namelen - Length of the name
- * loc_id - Identifier of the file or group containing the object
- * name - Name of the link to delete
- * lcpl_id - Link creation property list identifier
- * lapl_id - Link access property list identifier
+ * src_loc_id - Location identifier of the source link
+ * src_name - Name of the link to be copied
+ * src_namelen - length of the name
+ * dest_loc_id - Location identifier specifying the destination of the copy
+ * dest_name - Name to be assigned to the NEW copy
+ * dest_namelen - Length of the name
+ * loc_id - Identifier of the file or group containing the object
+ * name - Name of the link to delete
+ * lcpl_id - Link creation property list identifier
+ * lapl_id - Link access property list identifier
*
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* M. Scot Breitenfeld
- * January, 2008
+ * January, 2008
* HISTORY
*
* SOURCE
@@ -88,21 +88,21 @@ done:
/****if* H5Lf/h5lcreate_external_c
* NAME
- * h5lcreate_external_c
+ * h5lcreate_external_c
* PURPOSE
- * Call H5Lcreate_external_c
+ * Call H5Lcreate_external_c
* INPUTS
*
- * file_name - Name of the file containing the target object. Neither the file nor the target object is
- * required to exist. May be the file the link is being created in.
- * obj_name - Path within the target file to the target object.
+ * file_name - Name of the file containing the target object. Neither the file nor the target object is
+ * required to exist. May be the file the link is being created in.
+ * obj_name - Path within the target file to the target object.
* link_loc_id - The file or group identifier for the new link.
- * link_name - The name of the new link.
- * lcpl_id - Link creation property list identifier.
- * lapl_id - Link access property list identifier.
+ * link_name - The name of the new link.
+ * lcpl_id - Link creation property list identifier.
+ * lapl_id - Link access property list identifier.
*
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* M. Scot Breitenfeld
* February 29, 2008
@@ -150,22 +150,22 @@ done:
/****if* H5Lf/h5ldelete_c
* NAME
- * h5ldelete_c
+ * h5ldelete_c
* PURPOSE
- * Call H5Ldelete
+ * Call H5Ldelete
* INPUTS
*
*
- * loc_id - Identifier of the file or group containing the object
- * name - Name of the link to delete
- * lapl_id - Link access property list identifier
- * namelen - length of name
+ * loc_id - Identifier of the file or group containing the object
+ * name - Name of the link to delete
+ * lapl_id - Link access property list identifier
+ * namelen - length of name
*
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* M. Scot Breitenfeld
- * January, 2008
+ * January, 2008
* SOURCE
*/
@@ -197,23 +197,23 @@ done:
/****if* H5Lf/h5lcreate_soft_c
* NAME
- * h5lcreate_soft_c
+ * h5lcreate_soft_c
* PURPOSE
- * Call H5Lcreate_soft
+ * Call H5Lcreate_soft
* INPUTS
*
*
- * target_path - Path to the target object, which is not required to exist.
- * link_loc_id - The file or group identifier for the new link.
- * link_name - The name of the new link.
- * lcpl_id - Link creation property list identifier.
- * lapl_id - Link access property list identifier.
+ * target_path - Path to the target object, which is not required to exist.
+ * link_loc_id - The file or group identifier for the new link.
+ * link_name - The name of the new link.
+ * lcpl_id - Link creation property list identifier.
+ * lapl_id - Link access property list identifier.
*
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* M. Scot Breitenfeld
- * February 20, 2008
+ * February 20, 2008
* SOURCE
*/
@@ -253,22 +253,22 @@ h5lcreate_soft_c(_fcd target_path, size_t_f *target_path_len,
/****if* H5Lf/h5lcreate_hard_c
* NAME
- * h5lcreate_hard_c
+ * h5lcreate_hard_c
* PURPOSE
- * Call H5Lcreate_hard
+ * Call H5Lcreate_hard
* INPUTS
*
- * obj_loc_id - The file or group identifier for the target object.
- * obj_name - Name of the target object, which must already exist.
- * obj_namelen - Name length
- * link_loc_id - The file or group identifier for the new link.
- * link_name - The name of the new link.
- * link_namelen- Name length
- * lcpl_id - Link creation property list identifier.
- * lapl_id - Link access property list identifier.
+ * obj_loc_id - The file or group identifier for the target object.
+ * obj_name - Name of the target object, which must already exist.
+ * obj_namelen - Name length
+ * link_loc_id - The file or group identifier for the new link.
+ * link_name - The name of the new link.
+ * link_namelen- Name length
+ * lcpl_id - Link creation property list identifier.
+ * lapl_id - Link access property list identifier.
*
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* M. Scot Breitenfeld
* February 27, 2008
@@ -310,35 +310,35 @@ h5lcreate_hard_c(hid_t_f *obj_loc_id, _fcd obj_name, size_t_f *obj_namelen,
/****if* H5Lf/h5ldelete_by_idx_c
* NAME
- * h5ldelete_by_idx_c
+ * h5ldelete_by_idx_c
* PURPOSE
- * Calls h5ldelete_by_idx
+ * Calls h5ldelete_by_idx
* INPUTS
*
- * loc_id - File or group identifier specifying location of subject group
- * group_name - Name of subject group
- * group_namelen - Name length
- * index_field - Type of index; Possible values are:
+ * loc_id - File or group identifier specifying location of subject group
+ * group_name - Name of subject group
+ * group_namelen - Name length
+ * index_field - Type of index; Possible values are:
* H5_INDEX_UNKNOWN_F = -1 - Unknown index type
* H5_INDEX_NAME_F - Index on names
* H5_INDEX_CRT_ORDER_F - Index on creation order
* H5_INDEX_N_F - Number of indices defined
- * order - Order within field or index; Possible values are:
+ * order - Order within field or index; Possible values are:
* H5_ITER_UNKNOWN_F - Unknown order
* H5_ITER_INC_F - Increasing order
* H5_ITER_DEC_F - Decreasing order
* H5_ITER_NATIVE_F - No particular order, whatever is fastest
* H5_ITER_N_F - Number of iteration orders
- * n - Link for which to retrieve information
- * lapl_id - Link access property list
+ * n - Link for which to retrieve information
+ * lapl_id - Link access property list
*
* OUTPUTS
* N/A
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* M. Scot Breitenfeld
- * February 29, 2008
+ * February 29, 2008
* HISTORY
* N/A
* SOURCE
@@ -376,22 +376,22 @@ done:
/****if* H5Lf/h5lexists_c
* NAME
- * h5lexists_c
+ * h5lexists_c
* PURPOSE
- * Calls H5Lexists
+ * Calls H5Lexists
* INPUTS
*
- * loc_id - Identifier of the file or group to query.
- * name - Link name to check
- * lapl_id - Link access property list identifier.
+ * loc_id - Identifier of the file or group to query.
+ * name - Link name to check
+ * lapl_id - Link access property list identifier.
* OUTPUTS
*
- * link_exists_c - returns a positive value, for TRUE, or 0 (zero), for FALSE.
+ * link_exists_c - returns a positive value, for TRUE, or 0 (zero), for FALSE.
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* M. Scot Breitenfeld
- * February 29, 2008
+ * February 29, 2008
* HISTORY
*
* SOURCE
@@ -423,34 +423,34 @@ done:
/****if* H5Lf/h5lget_info_c
* NAME
- * h5lget_info_c
+ * h5lget_info_c
* PURPOSE
- * Call H5Lget_info
+ * Call H5Lget_info
* INPUTS
*
* link_loc_id - File or group identifier.
- * link_name - Name of the link for which information is being sought
- * link_namelen - Name length
- * lapl_id - Link access property list
+ * link_name - Name of the link for which information is being sought
+ * link_namelen - Name length
+ * lapl_id - Link access property list
* OUTPUTS
*
*
- * cset - indicates the character set used for link’s name.
- * corder - specifies the link’s creation order position.
- * corder_valid - indicates whether the value in corder is valid.
- * link_type - specifies the link class:
+ * cset - indicates the character set used for link’s name.
+ * corder - specifies the link’s creation order position.
+ * corder_valid - indicates whether the value in corder is valid.
+ * link_type - specifies the link class:
* H5L_LINK_HARD_F - Hard link
* H5L_LINK_SOFT_F - Soft link
* H5L_LINK_EXTERNAL_F - External link
* H5L_LINK_ERROR_F - Error
- * address - If the link is a hard link, address specifies the file address that the link points to
- * val_size - If the link is a symbolic link, val_size will be the length of the link value
+ * address - If the link is a hard link, address specifies the file address that the link points to
+ * val_size - If the link is a symbolic link, val_size will be the length of the link value
*
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* M. Scot Breitenfeld
- * January, 2008
+ * January, 2008
* HISTORY
* N/A
* SOURCE
@@ -496,30 +496,30 @@ done:
/****if* H5Lf/h5lget_info_by_idx_c
* NAME
- * h5lget_info_by_idx_c
+ * h5lget_info_by_idx_c
* PURPOSE
- * Call H5Lget_info_by_idx
+ * Call H5Lget_info_by_idx
* INPUTS
*
* loc_id - File or group identifier specifying location of subject group
- * group_name - Name of subject group
- *group_namelen - Name length
+ * group_name - Name of subject group
+ * group_namelen - Name length
* index_field - Index or field which determines the order
- * order - Order within field or index
- * n - Link for which to retrieve information
- * lapl_id - Link access property list
+ * order - Order within field or index
+ * n - Link for which to retrieve information
+ * lapl_id - Link access property list
* OUTPUTS
*
- * corder_valid - Indicates whether the the creation order data is valid for this attribute
- * corder - Is a positive integer containing the creation order of the attribute
- * cset - Indicates the character set used for the attribute’s name
- * data_size - indicates the size, in the number of characters, of the attribute
+ * corder_valid - Indicates whether the the creation order data is valid for this attribute
+ * corder - Is a positive integer containing the creation order of the attribute
+ * cset - Indicates the character set used for the attribute’s name
+ * data_size - indicates the size, in the number of characters, of the attribute
*
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* M. Scot Breitenfeld
- * January, 2008
+ * January, 2008
* HISTORY
* N/A
* SOURCE
@@ -570,7 +570,7 @@ done:
* NAME
* H5Lis_registered_c
* PURPOSE
- * Call H5Lis_registered
+ * Call H5Lis_registered
* INPUTS
*
* link_cls_id - User-defined link class identifier
@@ -578,11 +578,11 @@ done:
* NONE
*
* RETURNS
- * Returns a positive value if the link class has been registered
- * and zero if it is unregistered. Otherwise returns a negative value
+ * Returns a positive value if the link class has been registered
+ * and zero if it is unregistered. Otherwise returns a negative value
* AUTHOR
* M. Scot Breitenfeld
- * March 3, 2008
+ * March 3, 2008
* HISTORY
* N/A
* SOURCE
@@ -621,25 +621,25 @@ h5lis_registered_c(int_f *link_cls_id)
/****if* H5Lf/h5lmove_c
* NAME
- * h5lmove_c
+ * h5lmove_c
* PURPOSE
- * Call H5Lmove
+ * Call H5Lmove
* INPUTS
*
- * src_loc_id - Original file or group identifier.
- * src_name - Original link name.
- * src_namelen - name length
- * dest_loc_id - Destination file or group identifier.
- * dest_name - NEW link name.
- * dest_namelen - name length
+ * src_loc_id - Original file or group identifier.
+ * src_name - Original link name.
+ * src_namelen - name length
+ * dest_loc_id - Destination file or group identifier.
+ * dest_name - NEW link name.
+ * dest_namelen - name length
* OUTPUTS
*
*
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* M. Scot Breitenfeld
- * March 3, 2008
+ * March 3, 2008
* SOURCE
*/
int_f
@@ -682,17 +682,17 @@ done:
* Call H5Lget_name_by_idx
* INPUTS
*
- * loc_id - File or group identifier specifying location of subject group
- * group_name - Name of subject group
- * index_field - Index or field which determines the order
- * order - Order within field or index
- * n - Link for which to retrieve information
- * size - Maximum number of characters of link value to be returned.
- * lapl_id - Link access property list
+ * loc_id - File or group identifier specifying location of subject group
+ * group_name - Name of subject group
+ * index_field - Index or field which determines the order
+ * order - Order within field or index
+ * n - Link for which to retrieve information
+ * size - Maximum number of characters of link value to be returned.
+ * lapl_id - Link access property list
* OUTPUTS
*
- * name - Buffer in which link value is returned
- * size - The size of the link name on success
+ * name - Buffer in which link value is returned
+ * size - The size of the link name on success
* RETURNS
* 0 on success, -1 on failure
* AUTHOR
@@ -916,25 +916,25 @@ done:
/****if* H5Lf/h5lget_val_c
* NAME
- * h5lget_val_c
+ * h5lget_val_c
* PURPOSE
- * Call H5Lget_val
+ * Call H5Lget_val
* INPUTS
*
- * link_loc_id - File or group identifier.
- * link_name - Link whose value is to be returned.
- * link_name_len - length of link_name
- * size - Maximum number of characters of link value to be returned.
- * lapl_id - List access property list identifier
+ * link_loc_id - File or group identifier.
+ * link_name - Link whose value is to be returned.
+ * link_name_len - length of link_name
+ * size - Maximum number of characters of link value to be returned.
+ * lapl_id - List access property list identifier
* OUTPUTS
*
- * linkval_buff - The buffer to hold the returned link value.
+ * linkval_buff - The buffer to hold the returned link value.
*
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* M. Scot Breitenfeld
- * April 11, 2008
+ * April 11, 2008
* SOURCE
*/
int_f
@@ -971,16 +971,16 @@ done:
* Calls H5Literate
* INPUTS
*
- * group_id - Identifier specifying subject group
- * index_type - Type of index which determines the order
- * order - Order within index
- * idx - Iteration position at which to start
- * op - Callback function passing data regarding the link to the calling application
- * op_data - User-defined pointer to data required by the application for its processing of the link
+ * group_id - Identifier specifying subject group
+ * index_type - Type of index which determines the order
+ * order - Order within index
+ * idx - Iteration position at which to start
+ * op - Callback function passing data regarding the link to the calling application
+ * op_data - User-defined pointer to data required by the application for its processing of the link
*
* OUTPUTS
*
- * idx - Position at which an interrupted iteration may be restarted
+ * idx - Position at which an interrupted iteration may be restarted
*
* RETURNS
* >0 on success, 0< on failure
@@ -1018,19 +1018,19 @@ h5literate_c(hid_t_f *group_id, int_f *index_type, int_f *order, hsize_t_f *idx,
* Call H5Literate_by_name
* INPUTS
*
- * loc_id - Identifier specifying subject group
- * name - Name of subject group
- * namelen - Name length
- * index_type - Type of index which determines the order
- * order - Order within index
- * idx - Iteration position at which to start
- * op - Callback function passing data regarding the link to the calling application
- * op_data - User-defined pointer to data required by the application for its processing of the link
- * lapl_id - List access property list identifier
+ * loc_id - Identifier specifying subject group
+ * name - Name of subject group
+ * namelen - Name length
+ * index_type - Type of index which determines the order
+ * order - Order within index
+ * idx - Iteration position at which to start
+ * op - Callback function passing data regarding the link to the calling application
+ * op_data - User-defined pointer to data required by the application for its processing of the link
+ * lapl_id - List access property list identifier
*
* OUTPUTS
*
- * idx - Position at which an interrupted iteration may be restarted
+ * idx - Position at which an interrupted iteration may be restarted
*
* RETURNS
* >0 on success, 0< on failure