[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Retrieves the index of a compound or enumeration datatype
member.
Syntax
| Visual Basic (Declaration) |
|---|
Public Shared Function getMemberIndex ( _ typeId As H5DataTypeId, _ fieldName As String _ ) As Integer |
| C# |
|---|
public static int getMemberIndex ( H5DataTypeId typeId, string fieldName ) |
| C++ |
|---|
public: static int getMemberIndex ( H5DataTypeId^ typeId, String^ fieldName ) |
Parameters
- typeId (H5DataTypeId)
- Identifier of datatype to query.
- fieldName (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
| Exception | Condition |
|---|---|
| HDF5DotNet.H5TgetMemberIndexException | throws H5TgetMemberIndexException on failure. |