company logo

TypeDefinition :: basedOn - Does structure inherit from passed type

The function returns whether the type definition is a specialization of the type passed in sTypeName (true) or not (false). In contrast to inherits(), the function returns false, when the type is identical with the type name passed. The function does not check, whether the type name passed is a valid type.

When calling the function with an invalid type definition (e.g. key definition), the function throws an exception.

Return value:  Success ( bool  )

The value is true when the function was executed successfully. Otherwise the value is set to false.

Implementation details

bool TypeDefinition  :: basedOn ( odaba::String &sTypeName )
  • sTypeName - Type name

    The type name is the name of a data type (usually) defined in the database. The type name might be passed as simple identifier or as scoped name with preceding namespace names separated by double colon '::'.

    In order to pass no type name, an empty string ( String() ) may be passed.