gda-row

Name

gda-row -- Functions for accesing GdaRow.

Synopsis



typedef     GdaRow;
typedef     GdaRowAttributes;
typedef     GdaFieldAttributes;
typedef     GdaField;
enum        GdaType;
GdaRow*     gda_row_new                     (gint count);
void        gda_row_free                    (GdaRow *row);
GdaField*   gda_row_get_field               (GdaRow *row,
                                             gint num);
GdaRowAttributes* gda_row_attributes_new    (gint count);
void        gda_row_attributes_free         (GdaRowAttributes *attrs);
GdaFieldAttributes* gda_row_attributes_get_field
                                            (GdaRowAttributes *attrs,
                                             gint num);
glong       gda_field_attributes_get_defined_size
                                            (GdaFieldAttributes *fa);
void        gda_field_attributes_set_defined_size
                                            (GdaFieldAttributes *fa,
                                             glong size);
const gchar* gda_field_attributes_get_name  (GdaFieldAttributes *fa);
void        gda_field_attributes_set_name   (GdaFieldAttributes *fa,
                                             const gchar *name);
glong       gda_field_attributes_get_scale  (GdaFieldAttributes *fa);
void        gda_field_attributes_set_scale  (GdaFieldAttributes *fa,
                                             glong scale);
GdaType     gda_field_attributes_get_gdatype
                                            (GdaFieldAttributes *fa);
void        gda_field_attributes_set_gdatype
                                            (GdaFieldAttributes *fa,
                                             GdaType type);
glong       gda_field_get_actual_size       (GdaField *field);
void        gda_field_set_actual_size       (GdaField *field,
                                             glong size);
glong       gda_field_get_defined_size      (GdaField *field);
void        gda_field_set_defined_size      (GdaField *field,
                                             glong size);
const gchar* gda_field_get_name             (GdaField *field);
void        gda_field_set_name              (GdaField *field,
                                             const gchar *name);
glong       gda_field_get_scale             (GdaField *field);
void        gda_field_set_scale             (GdaField *field,
                                             glong scale);
GdaType     gda_field_get_gdatype           (GdaField *field);
void        gda_field_set_gdatype           (GdaField *field,
                                             GdaType type);
gboolean    gda_field_is_null               (GdaField *field);
GdaValue*   gda_field_get_value             (GdaField *field);
void        gda_field_set_value             (GdaField *field,
                                             const GdaValue *value);
gint64      gda_field_get_bigint_value      (GdaField *field);
void        gda_field_set_bigint_value      (GdaField *field,
                                             gint64 value);
gconstpointer gda_field_get_binary_value    (GdaField *field);
void        gda_field_set_binary_value      (GdaField *field,
                                             gconstpointer value,
                                             glong size);
gboolean    gda_field_get_boolean_value     (GdaField *field);
void        gda_field_set_boolean_value     (GdaField *field,
                                             gboolean value);
const GdaDate* gda_field_get_date_value     (GdaField *field);
void        gda_field_set_date_value        (GdaField *field,
                                             GdaDate *date);
gdouble     gda_field_get_double_value      (GdaField *field);
void        gda_field_set_double_value      (GdaField *field,
                                             gdouble value);
const GdaGeometricPoint* gda_field_get_geometric_point_value
                                            (GdaField *field);
void        gda_field_set_geometric_point_value
                                            (GdaField *field,
                                             GdaGeometricPoint *value);
gint        gda_field_get_integer_value     (GdaField *field);
void        gda_field_set_integer_value     (GdaField *field,
                                             gint value);
const GdaValueList* gda_field_get_list_value
                                            (GdaField *field);
void        gda_field_set_list_value        (GdaField *field,
                                             GdaValueList *value);
void        gda_field_set_null_value        (GdaField *field);
gfloat      gda_field_get_single_value      (GdaField *field);
void        gda_field_set_single_value      (GdaField *field,
                                             gfloat value);
gshort      gda_field_get_smallint_value    (GdaField *field);
void        gda_field_set_smallint_value    (GdaField *field,
                                             gshort value);
const gchar* gda_field_get_string_value     (GdaField *field);
void        gda_field_set_string_value      (GdaField *field,
                                             const gchar *value);
const GdaTime* gda_field_get_time_value     (GdaField *field);
void        gda_field_set_time_value        (GdaField *field,
                                             GdaTime *value);
const GdaTimestamp* gda_field_get_timestamp_value
                                            (GdaField *field);
void        gda_field_set_timestamp_value   (GdaField *field,
                                             GdaTimestamp *value);
