FFParameter

FFParameter — Class for handling parameter objects.

Synopsis


#include <ff-parameter.h>


struct      FFParameter;

FFParameter* ff_parameter_new               (void);
void        ff_parameter_free               (FFParameter *self);

const gchar* ff_parameter_get_name          (FFParameter *self);
gint        ff_parameter_get_position       (FFParameter *self);
void        ff_parameter_set_position       (FFParameter *self,
                                             gint parameter_position);

const gchar* ff_parameter_get_string        (FFParameter *self);
void        ff_parameter_set_string         (FFParameter *self,
                                             const gchar *val);
gint64      ff_parameter_get_int64          (FFParameter *self);
void        ff_parameter_set_int64          (FFParameter *self,
                                             gint64 val);
gint        ff_parameter_get_integer        (FFParameter *self);
void        ff_parameter_set_integer        (FFParameter *self,
                                             gint val);
gshort      ff_parameter_get_smallint       (FFParameter *self);
void        ff_parameter_set_smallint       (FFParameter *self,
                                             gshort val);
const FFDecimal* ff_parameter_get_decimal   (FFParameter *self);
void        ff_parameter_set_decimal        (FFParameter *self,
                                             const FFDecimal *val);
gdouble     ff_parameter_get_double         (FFParameter *self);
void        ff_parameter_set_double         (FFParameter *self,
                                             gdouble val);
gfloat      ff_parameter_get_float          (FFParameter *self);
void        ff_parameter_set_float          (FFParameter *self,
                                             gfloat val);
const FFDate* ff_parameter_get_date         (FFParameter *self);
void        ff_parameter_set_date           (FFParameter *self,
                                             const FFDate *val);
const FFTime* ff_parameter_get_time         (FFParameter *self);
void        ff_parameter_set_time           (FFParameter *self,
                                             const FFTime *val);
const FFTimestamp* ff_parameter_get_timestamp
                                            (FFParameter *self);
void        ff_parameter_set_timestamp      (FFParameter *self,
                                             const FFTimestamp *val);
const ISC_QUAD* ff_parameter_get_blob_id    (FFParameter *self);
void        ff_parameter_set_blob_id        (FFParameter *self,
                                             const ISC_QUAD *val);

FFValueType ff_parameter_get_value_type     (FFParameter *self);
gchar*      ff_parameter_get_type_name      (FFParameter *self);
void        ff_parameter_set_value          (FFParameter *self,
                                             FFValue *value);
gboolean    ff_parameter_is_null            (FFParameter *self);

Description

Parameters are used inside SQL statements. Each parameter represents an input value in a statement. Usually parameter value is initialized to NULL until a real value is assigned using a funtion like ff_parameter_set_integer() or ff_parameter_set_date().

Details

struct FFParameter

struct FFParameter;

ff_parameter_new ()

FFParameter* ff_parameter_new               (void);

Constructor for parameter class.

Returns :

A new FFParameter.

ff_parameter_free ()

void        ff_parameter_free               (FFParameter *self);

Destructor for parameter class.

self : A FFParameter.

ff_parameter_get_name ()

const gchar* ff_parameter_get_name          (FFParameter *self);

Get parameter's name. (Parameter name is equal to its FFValue name)

`self` :	A FFParameter.
Returns :	A string containing parameter's name.

ff_parameter_get_position ()

gint        ff_parameter_get_position       (FFParameter *self);

Get parameter's position.

`self` :	A FFParameter.
Returns :	Parameter position.

ff_parameter_set_position ()

void        ff_parameter_set_position       (FFParameter *self,
                                             gint parameter_position);

Set parameter's position.

`self` :	A FFParameter.
`parameter_position` :	Position number of parameter.

ff_parameter_get_string ()

const gchar* ff_parameter_get_string        (FFParameter *self);

Get parameter's string value.

`self` :	A FFParameter.
Returns :	A string.

ff_parameter_set_string ()

void        ff_parameter_set_string         (FFParameter *self,
                                             const gchar *val);

Set parameter's string value.

`self` :	A FFParameter.
`val` :	A string.

ff_parameter_get_int64 ()

gint64      ff_parameter_get_int64          (FFParameter *self);

Get parameter's int64 value.

`self` :	A FFParameter.
Returns :	An int64.

ff_parameter_set_int64 ()

void        ff_parameter_set_int64          (FFParameter *self,
                                             gint64 val);

Set parameter's int64 value.

`self` :	A FFParameter.
`val` :	An int64.

ff_parameter_get_integer ()

gint        ff_parameter_get_integer        (FFParameter *self);

