# gda-parameter

## Name

gda-parameter -- Functions to manage parameters

## Synopsis

    typedef     GdaParameter;
    GdaParameter* gda_parameter_new             (const gchar *name,
                                                 GdaValueType type);
    GdaParameter* gda_parameter_new_gobject     (const gchar *name,
                                                 const GObject *value);
    GdaParameter* gda_parameter_new_string      (const gchar *name,
                                                 const gchar *value);
    void        gda_parameter_free              (GdaParameter *param);
    const gchar* gda_parameter_get_name         (GdaParameter *param);
    void        gda_parameter_set_name          (GdaParameter *param,
                                                 const gchar *name);
    const GdaValue* gda_parameter_get_value     (GdaParameter *param);
    void        gda_parameter_set_value         (GdaParameter *param,
                                                 GdaValue *value);
    struct      GdaParameterList;
    GdaParameterList* gda_parameter_list_new    (void);
    void        gda_parameter_list_free         (GdaParameterList *plist);
    void        gda_parameter_list_add_parameter
                                                (GdaParameterList *plist,
                                                 GdaParameter *param);
    GList*      gda_parameter_list_get_names    (GdaParameterList *plist);
    GdaParameter* gda_parameter_list_find       (GdaParameterList *plist,
                                                 const gchar *name);
    void        gda_parameter_list_clear        (GdaParameterList *plist);
    guint       gda_parameter_list_get_length   (GdaParameterList *plist);

## Description

## Details

### GdaParameter

    typedef struct {
    	gchar *name;
    	GdaValue *value;
    } GdaParameter;

### gda_parameter_new ()

    GdaParameter* gda_parameter_new             (const gchar *name,
                                                 GdaValueType type);

Create a new GdaParameter object, which is usually used with GdaParameterList.

`name` : | name for the parameter being created.
`type` : | GDA value type for this parameter.
Returns : | the newly created GdaParameter.

### gda_parameter_new_gobject ()

    GdaParameter* gda_parameter_new_gobject     (const gchar *name,
                                                 const GObject *value);

Create a new GdaParameter from a GObject.

`name` : | name for the parameter being created.
`value` : | a GObject value.
Returns : | the newly created GdaParameter.

### gda_parameter_new_string ()

    GdaParameter* gda_parameter_new_string      (const gchar *name,
                                                 const gchar *value);

Create a new GdaParameter from a string.

`name` : | name for the parameter being created.
`value` : | string value.
Returns : | the newly created GdaParameter.

### gda_parameter_free ()

    void        gda_parameter_free              (GdaParameter *param);

`param` : | the GdaParameter to be freed.

### gda_parameter_get_name ()

    const gchar* gda_parameter_get_name         (GdaParameter *param);

`param` : | a GdaParameter object.
Returns : | the name of the given GdaParameter.

### gda_parameter_set_name ()

    void        gda_parameter_set_name          (GdaParameter *param,
                                                 const gchar *name);

`param` : |
`name` : |

### gda_parameter_get_value ()

    const GdaValue* gda_parameter_get_value     (GdaParameter *param);

`param` : |
Returns : |

### gda_parameter_set_value ()

    void        gda_parameter_set_value         (GdaParameter *param,
                                                 GdaValue *value);

`param` : |
`value` : |

### struct GdaParameterList

    struct GdaParameterList;

### gda_parameter_list_new ()

    GdaParameterList* gda_parameter_list_new    (void);

Create a new GdaParameterList.

Returns : |

### gda_parameter_list_free ()

    void        gda_parameter_list_free         (GdaParameterList *plist);

`plist` : |

### gda_parameter_list_add_parameter ()

    void        gda_parameter_list_add_parameter
                                                (GdaParameterList *plist,
                                                 GdaParameter *param);

`plist` : |
`param` : |

### gda_parameter_list_get_names ()

    GList*      gda_parameter_list_get_names    (GdaParameterList *plist);

Get the names of all parameters in the parameter list.

`plist` : | a GdaParameterList.
Returns : | a GList containing the names of the parameters. After using it, you should free this list by calling g_list_free.

### gda_parameter_list_find ()

    GdaParameter* gda_parameter_list_find       (GdaParameterList *plist,
                                                 const gchar *name);

`plist` : |
`name` : |
Returns : |

### gda_parameter_list_clear ()

    void        gda_parameter_list_clear        (GdaParameterList *plist);

`plist` : |

### gda_parameter_list_get_length ()

    guint       gda_parameter_list_get_length   (GdaParameterList *plist);

`plist` : |
Returns : |