Field_Auto_Increment - DataDictionary

Returns a column's auto-increment table and column number

Type: Function

Return Data Type: Integer

Parameters: Integer iField Integer ByRef iSysField

ParameterDescription
iFieldNumber of the column in the table
iSysField (ByRef)Returns the column number of the system table used as the auto-increment source (by reference)


Return Value

Returns the integer table number of the system table used as the auto-increment source. Note that the table's column number is returned in a ByRef parameter.


Syntax
Function Field_Auto_Increment Integer iField Integer ByRef iSysField Returns Integer

Call: Get Field_Auto_Increment iField (&iSysField) to IntegerVariable


Description

The function Field_Auto_Increment provides a mechanism for returning auto-increment information for a column. The column's auto-increment source table number is returned in the return integer and the column's auto-increment source table column is returned by reference.

Integer iAutoColumn iAutoTable
Get Field_Auto_Increment Field Customer.Customer_Number (&iAutoColumn) to iAutoTable

Integer iAutoColumn iAutoTable iColumn
Get Field_Auto_Increment iColumn (&iAutoColumn) to iAutoTable

Note that this method is a function. A write only procedure also named Field_Auto_Increment is used to define a column's auto-increment table and column.

Set Field_Auto_Increment Field Customer.Customer_Number to File_Field Ordsys.Customer_Number

As there will be little need for ever using this function, there is no "File_Field" version of this function.