H5L.get_name_by_idx

Information about link specified by index

Syntax

name = H5L.get_name_by_idx(loc_id,group_name,idx_type,order,n,lapl_id)

Description

name = H5L.get_name_by_idx(loc_id,group_name,idx_type,order,n,lapl_id) retrieves information about a link at index n, present in group group_name, at location loc_id. The lapl_id input specifies the link access property list for querying the group.

idx_type is the type of index and valid values include the following.

'H5_INDEX_NAME'Alpha-numeric index on name
'H5_INDEX_CRT_ORDER'Index on creation order

order specifies the index traversal order. Valid values include the following.

'H5_ITER_INC'Iteration from beginning to end
'H5_ITER_DEC'Iteration from end to beginning
'H5_ITER_NATIVE'Iteration in the fastest available order

Examples

fid = H5F.open('example.h5');
idx_type = 'H5_INDEX_NAME';
order = 'H5_ITER_DEC';
lapl_id = 'H5P_DEFAULT';
name = H5L.get_name_by_idx(fid,'g3',idx_type,order,0,lapl_id);
H5F.close(fid);
Was this topic helpful?