H5Lget_info() documentation error?

The documentation of H5Lget_info()

    http://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-GetInfo

    herr_t H5Lget_info( hid_t link_loc_id, const char *link_name, H5L_info_t *link_buff, hid_t lapl_id )

says:

"In the above struct, type specifies the link class. Valid values include the following:"
        H5L_LINK_HARD Hard link
        H5L_LINK_SOFT Soft link
        H5L_LINK_EXTERNAL External link
        H5L_LINK_ERROR Error

But those symbols don't exist in the HDF5 headers:

  grep LINK_HARD *.h
H5Dprivate.h:#define H5D_XFER_COLL_CHUNK_LINK_HARD_NAME "coll_chunk_link_hard"
H5Gpublic.h:#define H5G_LINK_HARD H5L_TYPE_HARD

It seems they should be "H5G_LINK_HARD" instead of "H5L_LINK_HARD", or rather

    H5L_TYPE_ERROR
    H5L_TYPE_HARD
    H5L_TYPE_SOFT
    H5L_TYPE_EXTERNAL

since these enums exist, in contrast to the documented ones.

(using SVN version of HDF5 1.8)

  Werner

···

--
___________________________________________________________________________
Dr. Werner Benger Visualization Research
Laboratory for Creative Arts and Technology (LCAT)
Center for Computation & Technology at Louisiana State University (CCT/LSU)
211 Johnston Hall, Baton Rouge, Louisiana 70803
Tel.: +1 225 578 4809 Fax.: +1 225 578-5362

Hi Werner,

Thank you for reporting the bug. It was already fixed in SVN some time ago, but we failed to post the fixed version. Will do.

Elena

···

On Apr 10, 2010, at 11:01 AM, Werner Benger wrote:

The documentation of H5Lget_info()

  http://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-GetInfo

  herr_t H5Lget_info( hid_t link_loc_id, const char *link_name, H5L_info_t *link_buff, hid_t lapl_id )

says:

"In the above struct, type specifies the link class. Valid values include the following:"
      H5L_LINK_HARD Hard link
      H5L_LINK_SOFT Soft link
      H5L_LINK_EXTERNAL External link
      H5L_LINK_ERROR Error

But those symbols don't exist in the HDF5 headers:

grep LINK_HARD *.h
H5Dprivate.h:#define H5D_XFER_COLL_CHUNK_LINK_HARD_NAME "coll_chunk_link_hard"
H5Gpublic.h:#define H5G_LINK_HARD H5L_TYPE_HARD

It seems they should be "H5G_LINK_HARD" instead of "H5L_LINK_HARD", or rather

  H5L_TYPE_ERROR
  H5L_TYPE_HARD
  H5L_TYPE_SOFT
  H5L_TYPE_EXTERNAL

since these enums exist, in contrast to the documented ones.

(using SVN version of HDF5 1.8)

  Werner

--
___________________________________________________________________________
Dr. Werner Benger Visualization Research
Laboratory for Creative Arts and Technology (LCAT)
Center for Computation & Technology at Louisiana State University (CCT/LSU)
211 Johnston Hall, Baton Rouge, Louisiana 70803
Tel.: +1 225 578 4809 Fax.: +1 225 578-5362

_______________________________________________
Hdf-forum is for HDF software users discussion.
Hdf-forum@hdfgroup.org
http://mail.hdfgroup.org/mailman/listinfo/hdf-forum_hdfgroup.org