This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English version of the page.

Note: This page has been translated by MathWorks. Click here to see
To view all translated materials including this page, select Country from the country navigator on the bottom of this page.


Information about link specified by index


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


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

name = H5L.get_name_by_idx(loc_id,group_name,idx_type,order,n,lapl_id,'TextEncoding',encoding) additionally specifies the text encoding to use to interpret the link name. Specify encoding as 'system'(default) or 'UTF-8'.

  • 'system' — Use the system default encoding to interpret the link name.

  • 'UTF-8' — Use UTF-8 encoding to interpret the link name.


fid ='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);
Was this topic helpful?