astColumnName

Get the name of the column at a given index within the Table

Description:

This function returns a string holding the name of the column with the given index within the Table.

This function is intended primarily as a means of iterating round all the columns in a Table. For this purpose, the number of columns in the Table is given by the Ncolumn attribute of the Table. This function could then be called in a loop, with the index value going from zero to one less than Ncolumn.

Note, the index associated with a column decreases monotonically with the age of the column: the oldest Column in the Table will have index one, and the Column added most recently to the Table will have the largest index.

Synopsis

const char astColumnName( AstTable this, int index )

Parameters:

this
Pointer to the Table.
index
The index into the list of columns. The first column has index one, and the last has index " Ncolumn" .

Returned Value

astColumnName()
A pointer to a null-terminated string containing the upper case column name.

Notes: