File Geodatabase API
FileGDBAPI::FieldInfo Class Reference

A utility class for providing field information. More...

Public Member Functions

fgdbError GetFieldCount (int &fieldCount) const
 The number of fields. More...
 
fgdbError GetFieldName (int fieldNumber, std::wstring &fieldName) const
 The name of the field. More...
 
fgdbError GetFieldType (int fieldNumber, FieldType &fieldType) const
 The data type of the field. More...
 
fgdbError GetFieldLength (int fieldNumber, int &fieldLength) const
 The length of the field. More...
 
fgdbError GetFieldIsNullable (int fieldNumber, bool &isNullable) const
 The nullability of the field. More...
 
Constructors and destructors
 FieldInfo ()
 The class constructor.
 
 ~FieldInfo ()
 The class destructor.
 

Detailed Description

A utility class for providing field information.

Member Function Documentation

fgdbError FileGDBAPI::FieldInfo::GetFieldCount ( int &  fieldCount) const

The number of fields.

Parameters
[out]fieldCountThe number of fields.
Returns
Error code indicating whether the method finished successfully.
fgdbError FileGDBAPI::FieldInfo::GetFieldName ( int  fieldNumber,
std::wstring &  fieldName 
) const

The name of the field.

Parameters
[in]fieldNumberThe number of field.
[out]fieldNameThe name of the field.
Returns
Error code indicating whether the method finished successfully.
fgdbError FileGDBAPI::FieldInfo::GetFieldType ( int  fieldNumber,
FieldType &  fieldType 
) const

The data type of the field.

Parameters
[in]fieldNumberThe number of field.
[out]fieldTypeThe data type of the field.
Returns
Error code indicating whether the method finished successfully.
fgdbError FileGDBAPI::FieldInfo::GetFieldLength ( int  fieldNumber,
int &  fieldLength 
) const

The length of the field.

Parameters
[in]fieldNumberThe number of field.
[out]fieldLengthThe length of the field.
Returns
Error code indicating whether the method finished successfully.
fgdbError FileGDBAPI::FieldInfo::GetFieldIsNullable ( int  fieldNumber,
bool &  isNullable 
) const

The nullability of the field.

Parameters
[in]fieldNumberThe number of field.
[out]isNullableThe nullability of the field.
Returns
Error code indicating whether the method finished successfully.