Skip Navigation Links.

H5T..::..getMemberIndex Method

Retrieves the index of a compound or enumeration datatype member. http://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetMemberIndex

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

Syntax

Visual Basic
Public Shared Function getMemberIndex ( _
	typeId As H5DataTypeId, _
	fieldName As String _
) As Integer
C#
public static int getMemberIndex(
	H5DataTypeId typeId,
	string fieldName
)
Visual C++
public:
static int getMemberIndex(
	H5DataTypeId^ typeId, 
	String^ fieldName
)
JavaScript
HDF5DotNet.H5T.getMemberIndex = function(typeId, fieldName);

Parameters

typeId
Type: HDF5DotNet..::..H5DataTypeId
Identifier of datatype to query.
fieldName
Type: String

Return Value

Returns a valid field or member index if successful.

Remarks

H5Tget_member_index retrieves the index of a field of a compound datatype or an element of an enumeration datatype.

The name of the target field or element is specified in fieldname.

Fields are stored in no particular order with index values of 0 through N-1, where N is the value returned by H5T.getNMembers.

Exceptions

ExceptionCondition
HDF5DotNet..::..H5TgetMemberIndexException throws H5TgetMemberIndexException on failure.

See Also