summaryrefslogtreecommitdiffstats
path: root/fortran
diff options
context:
space:
mode:
authorScot Breitenfeld <brtnfld@hdfgroup.org>2009-09-17 17:20:51 (GMT)
committerScot Breitenfeld <brtnfld@hdfgroup.org>2009-09-17 17:20:51 (GMT)
commitb7b90996277ee7d74bdc337f17ccb61e7e8727a1 (patch)
treefd15f5101a4b852c45839753a9f4b5bce12cc806 /fortran
parent1dad72e54c6ef75b11151d7288d500900cfe3462 (diff)
downloadhdf5-b7b90996277ee7d74bdc337f17ccb61e7e8727a1.zip
hdf5-b7b90996277ee7d74bdc337f17ccb61e7e8727a1.tar.gz
hdf5-b7b90996277ee7d74bdc337f17ccb61e7e8727a1.tar.bz2
[svn-r17487] Cleaned-up comments in h5lget_info_by_idx
Diffstat (limited to 'fortran')
-rw-r--r--fortran/src/H5Lff.f9015
1 files changed, 10 insertions, 5 deletions
diff --git a/fortran/src/H5Lff.f90 b/fortran/src/H5Lff.f90
index 0023e14..2f359e9 100644
--- a/fortran/src/H5Lff.f90
+++ b/fortran/src/H5Lff.f90
@@ -581,7 +581,8 @@ CONTAINS
! 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
+! val_size - If the link is a symbolic link, val_size will be the length of the link value, e.g.,
+! the length of the name of the pointed-to object with a null terminator.
! hdferr - error code
! Success: 0
! Failure: -1
@@ -613,7 +614,8 @@ CONTAINS
! H5L_LINK_EXTERNAL_F - External link
! H5L_LINK_ERROR _F - Error
INTEGER(HADDR_T), INTENT(OUT) :: address ! If the link is a hard link, address specifies the file address that the link points to
- INTEGER(SIZE_T), INTENT(OUT) :: val_size ! If the link is a symbolic link, val_size will be the length of the link value
+ INTEGER(SIZE_T), INTENT(OUT) :: val_size ! If the link is a symbolic link, val_size will be the length of the link value, e.g.,
+ ! the length of the name of the pointed-to object with a null terminator.
INTEGER, INTENT(OUT) :: hdferr ! Error code:
! 0 on success and -1 on failure
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id ! Link access property list
@@ -676,8 +678,10 @@ CONTAINS
! Outputs: NOTE: In C these are defined as a structure: H5L_info_t
! corder_valid - indicates whether 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
+! cset - indicates the character set used for the attribute’s name
+! 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, e.g.,
+! the length of the name of the pointed-to object with a null terminator.
! hdferr - error code
! Success: 0
! Failure: -1
@@ -715,7 +719,8 @@ CONTAINS
INTEGER, INTENT(OUT) :: corder ! Is a positive integer containing the creation order of the attribute
INTEGER, INTENT(OUT) :: cset ! Indicates the character set used for the attribute’s name
INTEGER(HADDR_T), INTENT(OUT) :: address ! If the link is a hard link, address specifies the file address that the link points to
- INTEGER(SIZE_T), INTENT(OUT) :: val_size ! Indicates the size, in the number of characters, of the attribute for symbolic link
+ INTEGER(SIZE_T), INTENT(OUT) :: val_size ! If the link is a symbolic link, val_size will be the length of the link value, e.g.,
+ ! the length of the name of the pointed-to object with a null terminator.
INTEGER, INTENT(OUT) :: hdferr ! Error code:
! 0 on success and -1 on failure
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id ! Link access property list