gda-row

Name

gda-row -- Functions for accesing GdaRow.

Synopsis



struct      GdaRow;
GdaRow*     gda_row_new                     (gint count);
GdaRow*     gda_row_new_from_list           (const GList *values);
void        gda_row_free                    (GdaRow *row);
const gchar* gda_row_get_id                 (GdaRow *row);
void        gda_row_set_id                  (GdaRow *row,
                                             const gchar *id);
GdaValue*   gda_row_get_value               (GdaRow *row,
                                             gint num);
gint        gda_row_get_length              (GdaRow *row);

Description

Details

struct GdaRow

struct GdaRow;


gda_row_new ()

GdaRow*     gda_row_new                     (gint count);

Creates a GdaRow which can hold count GdaValue.

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


gda_row_new_from_list ()

GdaRow*     gda_row_new_from_list           (const GList *values);

Create a GdaRow from a list of GdaValue's.

values : a list of GdaValue's.
Returns : the newly created row.


gda_row_free ()

void        gda_row_free                    (GdaRow *row);

Deallocates all memory associated to a GdaRow.

row : the resource to free.


gda_row_get_id ()

const gchar* gda_row_get_id                 (GdaRow *row);

Return the unique identifier for this row. This identifier is assigned by the different providers, to uniquely identify rows returned to clients. If there is no ID, this means that the row has not been created by a provider, or that it the provider cannot identify it (ie, modifications to it won't take place into the database).

row : a GdaRow (which contains GdaValue).
Returns : the unique identifier for this row.


gda_row_set_id ()

void        gda_row_set_id                  (GdaRow *row,
                                             const gchar *id);

Assign a new identifier to the given row. This function is usually called by providers.

row : A GdaRow (which contains GdaValue).
id : New identifier for the row.


gda_row_get_value ()

GdaValue*   gda_row_get_value               (GdaRow *row,
                                             gint num);

Gets a pointer to a GdaValue stored in a GdaRow.

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


gda_row_get_length ()

gint        gda_row_get_length              (GdaRow *row);

Gets the number of columns that the row has.

row : a GdaRow
Returns :