company logo

DBFieldDef :: DBFieldDef - Constructor

Several field definition constructors for elementary data types are provided.

Implementation details

  1. Construct empty field definition
    DBFieldDef  :: DBFieldDef (  )
  2. to list
  3. Construct by field metadata
    DBFieldDef  :: DBFieldDef ( fmcb *fmcbptr )
    • fmcbptr - Pointer to field metadata
  4. to list
  5. - internal feature (not documented)
    DBFieldDef  :: DBFieldDef ( NString &fldnames, smcb *smcbptr )
    • fldnames - Property name or path
    • smcbptr - Pointer to general structure definition

      The smcb is general way to define any type of structure. It contains information for the structure and its properties. The definition does contain only descriptive information (no access information).

  6. to list
  7. Field definition by field properties
    DBFieldDef  :: DBFieldDef ( NString &fldnames, NString &typenames, int32 fldnsid, SDB_RLEV fldreflev, uint16 fldsize, uint16 fldprec, uint16 flddim, logical trans_opt, smcb *smcbptr, NString &generic_type, logical secrefr, NString &extnames, NString &irefname, DBIndex *indexptr )
    • fldnames - Property name or path
    • typenames - Type name
    • fldnsid - Namespace identification number

      The namespace identification number is an internal number, which can be calculated from a scope path.

    • fldreflev - Reference level
    • fldsize - Field size
    • fldprec - Precision for numerical values
    • flddim - Field dimension
    • trans_opt - Indicates a transient field
    • smcbptr - Pointer to general structure definition

      The smcb is general way to define any type of structure. It contains information for the structure and its properties. The definition does contain only descriptive information (no access information).

    • generic_type - - internal feature (not documented)
    • secrefr - Indicates a secondary reference
    • extnames - Extent name

      The name contains the name of the extent, only. It does not contain a namespace scope.

      Notes:

      retval checked for const &NString

    • irefname - Inverse reference field name or path

      The inverse reference field name is passed as 0-terminated string.

    • indexptr - Internal index definition

      Pointer to an internal index definition.

  8. to list
  9. - internal feature (not documented)
    DBFieldDef  :: DBFieldDef ( NString &fldnames, NString &typenames, int32 fldnsid, uint16 fldsize, uint16 fldprec )
    • fldnames - Property name or path
    • typenames - Type name
    • fldnsid - Namespace identification number

      The namespace identification number is an internal number, which can be calculated from a scope path.

    • fldsize - Field size
    • fldprec - Precision for numerical values
  10. to list
  11. Construct by property handle
    DBFieldDef  :: DBFieldDef ( ::Dictionary *dictptr, PropertyHandle &ph, smcb *smcbptr, DBIndex *indexptr, logical domopt, logical logrefr, logical secrefr, logical depopt, NString &extnames, NString &irefname )
    • dictptr - Dictionary handle

      An opened dictionary handle is passed.

    • ph - Reference to property handle
    • smcbptr - Pointer to general structure definition

      The smcb is general way to define any type of structure. It contains information for the structure and its properties. The definition does contain only descriptive information (no access information).

    • indexptr - Internal index definition

      Pointer to an internal index definition.

    • domopt - Dominant option
    • logrefr - Logical reference option

      Internal option used to mark a collection as temporary.

    • secrefr - Indicates a secondary reference
    • depopt - Indicates instance dependency

      Dependent instances will be deleted when being removed from a collection

    • extnames - Extent name

      The name contains the name of the extent, only. It does not contain a namespace scope.

      Notes:

      retval checked for const &NString

    • irefname - Inverse reference field name or path

      The inverse reference field name is passed as 0-terminated string.

  12. to list