Skip Navigation Links.

H5O..::..getInfoByIndex Method (H5LocId, , H5IndexType, H5IterationOrder, , H5PropertyListId)

Retrieves the metadata for an object, identifying the object by an index position. http://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-GetInfoByIdx

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

Syntax

Visual Basic
Public Shared Function getInfoByIndex ( _
	locId As H5LocId, _
	groupName As String, _
	index As H5IndexType, _
	iterationOrder As H5IterationOrder, _
	position As Long, _
	linkAccessPropertyListId As H5PropertyListId _
) As H5ObjectInfo
C#
public static H5ObjectInfo getInfoByIndex(
	H5LocId locId,
	string groupName,
	H5IndexType index,
	H5IterationOrder iterationOrder,
	long position,
	H5PropertyListId linkAccessPropertyListId
)
Visual C++
public:
static H5ObjectInfo^ getInfoByIndex(
	H5LocId^ locId, 
	String^ groupName, 
	H5IndexType index, 
	H5IterationOrder iterationOrder, 
	long long position, 
	H5PropertyListId^ linkAccessPropertyListId
)
JavaScript
HDF5DotNet.H5O.getInfoByIndex = function(locId, groupName, index, iterationOrder, position, linkAccessPropertyListId);

Parameters

locId
Type: HDF5DotNet..::..H5LocId
IN: File or group identifier specifying location of group in which object is located
groupName
Type: String
IN: Name of group in which object is located
index
Type: HDF5DotNet..::..H5IndexType
IN: Index or field that determines the order
iterationOrder
Type: HDF5DotNet..::..H5IterationOrder
IN: Order within field or index
position
Type: Int64
IN: Object for which information is to be returned
linkAccessPropertyListId
Type: HDF5DotNet..::..H5PropertyListId
OUT: Buffer in which to return object information

Return Value

H5ObjectInfo

Exceptions

ExceptionCondition
HDF5DotNet..::..H5OgetInfoByIndexException throws H5OgetInfoByIndexException on failure.

See Also