ApiColumnRemove - cDbUpdateFunctionLibrary

Deletes a table column.


Type: Function


Parameters: Handle hTable, String sColumnName

Parameter

Description

hTable

A file handle to the table name. Same as the Filelist.cfg slot number.

sColumnName

The column name to delete/remove.


Syntax


Function ApiColumnRemove Handle hTable String sNewColumnName Returns Boolean

Call:

Get ApiColumnRemove TableName.File_Number "SomeColumnName" to bOK



Description

Use it to remove a table column.

Note: If you want to remove a field/column for an SQL database, use the SqlColumnRemove function instead.


Example


Procedure OnUpdate

    Boolean bOK

   

    Get ApiColumnRemove Order.File_Number "MyColumnName" to bOK


End_Procedure