Get parameter's integer value.

`self` :	A FFParameter.
Returns :	An integer.

ff_parameter_set_integer ()

void        ff_parameter_set_integer        (FFParameter *self,
                                             gint val);

Set parameter's integer value.

`self` :	A FFParameter.
`val` :	An integer.

ff_parameter_get_smallint ()

gshort      ff_parameter_get_smallint       (FFParameter *self);

Get parameter's smallint value.

`self` :	A FFParameter.
Returns :	A short.

ff_parameter_set_smallint ()

void        ff_parameter_set_smallint       (FFParameter *self,
                                             gshort val);

Set parameter's smallint value.

`self` :	A FFParameter.
`val` :	A short.

ff_parameter_get_decimal ()

const FFDecimal* ff_parameter_get_decimal   (FFParameter *self);

Get parameter's decimal value.

`self` :	A FFParameter.
Returns :	A FFDecimal.

ff_parameter_set_decimal ()

void        ff_parameter_set_decimal        (FFParameter *self,
                                             const FFDecimal *val);

Set parameter's decimal value.

`self` :	A FFParameter.
`val` :	A FFDecimal.

ff_parameter_get_double ()

gdouble     ff_parameter_get_double         (FFParameter *self);

Get parameter's double value.

`self` :	A FFParameter.
Returns :	A double.

ff_parameter_set_double ()

void        ff_parameter_set_double         (FFParameter *self,
                                             gdouble val);

Set parameter's double value.

`self` :	A FFParameter.
`val` :	A double.

ff_parameter_get_float ()

gfloat      ff_parameter_get_float          (FFParameter *self);

Get parameter's float value.

`self` :	A FFParameter.
Returns :	A float.

ff_parameter_set_float ()

void        ff_parameter_set_float          (FFParameter *self,
                                             gfloat val);

Set parameter's float value.

`self` :	A FFParameter.
`val` :	A float.

ff_parameter_get_date ()

const FFDate* ff_parameter_get_date         (FFParameter *self);

Get parameter's date value.

`self` :	A FFParameter.
Returns :	A FFDate.

ff_parameter_set_date ()

void        ff_parameter_set_date           (FFParameter *self,
                                             const FFDate *val);

Set parameter's date value.

`self` :	A FFParameter.
`val` :	A FFDate.

ff_parameter_get_time ()

const FFTime* ff_parameter_get_time         (FFParameter *self);

Get parameter's time value.

`self` :	A FFParameter.
Returns :	A FFTime.

ff_parameter_set_time ()

void        ff_parameter_set_time           (FFParameter *self,
                                             const FFTime *val);

Set parameter's time value.

`self` :	A FFParameter.
`val` :	A FFTime.

ff_parameter_get_timestamp ()

const FFTimestamp* ff_parameter_get_timestamp
                                            (FFParameter *self);

Get parameter's timestamp value.

`self` :	A FFParameter.
Returns :	A FFTimestamp.

ff_parameter_set_timestamp ()

void        ff_parameter_set_timestamp      (FFParameter *self,
                                             const FFTimestamp *val);

Set parameter's timestamp value.

`self` :	A FFParameter.
`val` :	A FFTimestamp.

ff_parameter_get_blob_id ()

const ISC_QUAD* ff_parameter_get_blob_id    (FFParameter *self);

Get parameter's blob id value.

`self` :	A FFParameter.
Returns :	A pointer to an ISC_QUAD.

ff_parameter_set_blob_id ()

void        ff_parameter_set_blob_id        (FFParameter *self,
                                             const ISC_QUAD *val);

Set parameter's blob id value.

`self` :	A FFParameter.
`val` :	A pointer to an ISC_QUAD.

ff_parameter_get_value_type ()

FFValueType ff_parameter_get_value_type     (FFParameter *self);

Get current parameter value type.

`self` :	A FFParameter.
Returns :	A FFValueType.

ff_parameter_get_type_name ()

gchar*      ff_parameter_get_type_name      (FFParameter *self);

Get a string representation of the current parameter value type.

`self` :	A FFParameter.
Returns :	A string with value type.

ff_parameter_set_value ()

void        ff_parameter_set_value          (FFParameter *self,
                                             FFValue *value);

Set value for parameter.

`self` :	A FFParameter.
`value` :	A FFValue.

ff_parameter_is_null ()

gboolean    ff_parameter_is_null            (FFParameter *self);

Get parameter null status.

`self` :	A FFParameter.
Returns :	`TRUE` if parameter is NULL, or `FALSE` otherwise.