Skip Navigation Links.

H5A..::..getNameByIndex Method (H5ObjectWithAttributes, , H5IndexType, H5IterationOrder, , H5PropertyListId)

Gets an attribute name, by attribute index position http://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-GetNameByIdx

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

Syntax

Visual Basic
Public Shared Function getNameByIndex ( _
	objectId As H5ObjectWithAttributes, _
	objName As String, _
	indexType As H5IndexType, _
	iterationOrder As H5IterationOrder, _
	position As Long, _
	propertyList As H5PropertyListId _
) As String
C#
public static string getNameByIndex(
	H5ObjectWithAttributes objectId,
	string objName,
	H5IndexType indexType,
	H5IterationOrder iterationOrder,
	long position,
	H5PropertyListId propertyList
)
Visual C++
public:
static String^ getNameByIndex(
	H5ObjectWithAttributes^ objectId, 
	String^ objName, 
	H5IndexType indexType, 
	H5IterationOrder iterationOrder, 
	long long position, 
	H5PropertyListId^ propertyList
)
JavaScript
HDF5DotNet.H5A.getNameByIndex = function(objectId, objName, indexType, iterationOrder, position, propertyList);

Parameters

objectId
Type: HDF5DotNet..::..H5ObjectWithAttributes
IN: Location of object to which attribute is attached
objName
Type: String
IN: Name of object to which attribute is attached, relative to location
indexType
Type: HDF5DotNet..::..H5IndexType
IN: Type of index
iterationOrder
Type: HDF5DotNet..::..H5IterationOrder
IN: Index traversal order
position
Type: Int64
IN: Attribute's position in index
propertyList
Type: HDF5DotNet..::..H5PropertyListId
IN: Link access property list

Return Value

A string containing the attribute name.

Exceptions

ExceptionCondition
HDF5DotNet..::..H5AgetNameByIndexException throws H5AgetNameByIndexException on failure.

See Also