gchar       gda_field_get_tinyint_value     (GdaField *field);
void        gda_field_set_tinyint_value     (GdaField *field,
                                             gchar value);
gchar*      gda_field_stringify             (GdaField *field);

Description

Details

GdaRow

typedef GNOME_Database_Row             GdaRow;


GdaRowAttributes

typedef GNOME_Database_RowAttributes   GdaRowAttributes;


GdaFieldAttributes

typedef GNOME_Database_FieldAttributes GdaFieldAttributes;


GdaField

typedef GNOME_Database_Field           GdaField;


enum GdaType

typedef enum {
	GDA_TYPE_NULL = GNOME_Database_TYPE_NULL,
	GDA_TYPE_BIGINT = GNOME_Database_TYPE_BIGINT,
	GDA_TYPE_BINARY = GNOME_Database_TYPE_BINARY,
	GDA_TYPE_BOOLEAN = GNOME_Database_TYPE_BOOLEAN,
	GDA_TYPE_DATE = GNOME_Database_TYPE_DATE,
	GDA_TYPE_DOUBLE = GNOME_Database_TYPE_DOUBLE,
	GDA_TYPE_GEOMETRIC_POINT = GNOME_Database_TYPE_GEOMETRIC_POINT,
	GDA_TYPE_INTEGER = GNOME_Database_TYPE_INTEGER,
	GDA_TYPE_LIST = GNOME_Database_TYPE_LIST,
	GDA_TYPE_SINGLE = GNOME_Database_TYPE_SINGLE,
	GDA_TYPE_SMALLINT = GNOME_Database_TYPE_SMALLINT,
	GDA_TYPE_STRING = GNOME_Database_TYPE_STRING,
	GDA_TYPE_TIME = GNOME_Database_TYPE_TIME,
	GDA_TYPE_TIMESTAMP = GNOME_Database_TYPE_TIMESTAMP,
	GDA_TYPE_TINYINT = GNOME_Database_TYPE_TINYINT,
	GDA_TYPE_UNKNOWN = GNOME_Database_TYPE_UNKNOWN
}
GdaType;


gda_row_new ()

GdaRow*     gda_row_new                     (gint count);

Creates a GdaRow which can hold count GdaField.

count : number of GdaField in the new GdaRow.
Returns : the newly allocated GdaRow.


gda_row_free ()

void        gda_row_free                    (GdaRow *row);

Deallocates all memory associated to a GdaRow.

row : the resource to free.


gda_row_get_field ()

GdaField*   gda_row_get_field               (GdaRow *row,
                                             gint num);

Gets a pointer to a GdaField stored in a GdaRow.

row : a GdaRow (which contains GdaField).
num : field index.
Returns : a pointer to the GdaField in the position num of row.


gda_row_attributes_new ()

GdaRowAttributes* gda_row_attributes_new    (gint count);

Creates a new GdaRowAttributes which can hold up to count attributes.

count : number of GdaRowAttributes to allocate.
Returns : a pointer to the newly allocated row attributes.


gda_row_attributes_free ()

void        gda_row_attributes_free         (GdaRowAttributes *attrs);

Deallocates the memory associated with attrs.

attrs : a GdaRowAttributes.


gda_row_attributes_get_field ()

GdaFieldAttributes* gda_row_attributes_get_field
                                            (GdaRowAttributes *attrs,
                                             gint num);

attrs : a GdaRowAttributes.
num : an index into attrs.
Returns : the num'th GdafieldAttributes in attrs.


gda_field_attributes_get_defined_size ()

glong       gda_field_attributes_get_defined_size
                                            (GdaFieldAttributes *fa);

fa : a GdaRowAttributes
Returns : the defined size of fa.


gda_field_attributes_set_defined_size ()

void        gda_field_attributes_set_defined_size
                                            (GdaFieldAttributes *fa,
                                             glong size);

Sets the defined size of a GdaFieldAttributes.

fa : a GdaFieldAttributes.
size : the defined size we want to set.


gda_field_attributes_get_name ()

const gchar* gda_field_attributes_get_name  (GdaFieldAttributes *fa);

fa : a GdaFieldAttributes.
Returns : the name of fa.


gda_field_attributes_set_name ()

void        gda_field_attributes_set_name   (GdaFieldAttributes *fa,
                                             const gchar *name);

Sets the name of fa to name.

fa : a GdaFieldAttributes.
name : the new name of fa.


gda_field_attributes_get_scale ()

glong       gda_field_attributes_get_scale  (GdaFieldAttributes *fa);

fa : a GdaFieldAttributes.
Returns : the number of decimals of fa.


