FileGDBAPI::FieldInfo Class Reference

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

List of all members.

Public Member Functions
fgdbError	GetFieldCount (int &fieldCount)
	The number of fields.
fgdbError	GetFieldName (int fieldNumber, std::wstring &fieldName)
	The name of the field.
fgdbError	GetFieldType (int fieldNumber, FieldType &fieldType)
	The data type of the field.
fgdbError	GetFieldLength (int fieldNumber, int &fieldLength)
	The length of the field.
fgdbError	GetFieldIsNullable (int fieldNumber, bool &isNullable)
	The nullability of the field.
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

)

The number of fields.

Parameters:

[out]

fieldCount

The number of fields.

Returns:

Error code indicating whether the method finished successfully.

fgdbError FileGDBAPI::FieldInfo::GetFieldName	(	int	fieldNumber,
		std::wstring &	fieldName
	)

The name of the field.

Parameters:

[in]	fieldNumber	The number of field.
[out]	fieldName	The name of the field.

Returns:

Error code indicating whether the method finished successfully.

fgdbError FileGDBAPI::FieldInfo::GetFieldType	(	int	fieldNumber,
		FieldType &	fieldType
	)

The data type of the field.

Parameters:

[in]	fieldNumber	The number of field.
[out]	fieldType	The data type of the field.

Returns:

Error code indicating whether the method finished successfully.

fgdbError FileGDBAPI::FieldInfo::GetFieldLength	(	int	fieldNumber,
		int &	fieldLength
	)

The length of the field.

Parameters:

[in]	fieldNumber	The number of field.
[out]	fieldLength	The length of the field.

Returns:

Error code indicating whether the method finished successfully.

fgdbError FileGDBAPI::FieldInfo::GetFieldIsNullable	(	int	fieldNumber,
		bool &	isNullable
	)

The nullability of the field.

Parameters:

[in]	fieldNumber	The number of field.
[out]	isNullable	The nullability of the field.

Returns:

Error code indicating whether the method finished successfully.