ApiColumnRename - cDbUpdateFunctionLibrary

Renames a table column.

Parameters: Handle hTable, String sCurrentColumnName, String sNewColumnName

Parameter	Description
hTable	A file handle to the table name. Same as the Filelist.cfg slot number.
sCurrentColumnName	The present column name to be changed
sNewColumnName	The new name for the column.

Syntax

Procedure ApiColumnRename Handle hTable String sCurrentColumnName String sNewColumnName

Call:

Send ApiColumnRename YourTableName.File_Number "CurrentColumnName" "NewColumnName"

Description

Use it to change a column name.

Note: If you want to add a field/column for an SQL table, use the SqlColumnRename function instead.

Example

Procedure OnUpdate

Boolean bOK

Get ApiColumnRename Order.File_Number "CurrentColumnName" "NewColumnName" to bOK

End_Procedure