gda_field_attributes_set_scale ()

void        gda_field_attributes_set_scale  (GdaFieldAttributes *fa,
                                             glong scale);

Sets the scale of fa to scale.

fa : a GdaFieldAttributes.
scale : number of decimals.


gda_field_attributes_get_gdatype ()

GdaType     gda_field_attributes_get_gdatype
                                            (GdaFieldAttributes *fa);

fa : a GdaFieldAttributes.
Returns : the type of fa.


gda_field_attributes_set_gdatype ()

void        gda_field_attributes_set_gdatype
                                            (GdaFieldAttributes *fa,
                                             GdaType type);

Sets the type of fa to type.

fa : a GdaFieldAttributes.
type : the new type of fa.


gda_field_get_actual_size ()

glong       gda_field_get_actual_size       (GdaField *field);

field : a GdaField
Returns : the actual size of field.


gda_field_set_actual_size ()

void        gda_field_set_actual_size       (GdaField *field,
                                             glong size);

Sets the actual size of field to size.

field : a GdaField
size : the new actual size of field.


gda_field_get_defined_size ()

glong       gda_field_get_defined_size      (GdaField *field);

field : a GdaField
Returns : the defined size of field.


gda_field_set_defined_size ()

void        gda_field_set_defined_size      (GdaField *field,
                                             glong size);

Sets the defined size of field to size.

field : a GdaField.
size : the new defined size of field.


gda_field_get_name ()

const gchar* gda_field_get_name             (GdaField *field);

field : a GdaField
Returns : the name of field.


gda_field_set_name ()

void        gda_field_set_name              (GdaField *field,
                                             const gchar *name);

Sets the name of field to name.

field : a GdaField.
name : the new name of field.


gda_field_get_scale ()

glong       gda_field_get_scale             (GdaField *field);

field : a GdaField
Returns : the scale (number of decimals) of field.


gda_field_set_scale ()

void        gda_field_set_scale             (GdaField *field,
                                             glong scale);

Sets the scale of field to scale.

field : a GdaField.
scale : the new scale of field.


gda_field_get_gdatype ()

GdaType     gda_field_get_gdatype           (GdaField *field);

field : a GdaField
Returns : the type of field.


gda_field_set_gdatype ()

void        gda_field_set_gdatype           (GdaField *field,
                                             GdaType type);

Sets the type of field to type.

field : a GdaField.
type : the new type of field.


gda_field_is_null ()

gboolean    gda_field_is_null               (GdaField *field);

field : a GdaField
Returns : a gboolean indicating whether or not the value of field is of type GDA_TYPE_VALUE_NULL.


gda_field_get_value ()

GdaValue*   gda_field_get_value             (GdaField *field);

field : a GdaField
Returns : the GdaValue stored in field.


gda_field_set_value ()

void        gda_field_set_value             (GdaField *field,
                                             const GdaValue *value);

Sets the value of field to value.

field : a GdaField.
value : the GdaValue to store in field.


gda_field_get_bigint_value ()

gint64      gda_field_get_bigint_value      (GdaField *field);

field : a GdaField
Returns : the gint64 value stored in field.


gda_field_set_bigint_value ()

void        gda_field_set_bigint_value      (GdaField *field,
                                             gint64 value);

Sets the value of field to value.

field : a GdaField.
value : the gint64 value to store in field.


gda_field_get_binary_value ()

gconstpointer gda_field_get_binary_value    (GdaField *field);

NOT IMPLEMENTED YET!

field : a GdaField
Returns : the pointer to the binary data in field.


gda_field_set_binary_value ()

void        gda_field_set_binary_value      (GdaField *field,
                                             gconstpointer value,
                                             glong size);

NOT IMPLEMENTED YET! Sets the value of field to the contents pointed to by value.

field : a GdaField.
value : the gint64 value to store in field.
size : size of the buffer pointed to by value.


gda_field_get_boolean_value ()

gboolean    gda_field_get_boolean_value     (GdaField *field);

field : a GdaField
Returns : the gboolean value stored in field.


gda_field_set_boolean_value ()

void        gda_field_set_boolean_value     (GdaField *field,
                                             gboolean value);

Sets the value of field to value.

field : a GdaField.
value : the gboolean value to store in field.


gda_field_get_date_value ()

const GdaDate* gda_field_get_date_value     (GdaField *field);

field : a GdaField
Returns : the pointer to the GdaDate value stored in field.


gda_field_set_date_value ()

void        gda_field_set_date_value        (GdaField *field,
                                             GdaDate *date);

