API constants
🚀

API constants

  • Data types
  • Symbolic constants

Data types

Data parameters used by the API are of the following standard C++ types:

  • integer
  • double
  • long
  • boolean
  • string
  • vector<string>
  • vector < vector <string > >

Symbolic constants

A symbolic constant represents a system-defined integer that is used to refer to a particular library parameter. For instance, the symbolic constant that refers to the security master data array is FT_SECURITY_DATA, and the command to assign a data array called security_data to act as the security master data array is

FIA_parameter ( FT_SECURITY_DATA, security_data );

The naming conventions for symbolic constants are

  • Each symbolic constant is a string delimited with an underscore character.
  • Symbolic constants are always in capitals.
  • All constants have the prefix ‘FT’.
  • The type of the constant is shown by the string immediately following the FT prefix. For instance, FT_STRING_CARRY_DECOMPOSITION refers to a string variable, while FT_BOOL_ROLLDOWN_ATTRIBUTION refers to a Boolean

Since C++ allows overloading, the FT_parameter function can be used for all the above data types.