tAPITableNameInfo - The Database Update Framework

See Also: Declaring Variables, Struct 

Purpose

tAPITableNameInfo is a structured type used for some members of the cDbUpdateFunctionLibrary class. The struct can be passed as a parameter to the e.g. ApiTableUpdate function to make it easier (less code writing) to create a new table.

Type Declaration

Struct tAPITableNameInfo

    Integer iTableNumber

    String  sRootName

    String  sLogicalName

    String  sDisplayName

    String  sDriverID

    Boolean bIsAlias

    Boolean bIsSQL

    Boolean bIsSystemFile

    Boolean bShouldChange

    Boolean bCancel

    Boolean bError

End_Struct

Struct Members

iTableNumber

The Filelist.cfg table number (file slot number).

sRootName

The Filelist.cfg root name.

sLogicalName

The Filelist.cfg logical name.

sDisplayName

The Filelist.cfg display name.

sDriverID

The driver ID; MSSQLDRV_ID, DB2_DRV_ID, ODBC_DRV_ID etc.

bIsAlias

Boolean parameter. Pass a True if this is an Alias table in Filelist.cfg

bIsSystemFile

Boolean parameter. Pass a True if this is a system table (can only have 1 record).

bShouldChange

Boolean parameter. Internal usage.

bCancel

Boolean parameter. Internal usage.

bError

Boolean parameter. Internal usage.

Syntax

Use cDbUpdateFunctionLibrary.pkg

:

tAPITableNameInfo {variableName}

Declaring variables

To declare tAPITableNameInfo variables, use the name of the type (tAPITableNameInfo) followed by the variable name.

tAPITableNameInfo[] aAPITableNameInfo

See struct variables for more details of instantiating struct types.