Difference between revisions of "SDK Function Levels"

From Recital Documentation Wiki
Jump to: navigation, search
m (FUNCTION LEVELS moved to SDK Function Levels)
 
(One intermediate revision by one user not shown)
Line 3: Line 3:
  
 
====Level 1====
 
====Level 1====
Functions available at [[Overview of Level 1|level 1]] are for use with parameter passing between Recital and your C function.  These are used to check the type and number of parameters passed and to convert Recital data types to C data types.  A 'C' UDF which uses the RECITAL/API can have a variable number of parameters passed to it from Recital.  For example:
+
Functions available at [[SDK Overview of Level 1|level 1]] are for use with parameter passing between Recital and your C function.  These are used to check the type and number of parameters passed and to convert Recital data types to C data types.  A 'C' UDF which uses the RECITAL/API can have a variable number of parameters passed to it from Recital.  For example:
  
 
<code lang="recital">
 
<code lang="recital">
Line 13: Line 13:
  
 
====Level 2====
 
====Level 2====
Functions available at [[Overview of Level 2|level 2]] are high-level functions used to execute RECITAL commands and evaluate expressions.
+
Functions available at [[SDK Overview of Level 2|level 2]] are high-level functions used to execute RECITAL commands and evaluate expressions.
  
  
 
====Level 3====
 
====Level 3====
Functions available at [[Overview of Level 3|level 3]] are low-level functions separated into the following category dependent usage.
+
Functions available at [[SDK Overview of Level 3|level 3]] are low-level functions separated into the following category dependent usage.
  
  
Line 45: Line 45:
  
 
====Level 4====
 
====Level 4====
Functions available at [[Overview of Level 4|level 4]] are for use with building classes and managing objects.
+
Functions available at [[SDK Overview of Level 4|level 4]] are for use with building classes and managing objects.
  
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:SDK]]
 
[[Category:SDK]]
 +
[[Category:Reference]]

Latest revision as of 14:13, 30 March 2009

The API (Applications Programming Interface) provides a library of 'C' functions that are divided into four different levels.


Level 1

Functions available at level 1 are for use with parameter passing between Recital and your C function. These are used to check the type and number of parameters passed and to convert Recital data types to C data types. A 'C' UDF which uses the RECITAL/API can have a variable number of parameters passed to it from Recital. For example:

store "RECITAL" to m_string
store 7.0 to m_value
m_result = dbapi_udf ( m_string, m_value)


Level 2

Functions available at level 2 are high-level functions used to execute RECITAL commands and evaluate expressions.


Level 3

Functions available at level 3 are low-level functions separated into the following category dependent usage.


TYPE DESCRIPTION
ARRAY Recital array access
BLOB Operations on binary large objects
CHARACTER Character string functions
CURRENCY Currency functions
DATE Date, datetime and time functions
DBF Database I/O operations
FIELD Field I/O operations
MEMO Memo I/O operations
MEMVAR Recital memory variable operations


Level 4

Functions available at level 4 are for use with building classes and managing objects.