Skip Navigation Links.

H5A..::..openByIndex Method (H5ObjectWithAttributes, , H5IndexType, H5IterationOrder, )

H5A.openByIndex opens an existing attribute that is attached to an object specified by location and name, loc_id and obj_name, respectively. If loc_id fully specifies the object to which the attribute is attached, obj_name should be '.' (a dot). http://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-OpenByIdx

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

Syntax

Visual Basic
Public Shared Function openByIndex ( _
	dataSetOrGroupOrDataTypeId As H5ObjectWithAttributes, _
	objectName As String, _
	indexType As H5IndexType, _
	traversalOrder As H5IterationOrder, _
	position As Long _
) As H5AttributeId
C#
public static H5AttributeId openByIndex(
	H5ObjectWithAttributes dataSetOrGroupOrDataTypeId,
	string objectName,
	H5IndexType indexType,
	H5IterationOrder traversalOrder,
	long position
)
Visual C++
public:
static H5AttributeId^ openByIndex(
	H5ObjectWithAttributes^ dataSetOrGroupOrDataTypeId, 
	String^ objectName, 
	H5IndexType indexType, 
	H5IterationOrder traversalOrder, 
	long long position
)
JavaScript
HDF5DotNet.H5A.openByIndex = function(dataSetOrGroupOrDataTypeId, objectName, indexType, traversalOrder, position);

Parameters

dataSetOrGroupOrDataTypeId
Type: HDF5DotNet..::..H5ObjectWithAttributes
IN: Location of object to which attribute is attached
objectName
Type: String
IN: Name of object to which attribute is attached, relative to location
indexType
Type: HDF5DotNet..::..H5IndexType
IN: Type of index
traversalOrder
Type: HDF5DotNet..::..H5IterationOrder
IN: Index traversal order
position
Type: Int64
IN: Attribute's position in index

Return Value

H5AttributeId for the requested attribute.

Exceptions

ExceptionCondition
HDF5DotNet..::..H5AopenByIndexException throws H5AopenByIndexException on failure.

See Also