Sets the value of field to the GdaDate pointed to value.

field : a GdaField.
date : the GdaDate value to store in field.


gda_field_get_double_value ()

gdouble     gda_field_get_double_value      (GdaField *field);

field : a GdaField.
Returns : the double precision value stored in field.


gda_field_set_double_value ()

void        gda_field_set_double_value      (GdaField *field,
                                             gdouble value);

Sets the value of field to value.

field : a GdaField.
value : the double precision value to store in field.


gda_field_get_geometric_point_value ()

const GdaGeometricPoint* gda_field_get_geometric_point_value
                                            (GdaField *field);

field : a GdaField.
Returns : the a pointer to the GdaGeometricPoint value stored in field.


gda_field_set_geometric_point_value ()

void        gda_field_set_geometric_point_value
                                            (GdaField *field,
                                             GdaGeometricPoint *value);

Sets the value of field to value.

field : a GdaField.
value : the GdaGeometricPoint value to store in field.


gda_field_get_integer_value ()

gint        gda_field_get_integer_value     (GdaField *field);

field : a GdaField.
Returns : the integer value stored in field.


gda_field_set_integer_value ()

void        gda_field_set_integer_value     (GdaField *field,
                                             gint value);

Sets the value of field to value.

field : a GdaField.
value : the integer value to store in field.


gda_field_get_list_value ()

const GdaValueList* gda_field_get_list_value
                                            (GdaField *field);

field : a GdaField.
Returns : a pointer to the GdaValueList value stored in field.


gda_field_set_list_value ()

void        gda_field_set_list_value        (GdaField *field,
                                             GdaValueList *value);

Sets the value of field to value.

field : a GdaField.
value : the GdaValueList value to store in field.


gda_field_set_null_value ()

void        gda_field_set_null_value        (GdaField *field);

Sets the value of field to be of type GDA_TYPE_VALUE_NULL.

field : a GdaField.


gda_field_get_single_value ()

gfloat      gda_field_get_single_value      (GdaField *field);

field : a GdaField.
Returns : the single precision value stored in field.


gda_field_set_single_value ()

void        gda_field_set_single_value      (GdaField *field,
                                             gfloat value);

Sets the value of field to value.

field : a GdaField.
value : the single precision value to store in field.


gda_field_get_smallint_value ()

gshort      gda_field_get_smallint_value    (GdaField *field);

field : a GdaField.
Returns : the smallint value (16-bit signed integer) stored in field.


gda_field_set_smallint_value ()

void        gda_field_set_smallint_value    (GdaField *field,
                                             gshort value);

Sets the value of field to value.

field : a GdaField.
value : the smallint value (16-bit signed integer) to store in field.


gda_field_get_string_value ()

const gchar* gda_field_get_string_value     (GdaField *field);

field : a GdaField.
Returns : a pointer to the string value stored in field.


gda_field_set_string_value ()

void        gda_field_set_string_value      (GdaField *field,
                                             const gchar *value);

Sets the value of field to value.

field : a GdaField.
value : the string value to store in field.


gda_field_get_time_value ()

const GdaTime* gda_field_get_time_value     (GdaField *field);

field : a GdaField.
Returns : a pointer to the GdaTime value stored in field.


gda_field_set_time_value ()

void        gda_field_set_time_value        (GdaField *field,
                                             GdaTime *value);

Sets the value of field to the contents of value.

field : a GdaField.
value : the GdaTime value to store in field.


gda_field_get_timestamp_value ()

const GdaTimestamp* gda_field_get_timestamp_value
                                            (GdaField *field);

field : a GdaField.
Returns : a pointer to the GdaGeometricData stored in field.


gda_field_set_timestamp_value ()

void        gda_field_set_timestamp_value   (GdaField *field,
                                             GdaTimestamp *value);

Sets the value of field to the contents of value.

field : a GdaField.
value : the GdaTimestamp value to store in field.


gda_field_get_tinyint_value ()

gchar       gda_field_get_tinyint_value     (GdaField *field);

field : a GdaField.
Returns : the tinyint value (8-bit signed integer) stored in field.


gda_field_set_tinyint_value ()

void        gda_field_set_tinyint_value     (GdaField *field,
                                             gchar value);

Sets the value of field to the contents of value.

field : a GdaField.
value : the tinyint value (8-bit signed integer) to store in field.


gda_field_stringify ()

gchar*      gda_field_stringify             (GdaField *field);

See also gda_value_stringify for a list of types and their corresponding string representation format.

field : a GdaField.
Returns : the string representation of the value stored in field.