Documentation Source Text

}

COMPILE_OPTION {SQLITE_WIN32_MALLOC_VALIDATE} {
  This option forces the Win32 native memory allocator, when enabled, to
  make strategic calls into the HeapValidate() function if assert() is also
  enabled.
}

</tcl>
<a name="linkage"></a>
<h2>1.10 Compiler Linkage Control</h2>

<p>The following macros specify
interface linkage for certain kinds of SQLite builds.  The Makefiles will normally
handle setting these macros automatically.  Application developers should
not need to worry with these macros.  The following documention aboue these 
macros is included completeness.</p>

<tcl>
COMPILE_OPTION {SQLITE_API} {
  This macro identifies a externally visible interface for SQLite.
  This macro is sometimes set to "extern".  But the definition is
  compiler-specific.
}

COMPILE_OPTION {SQLITE_APICALL} {
  This macro identifies the calling convention used by public interface
  routines in SQLite.  This macro is normally defined to be nothing,
  though on Windows builds it can sometimes be set to "__cdecl" or "__stdcall".
  The "__cdecl" setting is the default, but "__stdcall" is used when SQLite
  is intended to be compiled as a Windows system library.
  <p>
  A single function declaration should contain no more than one of
  the following:  [SQLITE_APICALL], [SQLITE_CALLBACK], [SQLITE_CDECL],
  or [SQLITE_SYSCALL].
}

COMPILE_OPTION {SQLITE_CALLBACK} {
  This macro specifies the calling convention used by callback pointers
  in SQLite.  This macro is normally defined to be nothing, though on Windows
  builds it can sometimes be set to "__cdecl" or "__stdcall".  The
  "__cdecl" setting is the default, but "__stdcall" is used when SQLite
  is intended to be compiled as a Windows system library.
  <p>
  A single function declaration should contain no more than one of
  the following:  [SQLITE_APICALL], [SQLITE_CALLBACK], [SQLITE_CDECL],
  or [SQLITE_SYSCALL].
}

COMPILE_OPTION {SQLITE_CDECL} {
  This macro specifies the calling convention used by varargs interface
  routines in SQLite.  This macro is normally defined to be nothing,
  though on Windows builds it can sometimes be set to "__cdecl".  This
  macro is used on varargs routines and so cannot be set to "__stdcall"
  since the __stdcall calling convention does not support varargs functions.
  <p>
  A single function declaration should contain no more than one of
  the following:  [SQLITE_APICALL], [SQLITE_CALLBACK], [SQLITE_CDECL],
  or [SQLITE_SYSCALL].
}

COMPILE_OPTION {SQLITE_SYSCALL} {
  This macro identifies the calling convention used by operating system
  interfaces for target the platform for an SQLite build.
  This macro is normally defined to be nothing, though on Windows
  builds it can sometimes be set to "__stdcall".
  <p>
  A single function declaration should contain no more than one of
  the following:  [SQLITE_APICALL], [SQLITE_CALLBACK], [SQLITE_CDECL],
  or [SQLITE_SYSCALL].
}

COMPILE_OPTION {SQLITE_TCLAPI} {
  This macro specifies the calling convention used by the 
  [http://www.tcl.tk | TCL] library interface routines.
  This macro is not used by the SQLite core, but only by the [TCL Interface]
  and [TCL test suite].
  This macro is normally defined to be nothing,
  though on Windows builds it can sometimes be set to "__cdecl".  This
  macro is used on TCL library interface routines which are always compiled
  as __cdecl, even on platforms that prefer to use __stdcall, so this
  macro should not be set to __stdcall unless the platform as a custom
  TCL library build that supports __stdcall.
  <p>
  This macro may not be used in combination with any of [SQLITE_APICALL],
  [SQLITE_CALLBACK], [SQLITE_CDECL], or [SQLITE_SYSCALL].
}


</tcl>