AX1639

GetTableInfo function

Returns information about a table, given the table name.

NOTE: You can use a data lookup to return the same information as a GetTableInfo function. Whenever possible, it is recommended to use data lookups over Axiom functions for faster performance.

Syntax

GetTableInfo("CodeName", "TableName")

Parameter Description

CodeName

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

  • Classification: Returns the table classification for the table, such as Data or Reference.

  • Exists: Returns whether the table exists in the system (True/False).

  • IndexScheme: Returns the index scheme for the table, such as Default or Large Table.

  • IsReadOnly: Returns whether the table is read-only (True/False).

  • TableType: Returns the table type that the table is assigned to (blank if the table is not assigned to a table type).

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

  • CustomerTableName: Returns the real name of the table.

  • IsUnused: Returns whether the table is flagged as unused (True/False). Note that currently this flag does not affect the table; it is reserved for future functionality.

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

  • PreferredName: Returns the preferred name of the table.

TableName

The name of the table for which you want to return information.

NOTE: If the table does not exist in the current system, the only code that will return a response is Exists. Otherwise, using an invalid table name will return an error.

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

GetTableInfo is a non-volatile function.

Examples

=GetTableInfo("Classification","Dept")

This example returns the table classification of Dept. For example: Reference.

=GetTableInfo("TableType","GL2019")

This example returns the table type that the table is assigned to. For example: GLData.

See also