Sequence Numbers Component

Fnd_Hook_SqNo_SetIDField

Fnd_Hook_SqNo_SetIDField (->table) -> Pointer

Legacy manual page 230

Parameters

ParameterTypeDescription
tablePointerPointer to the table
Function resultPointerPointer to the table's key field

Description

Foundation's Sequence Number routines assume the first field for every table is the table's key field. If this is not the case, you can show Foundation which field to use for the key field using this hook. The key field must be a long integer and must be indexed to work properly with the Sequence Numbers component. This function may return a nil pointer if the table does not contain an ID field.

Extracted source text
            Fnd_Hook_SqNo_SetIDField (->table) ➔ Pointer

              Parameter                  Type             Description
              table                      Pointer          Pointer to the table
              Function result            Pointer          Pointer to the table's key field

            Foundation's Sequence Number routines assume the first field for every table is the table's key field. If this
            is not the case, you can show Foundation which field to use for the key field using this hook.
            The key field must be a long integer and must be indexed to work properly with the Sequence Numbers
            component.
            This function may return a nil pointer if the table does not contain an ID field.