Skip Navigation Links.

H5A..::..iterate Method (H5ObjectWithAttributes, H5IndexType, H5IterationOrder, %, H5AIterateCallback, , H5PropertyListId)

Calls user-defined function for each attribute on an object. http://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Iterate

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

Syntax

Visual Basic
Public Shared Function iterate ( _
	objectId As H5ObjectWithAttributes, _
	indexType As H5IndexType, _
	iterationOrder As H5IterationOrder, _
	ByRef position As Long, _
	iterateCallback As H5AIterateCallback, _
	opData As Object, _
	linkAccessPropertyListId As H5PropertyListId _
) As H5IterationResult
C#
public static H5IterationResult iterate(
	H5ObjectWithAttributes objectId,
	H5IndexType indexType,
	H5IterationOrder iterationOrder,
	ref long position,
	H5AIterateCallback iterateCallback,
	Object opData,
	H5PropertyListId linkAccessPropertyListId
)
Visual C++
public:
static H5IterationResult iterate(
	H5ObjectWithAttributes^ objectId, 
	H5IndexType indexType, 
	H5IterationOrder iterationOrder, 
	long long% position, 
	H5AIterateCallback^ iterateCallback, 
	Object^ opData, 
	H5PropertyListId^ linkAccessPropertyListId
)
JavaScript
HDF5DotNet.H5A.iterate = function(objectId, indexType, iterationOrder, position, iterateCallback, opData, linkAccessPropertyListId);

Parameters

objectId
Type: HDF5DotNet..::..H5ObjectWithAttributes
IN: Identifier for object to which attributes are attached; may be group, dataset, or named datatype.
indexType
Type: HDF5DotNet..::..H5IndexType
IN: Type of index
iterationOrder
Type: HDF5DotNet..::..H5IterationOrder
IN: Order in which to iterate over index
position
Type: Int64%
IN/OUT: Initial and returned offset within index
iterateCallback
Type: HDF5DotNet..::..H5AIterateCallback
IN: User-defined function to pass each attribute to
opData
Type: Object
IN/OUT: User data to pass through to and to be returned by iterator operator function
linkAccessPropertyListId
Type: HDF5DotNet..::..H5PropertyListId
IN: Link access property list.

Return Value

H5IterationResult

Exceptions

ExceptionCondition
HDF5DotNet..::..H5AiterateException throws H5AiterateException on failure.

See Also