couchdb-array-field

couchdb-array-field

Synopsis

                    CouchdbArrayFieldClass;
CouchdbArrayField * couchdb_array_field_new             (void);
guint               couchdb_array_field_get_length      (CouchdbArrayField *array);
void                couchdb_array_field_add_array_element
                                                        (CouchdbArrayField *array,
                                                         const CouchdbArrayField *value);
void                couchdb_array_field_add_boolean_element
                                                        (CouchdbArrayField *array,
                                                         gboolean value);
void                couchdb_array_field_add_double_element
                                                        (CouchdbArrayField *array,
                                                         gdouble value);
void                couchdb_array_field_add_int_element (CouchdbArrayField *array,
                                                         gint value);
void                couchdb_array_field_add_string_element
                                                        (CouchdbArrayField *array,
                                                         const gchar *value);
void                couchdb_array_field_add_struct_element
                                                        (CouchdbArrayField *array,
                                                         const CouchdbStructField *value);
void                couchdb_array_field_remove_element  (CouchdbArrayField *array,
                                                         guint index);
CouchdbArrayField * couchdb_array_field_get_array_element
                                                        (CouchdbArrayField *array,
                                                         guint index);
gboolean            couchdb_array_field_get_boolean_element
                                                        (CouchdbArrayField *array,
                                                         guint index);
gdouble             couchdb_array_field_get_double_element
                                                        (CouchdbArrayField *array,
                                                         guint index);
gint                couchdb_array_field_get_int_element (CouchdbArrayField *array,
                                                         guint index);
const gchar *       couchdb_array_field_get_string_element
                                                        (CouchdbArrayField *array,
                                                         guint index);
CouchdbStructField * couchdb_array_field_get_struct_element
                                                        (CouchdbArrayField *array,
                                                         guint index);

Description

Details

CouchdbArrayFieldClass

typedef struct {
	GObjectClass parent_class;
} CouchdbArrayFieldClass;


couchdb_array_field_new ()

CouchdbArrayField * couchdb_array_field_new             (void);

Create a new array field object.

Returns :

A newly-created CouchdbArrayField object.

couchdb_array_field_get_length ()

guint               couchdb_array_field_get_length      (CouchdbArrayField *array);

Get the number of elements on the given CouchdbArrayField object.

array :

A CouchdbArrayField object

Returns :

Number of elements in the given array.

couchdb_array_field_add_array_element ()

void                couchdb_array_field_add_array_element
                                                        (CouchdbArrayField *array,
                                                         const CouchdbArrayField *value);

Add a new element of type array to the given array.

array :

A CouchdbArrayField object

value :

Value to be added

couchdb_array_field_add_boolean_element ()

void                couchdb_array_field_add_boolean_element
                                                        (CouchdbArrayField *array,
                                                         gboolean value);

Add a new element of type boolean to the given array.

array :

A CouchdbArrayField object

value :

Value to be added

couchdb_array_field_add_double_element ()

void                couchdb_array_field_add_double_element
                                                        (CouchdbArrayField *array,
                                                         gdouble value);

Add a new element of type double to the given array.

array :

A CouchdbArrayField object

value :

Value to be added

couchdb_array_field_add_int_element ()

void                couchdb_array_field_add_int_element (CouchdbArrayField *array,
                                                         gint value);

Add a new element of type integer to the given array.

array :

A CouchdbArrayField object

value :

Value to be added

couchdb_array_field_add_string_element ()

void                couchdb_array_field_add_string_element
                                                        (CouchdbArrayField *array,
                                                         const gchar *value);

Add a new element of type string to the given array.

array :

A CouchdbArrayField object

value :

Value to be added

couchdb_array_field_add_struct_element ()

void                couchdb_array_field_add_struct_element
                                                        (CouchdbArrayField *array,
                                                         const CouchdbStructField *value);

Add a new element of type struct to the given array.

array :

A CouchdbArrayField object

value :

Value to be added

couchdb_array_field_remove_element ()

void                couchdb_array_field_remove_element  (CouchdbArrayField *array,
                                                         guint index);

Remove an element from the given CouchdbArrayField object.

array :

A CouchdbArrayField object

index :

Position of the element to remove

couchdb_array_field_get_array_element ()

CouchdbArrayField * couchdb_array_field_get_array_element
                                                        (CouchdbArrayField *array,
                                                         guint index);

Retrieve an array value on the given position of the array.

array :

A CouchdbArrayField object

index :

Position of the element to retrieve

Returns :

Value of the element stored in the given position of the array.

couchdb_array_field_get_boolean_element ()

gboolean            couchdb_array_field_get_boolean_element
                                                        (CouchdbArrayField *array,
                                                         guint index);

Retrieve a boolean value on the given position of the array.

array :

A CouchdbArrayField object

index :

Position of the element to retrieve

Returns :

Value of the element stored in the given position of the array.

couchdb_array_field_get_double_element ()

gdouble             couchdb_array_field_get_double_element
                                                        (CouchdbArrayField *array,
                                                         guint index);

Retrieve a double value on the given position of the array.

array :

A CouchdbArrayField object

index :

Position of the element to retrieve

Returns :

Value of the element stored in the given position of the array.

couchdb_array_field_get_int_element ()

gint                couchdb_array_field_get_int_element (CouchdbArrayField *array,
                                                         guint index);

Retrieve an integer value on the given position of the array.

array :

A CouchdbArrayField object

index :

Position of the element to retrieve

Returns :

Value of the element stored in the given position of the array.

couchdb_array_field_get_string_element ()

const gchar *       couchdb_array_field_get_string_element
                                                        (CouchdbArrayField *array,
                                                         guint index);

Retrieve a string value on the given position of the array.

array :

A CouchdbArrayField object

index :

Position of the element to retrieve

Returns :

Value of the element stored in the given position of the array.

couchdb_array_field_get_struct_element ()

CouchdbStructField * couchdb_array_field_get_struct_element
                                                        (CouchdbArrayField *array,
                                                         guint index);

Retrieve a struct value on the given position of the array.

array :

A CouchdbArrayField object

index :

Position of the element to retrieve

Returns :

Value of the element stored in the given position of the array.