Renames a Table. Can be both in filelist and on disk depending on the parameters passed.
Type: Function
Parameters: Handle hTable String sDriverID String sRootName String sDisplayName String sLogicalName
|
Parameter |
Description |
|
hTable |
A file handle to the table name. Same as the Filelist.cfg slot number. |
|
sRoot |
The root name of the table |
|
sDisplay |
The display name of the table |
|
sTableName |
The table name or logical name of the table |
Syntax
Function ApiTableRename Integer hTable String sRootName String sDisplayName String sTableName
|
Call: |
Get ApiTableCreate SysTable.File_Number "SysTable2" "SysTable2" "SysTable2" to bOK |
Description
Use it to rename a table. The file handle is the same as the file number in Filelist.cfg.
Note: If you want to remove a table use the ApiTableRemove function.
Example
Procedure OnUpdate
Boolean bOK
Get ApiTableRename MyTable.File_Number "NewMyTable" "NewMyTable" "NewMyTable" to bOK
End_Procedure