AX1622

GetColumnInfo function

Returns information about a table column, given the column name.

Syntax

GetColumnInfo("CodeName", "ColumnName")

Parameter Description

CodeName

Specifies the column property to return. Use one of the following values:

  • Alias: Returns the Table.Column associated with an alias name. The ColumnName parameter must be a valid alias name.

  • DataType: Returns the data type of the column, such as String(20) or Integer.

  • IsCalculated: Returns whether the column is a calculated column (True/False).

The following values only apply to product systems, and are configured by product development and implementation consultants:

  • IsUnused: Returns whether the column is flagged as unused (True/False).

  • IsVariable: Returns whether the column is flagged as variable (True/False).

  • PreferredName: Returns the preferred name of the given Table.Column.

ColumnName

The name of the column for which you want to return information. Use Table.Column syntax, such as "GL2021.M1". Multi-level column syntax can be used.

When using the Alias code, the column name should be the alias name by itself, such as "CYB1".

All non-numeric entries must be placed in double quotation marks, unless you are using cell references to reference the text held in another cell.

Remarks

GetColumnInfo is a non-volatile function.

Examples

=GetColumnInfo("DataType","Dept.Dept")

This example returns the data type of Dept.Dept. For example: Integer.

=GetColumnInfo("Alias","CYA1")

This example returns the column name associated with the CYA1 alias. For example: GL2021.M1.

=GetColumnInfo("IsCalculated","GL2021.TOT")

In this example, the specified column is a calculated column, so the function returns True.

See also