Page tree

The license could not be verified: License Certificate has expired!

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Content Layer
id1195548671
Content Column
width50.00001%
id1195578110
classrm_pagetree_col mobile-hide
Content Block
id1195578111
 
Content Column
width50.00001%
id1195548673
classhdf-rm-main-column
Content Block
id1195548672

Include Content
render-without-blockstrue
page.rm-navbar
HTML Wrap
classhdf-print-only

Page Title

HTML Wrap
classhdf-rm-summary-block

Hdf rm anchor
AnchorNamesummary

Excerpt

Retrieves value of the nth link in a group, according to the order within an index

HTML Wrap
classhdf-rm-content-block

Hdf rm anchor
AnchorNameprocedure

Procedure:
HTML Wrap
classhdf-rm-section
HTML Wrap
classhdf_procedure

H5L_GET_VAL_BY_IDX(loc_id, group_name, index_type, order, n, link_val, size, lapl_id)

Hdf rm anchor
AnchorNamesignature

Signature:
HTML Wrap
classhdf-rm-section
HTML Wrap
classhdf-togglebox hdf-c

HTML Add Class
hdf-togglebutton-visible
hdf-togglebutton-visible
selector.hdf-togglebutton.hdf-c

HTML
<pre><code class="language-c">herr_t H5Lget_val_by_idx( hid_t loc_id, const char *group_name, H5_index_t index_type, H5_iter_order_t order, hsize_t n, void *link_val, size_t size, hid_t lapl_id )</code></pre>

Hdf rm anchor
AnchorNameparameters

Parameters:
HTML Wrap
classhdf-rm-section
hid_t loc_idIN: Location identifier of subject group; may be a file, group, dataset, named datatype or attribute identifier
const char *group_name    IN: Name of subject group
H5_index_t index_typeIN: Type of index; valid values include: 
    NAME     Indexed by name 
    CORDER   Indexed by creation order
H5_iter_order_t orderIN: Order within field or index; valid values include: 
    H5_ITER_INC     Iterate in increasing order 
    H5_ITER_DEC     Iterate in decreasing order 
    H5_ITER_NATIVE  Iterate in fastest order
hsize_t nIN: Link for which to retrieve information
void *link_valOUT: Pointer to buffer in which link value is returned
size_t sizeIN: Size in bytes of group_name
hid_t lapl_idIN: Link access property list

Hdf rm anchor
AnchorNamedescription

Description:
HTML Wrap
classhdf-rm-section

H5L_GET_VAL_IDX retrieves the value of the nth link in a group, according to the specified order, order, within an index, index.

  • For soft links, the value is the path name of the object pointed to.
  • For external links, this is a compound value containing file and path name information; to use this external link information, it must first be decoded with H5L_UNPACK_ELINK_VAL
  • For user-defined links, this value will be described in the definition of the user-defined link type.
  • This function will fail if called on a hard link.

loc_id specifies the location identifier of the group specified by group_name.

group_name specifies the group in which the link exists. If loc_id already specifies the group in which the link exists, group_name must be a dot (.).

The size in bytes of group_name is specified in size. If size is unknown, it can be determined via an initial H5L_GET_VAL_IDX call with size set to NULLsize will be returned with the actual size of group_name.

If the type of the link is unknown or uncertain, H5L_GET_VAL_IDX should be called only after the type has been determined via a call to H5L_GET_INFO_BY_IDX.

Hdf rm anchor
AnchorNamereturns

Returns:
HTML Wrap
classhdf-rm-section

Returns a non-negative value if successful; otherwise returns a negative value. 

Hdf rm anchor
AnchorNameexample

Example:
HTML Wrap
classhdf-rm-section

Coming Soon!

Comment (Hide)
HTML Wrap
classhdf-togglebox hdf-c

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathexamples/h5_subset.c
showLineNumberstrue
lineStart32
progLangcpp
lineEnd42
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

HTML Wrap
classhdf-togglebox hdf-fortran hdf-togglebox-hidden

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathfortran/examples/compound.f90
showLineNumberstrue
lineStart25
progLangplain
lineEnd35
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

Hdf rm anchor
AnchorNamehistory

History:
HTML Wrap
classhdf-rm-section
C
Release    Change
1.8.0Function introduced in this release.