Returns information about a link


<pre><code class="language-c">herr_t H5Lget_info ( hid_t loc_id, const char *name, H5L_info_t *linfo /*out*/, hid_t lapl_id )</code></pre>

<pre><code class="language-fortran"><pre><code class="language-fortran">SUBROUTINE h5lget_info_f(link_loc_id, link_name, &
     cset, corder, f_corder_valid, link_type, address, val_size, &
     hdferr, lapl_id)
  INTEGER(HID_T), INTENT(IN) :: link_loc_id 
                        ! File or group identifier.
  CHARACTER(LEN=*), INTENT(IN) :: link_name 
                        ! Name of the link for which information is being sought.
                        ! Indicates the character set used for the link’s name. 
  INTEGER, INTENT(OUT) :: corder 
                        ! Specifies the link’s creation order position.
  LOGICAL, INTENT(OUT) :: f_corder_valid 
                        ! Indicates whether the value in corder is valid.
  INTEGER, INTENT(OUT) :: link_type 
                        ! Specifies the link class:
                        !  H5L_TYPE_HARD_F      - Hard link
                        !  H5L_TYPE_SOFT_F      - Soft link
                        !  H5L_TYPE_EXTERNAL_F  - External link
                        !  H5L_TYPE_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, i.e. 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
                        ! Link access property list
END SUBROUTINE h5lget_info_f</code></pre></code></pre>

<pre><code class="language-cpp">Replace this text with the C++ Function Signature</code></pre>

<pre><code class="language-java">Replace this text with the JAVA Function Signature</code></pre>


H5L_GET_INFO is a macro that is mapped to either of:

Such macros are provided to facilitate application compatibility. Their use and mappings are fully described in API Compatibility Macros in HDF5.

If the library and/or application is compiled for Release 1.12 emulation, H5L_GET_INFO will be mapped to H5L_GET_INFO2 and H5L_GET_INFO1 is deprecated. With earlier versions, H5L_GET_INFO is the same as H5L_GET_INFO1.

Specific compile-time compatibility flags and the resulting mappings are as follows:

No compatibility flag

H5L_GET_INFO2 (using 1.12 source)

H5L_GET_INFO1 (using 1.10 or 1.8 source)

Emulate Release 1.12H5L_GET_INFO2
Emulate Release 1.8 or 1.10 interface H5L_GET_INFO1


The function H5L_GET_INFO was renamed to H5L_GET_INFO1 and deprecated in this release.
The macro H5L_GET_INFO and the function H5L_GET_INFO2 were introduced in this release.