Sq3ValueC_Info_C_API

Sq3ValueC - get type-information … More...

Collaboration diagram for Sq3ValueC_Info_C_API:

Functions
static enum Sq3TextE	Sq3ValueBytes (SQ3_VALN sq3val)
	Obtaining SQL Values …
static enum Sq3TextE	Sq3ValueEncoding (SQ3_VALN sq3val)
	Report the internal text encoding state of an sqlite3_value object …
static MK_BOOL	Sq3ValueFromBind (SQ3_VALN sq3val)
	Obtaining SQL Values …
static MK_BOOL	Sq3ValueNoChange (SQ3_VALN sq3val)
	Obtaining SQL Values …
static enum Sq3TypeE	Sq3ValueNumericType (SQ3_VALN sq3val)
	Obtaining SQL Values …
static MK_I32	Sq3ValueSubType (SQ3_VALN sq3val)
	Finding The Subtype Of SQL Values …
static enum Sq3TypeE	Sq3ValueType (SQ3_VALN sq3val)
	Obtaining SQL Values …
void	Sq3ValueLog_RT (MK_RT mkrt, SQ3_VALN const val, MK_OBJN fmtobj, MK_DBG const debug, MK_STRN const callfunc, MK_I32 const lvl)
	log the val …

Sq3ValueC - Sq3ValueC_Info_C_API - function
enum Sq3TextE	Sq3ValueBytesP (SQ3_VALN sq3val)
	Non-inline replacement for Sq3ValueBytes …
enum Sq3TextE	Sq3ValueEncodingP (SQ3_VALN sq3val)
	Non-inline replacement for Sq3ValueEncoding …
MK_BOOL	Sq3ValueFromBindP (SQ3_VALN sq3val)
	Non-inline replacement for Sq3ValueFromBind …
MK_BOOL	Sq3ValueNoChangeP (SQ3_VALN sq3val)
	Non-inline replacement for Sq3ValueNoChange …
enum Sq3TypeE	Sq3ValueNumericTypeP (SQ3_VALN sq3val)
	Non-inline replacement for Sq3ValueNumericType …
MK_I32	Sq3ValueSubTypeP (SQ3_VALN sq3val)
	Non-inline replacement for Sq3ValueSubType …
enum Sq3TypeE	Sq3ValueTypeP (SQ3_VALN sq3val)
	Non-inline replacement for Sq3ValueType …

Sq3ValueC - Sq3ValueC_Info_C_API - overload
#define	Sq3ValueLog_NULL(...)
#define	Sq3ValueLog(...)
#define	Sq3ValueLog_4(val, fmtobj, debug, callfunc)
#define	Sq3ValueLog_3(val, fmtobj, debug)
#define	Sq3ValueLog_2(val, fmtobj)
#define	Sq3ValueLog_1(val)

Detailed Description

Sq3ValueC - get type-information …

Macro Definition Documentation

Sq3ValueLog

#define Sq3ValueLog

(

...

)

Value:

Sq3ValueLog_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 711 of file sqlite3_overload_sq3.h.

Sq3ValueLog_1

#define Sq3ValueLog_1

(

val

)

Value:

Sq3ValueLog(val,NULL,0,__func__,0)

Definition at line 715 of file sqlite3_overload_sq3.h.

Sq3ValueLog_2

#define Sq3ValueLog_2	(		val,
			fmtobj )

Value:

Sq3ValueLog(val,fmtobj,0,__func__,0)

Definition at line 714 of file sqlite3_overload_sq3.h.

Sq3ValueLog_3

#define Sq3ValueLog_3	(		val,
			fmtobj,
			debug )

Value:

Sq3ValueLog(val,fmtobj,debug,__func__,0)

Definition at line 713 of file sqlite3_overload_sq3.h.

Sq3ValueLog_4

#define Sq3ValueLog_4	(		val,
			fmtobj,
			debug,
			callfunc )

Value:

Sq3ValueLog(val,fmtobj,debug,callfunc,0)

Definition at line 712 of file sqlite3_overload_sq3.h.

Sq3ValueLog_NULL

#define Sq3ValueLog_NULL

(

...

)

Value:

Sq3ValueLog_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 710 of file sqlite3_overload_sq3.h.

Function Documentation

Sq3ValueBytes()

static enum Sq3TextE Sq3ValueBytes ( SQ3_VALN sq3val )

inlinestatic

Obtaining SQL Values …

read more at 'Sq3ValueBlob'

Definition at line 37 of file Sq3ValueC_sq3.h.

                                                          {
    SQ3_INSTANCE_HDL(sq3val);
    return (enum Sq3TextE)sqlite3_value_bytes(sq3val->nat);
  }

Here is the caller graph for this function:

Sq3ValueBytesP()

enum Sq3TextE Sq3ValueBytesP

(

SQ3_VALN

sq3val

)

Non-inline replacement for Sq3ValueBytes …

Sq3ValueEncoding()

static enum Sq3TextE Sq3ValueEncoding ( SQ3_VALN sq3val )

inlinestatic

Report the internal text encoding state of an sqlite3_value object …

The Sq3ValueEncoding(X) interface returns one of SQ3_TEXT_UTF8, SQ3_TEXT_UTF16BE, or SQ3_TEXT_UTF16LE according to the current text encoding of the value X, assuming that X has type TEXT. If Sq3ValueType(X) returns something other than SQ3_TYPE_TEXT, then the return value from Sq3ValueEncoding(X) is meaningless. Calls to Sq3ValueText (X), sqlite3_value_text16 (X), sqlite3_value_text16be (X), sqlite3_value_text16le (X), Sq3ValueBytes (X), or sqlite3_value_bytes16 (X) might change the encoding of the value X and thus change the return from subsequent calls to Sq3ValueEncoding(X).

