Skip Navigation Links.

H5L..::..getNameByIndex Method (H5FileOrGroupId, , H5IndexType, H5IterationOrder, , H5PropertyListId)

Retrieves name of the nth link in a group, according to the order within a specified field or index. http://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-GetNameByIdx

Namespace:  HDF5DotNet
Assembly:  HDF5DotNet (in HDF5DotNet.dll)

Syntax

Visual Basic
Public Shared Function getNameByIndex ( _
	fileOrGroupId As H5FileOrGroupId, _
	groupName As String, _
	indexType As H5IndexType, _
	iterationOrder As H5IterationOrder, _
	position As Long, _
	linkAccessPropertyList As H5PropertyListId _
) As String
C#
public static string getNameByIndex(
	H5FileOrGroupId fileOrGroupId,
	string groupName,
	H5IndexType indexType,
	H5IterationOrder iterationOrder,
	long position,
	H5PropertyListId linkAccessPropertyList
)
Visual C++
public:
static String^ getNameByIndex(
	H5FileOrGroupId^ fileOrGroupId, 
	String^ groupName, 
	H5IndexType indexType, 
	H5IterationOrder iterationOrder, 
	long long position, 
	H5PropertyListId^ linkAccessPropertyList
)
JavaScript
HDF5DotNet.H5L.getNameByIndex = function(fileOrGroupId, groupName, indexType, iterationOrder, position, linkAccessPropertyList);

Parameters

fileOrGroupId
Type: HDF5DotNet..::..H5FileOrGroupId
IN: File or group identifier specifying location of subject group
groupName
Type: String
IN: Name of subject group
indexType
Type: HDF5DotNet..::..H5IndexType
IN: Index or field which determines the order
iterationOrder
Type: HDF5DotNet..::..H5IterationOrder
IN: Order within field or index
position
Type: Int64
IN: Link for which to retrieve information
linkAccessPropertyList
Type: HDF5DotNet..::..H5PropertyListId
IN: Link access property list

Return Value

A string containing the requested name.

Exceptions

ExceptionCondition
HDF5DotNet..::..H5LgetNameByIndexException throws H5LgetNameByIndexException on failure.

See Also