Help Center

CSQLiteStmt.SourceIDmethod

Returns the SQLite3 source identifier.

DatabasesmethodCSQLite.incdoc-orphan
No implementation located. This member is documented, but the source scan found no matching declaration. It is likely declared in a header this scan does not resolve, or provided by a macro.

Syntax

FUNCTION SourceID () AS STRING

Parameters

NameDescription
opAn integer code for a specific status parameter.
pCurrentPointer to a variable that receives the current value of the parameter.
pHighWaterPointer to a variable that receives the highest recorded value of the parameter.
resetFlagTRUE or FALSE. If true, then the counter is reset to zero after this interface call returns.

Return value

A string containing the SQLite3 identifier, e.g. "2012-06-11 02:05:22 f5b5a13f7394dc143aa136f1d4faba6839eaa6dc".

Returns SQLITE_OK (0) on success and a non-zero error code on failure.

Description

Returns the SQLite3 source identifier.

Remarks

This method is used to retrieve runtime status information about the performance of SQLite, and optionally to reset various highwater marks. The first argument is an integer code for the specific parameter to measure. Recognized integer codes are of the form SQLITE_STATUS_.... The current value of the parameter is returned into pCurrent. The highest recorded value is returned in pHighwater. If the resetFlag is true, then the highest record value is reset after pHighwater is written. Some parameters do not record the highest value. For those parameters nothing is written into pHighwater and the resetFlag is ignored. Other parameters record only the highwater mark and not the current value. For these latter parameters nothing is written into pCurrent.

This function is threadsafe but is not atomic. This function can be called while other threads are running the same or different SQLite interfaces. However the values returned in pCurrent and pHighwater reflect the status of SQLite at different points in time and it is possible that another thread might change the parameter in between the times when pCurrent and pHighwater are written.

Reference

  • Include file CSQLite.inc
  • Documented in Databases/CSQLite Class.md
  • Topic: CSQLite Class