This routine is intended for used by applications that test and validate the SQLite implementation. This routine is inquiring about the opaque internal state of an Sq3ValueC object. Ordinary applications should not need to know what the internal state of an Sq3ValueC object is and hence should not need to use this interface.

Reference code from sqlite3:

SQLITE_API int sqlite3_value_encoding(sqlite3_value*);

Definition at line 43 of file Sq3ValueC_sq3.h.

                                                             {
    SQ3_INSTANCE_HDL(sq3val);
    return (enum Sq3TextE)sqlite3_value_encoding(sq3val->nat);
  }

Here is the caller graph for this function:

Sq3ValueEncodingP()

enum Sq3TextE Sq3ValueEncodingP

(

SQ3_VALN

sq3val

)

Non-inline replacement for Sq3ValueEncoding …

Sq3ValueFromBind()

static MK_BOOL Sq3ValueFromBind ( SQ3_VALN sq3val )

inlinestatic

Obtaining SQL Values …

read more at 'Sq3ValueBlob'

Definition at line 49 of file Sq3ValueC_sq3.h.

                                                       {
    SQ3_INSTANCE_HDL(sq3val);
    return (MK_BOOL)sqlite3_value_frombind(sq3val->nat);
  }

Here is the caller graph for this function:

Sq3ValueFromBindP()

MK_BOOL Sq3ValueFromBindP

(

SQ3_VALN

sq3val

)

Non-inline replacement for Sq3ValueFromBind …

Sq3ValueLog_RT()

void Sq3ValueLog_RT	(	MK_RT	mkrt,
		SQ3_VALN const	val,
		MK_OBJN	fmtobj,
		MK_DBG const	debug,
		MK_STRN const	callfunc,
		MK_I32 const	lvl )

log the val …

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	val	Programming-Language-Micro-Kernel (PLMK) instance from sqlite3_value
[in]	fmtobj	managed object used to format the log-message (default=nil → use default-format)
[in]	debug	the debug level from MkRuntimeS::debug, use 0 <= debug <= 9 (default=0)
[in]	callfunc	a user-defined postfix to identify the calling function or the environment (default=name-of-function)
[in]	lvl	a user-defined prefix starting with "" for lvl=0 and increase with " " for lvl+1 (default=0)

Sq3ValueNoChange()

static MK_BOOL Sq3ValueNoChange ( SQ3_VALN sq3val )

inlinestatic

Obtaining SQL Values …

read more at 'Sq3ValueBlob'

Definition at line 55 of file Sq3ValueC_sq3.h.

                                                       {
    SQ3_INSTANCE_HDL(sq3val);
    return (MK_BOOL)sqlite3_value_nochange(sq3val->nat);
  }

Here is the caller graph for this function:

Sq3ValueNoChangeP()

MK_BOOL Sq3ValueNoChangeP

(

SQ3_VALN

sq3val

)

Non-inline replacement for Sq3ValueNoChange …

Sq3ValueNumericType()

static enum Sq3TypeE Sq3ValueNumericType ( SQ3_VALN sq3val )

inlinestatic

Obtaining SQL Values …

read more at 'Sq3ValueBlob'

Definition at line 61 of file Sq3ValueC_sq3.h.

                                                                {
    SQ3_INSTANCE_HDL(sq3val);
    return (enum Sq3TypeE)sqlite3_value_numeric_type(sq3val->nat);
  }

Here is the caller graph for this function:

Sq3ValueNumericTypeP()

enum Sq3TypeE Sq3ValueNumericTypeP

(

SQ3_VALN

sq3val

)

Non-inline replacement for Sq3ValueNumericType …

Sq3ValueSubType()

static MK_I32 Sq3ValueSubType ( SQ3_VALN sq3val )

inlinestatic

Finding The Subtype Of SQL Values …

The Sq3ValueSubType(V) function returns the subtype for an application-defined SQL function argument V. The subtype information can be used to pass a limited amount of context from one SQL function to another. Use the sqlite3_result_subtype () routine to set the subtype for the return value of an SQL function.

Every application-defined SQL function that invoke this interface should include the SQ3_FUNCTION_SUBTYPE property in the text encoding argument when the function is registered. If the SQ3_FUNCTION_SUBTYPE property is omitted, then Sq3ValueSubType() might return zero instead of the upstream subtype in some corner cases.

Reference code from sqlite3:

SQLITE_API unsigned int sqlite3_value_subtype(sqlite3_value*);

Definition at line 67 of file Sq3ValueC_sq3.h.

                                                     {
    SQ3_INSTANCE_HDL(sq3val);
    return (MK_I32)sqlite3_value_subtype(sq3val->nat);
  }

Here is the caller graph for this function:

Sq3ValueSubTypeP()

MK_I32 Sq3ValueSubTypeP

(

SQ3_VALN

sq3val

)

Non-inline replacement for Sq3ValueSubType …

Sq3ValueType()

static enum Sq3TypeE Sq3ValueType ( SQ3_VALN sq3val )

inlinestatic

Obtaining SQL Values …

read more at 'Sq3ValueBlob'

Definition at line 73 of file Sq3ValueC_sq3.h.

                                                         {
    SQ3_INSTANCE_HDL(sq3val);
    return (enum Sq3TypeE)sqlite3_value_type(sq3val->nat);
  }

Here is the caller graph for this function:

Sq3ValueTypeP()

enum Sq3TypeE Sq3ValueTypeP

(

SQ3_VALN

sq3val

)

Non-inline replacement for Sq3ValueType …