GdaQueryFieldAgg

## GdaQueryFieldAgg GdaQueryFieldAgg — |

## Synopsis

                GdaQueryFieldAgg;
    GObject*    gda_query_field_agg_new         (GdaQuery *query,
                                                 const gchar *agg_name);
    GdaDictAggregate* gda_query_field_agg_get_ref_agg
                                                (GdaQueryFieldAgg *agg);
    gboolean    gda_query_field_agg_set_arg     (GdaQueryFieldAgg *agg,
                                                 GdaQueryField *arg);

## Object Hierarchy

      GObject
       +----GdaObject
             +----GdaQueryObject
                   +----GdaQueryField
                         +----GdaQueryFieldAgg

## Implemented Interfaces

GdaQueryFieldAgg implements GdaXmlStorage, GdaReferer, GdaEntityField and GdaRenderer.

## Properties

      "aggregate"            gpointer              : Read / Write
      "aggregate-id"         gchararray            : Write
      "aggregate-name"       gchararray            : Write
      "query"                gpointer              : Read / Write / Construct Only

## Description

## Details

### GdaQueryFieldAgg

    typedef struct _GdaQueryFieldAgg GdaQueryFieldAgg;

### gda_query_field_agg_new ()

    GObject*    gda_query_field_agg_new         (GdaQuery *query,
                                                 const gchar *agg_name);

Creates a new GdaQueryFieldAgg object which represents the `agg` aggregate

`query` : | a GdaQuery in which the new object will be
`agg_name` : | the name of an aggregate to represent
Returns : | the new object

### gda_query_field_agg_get_ref_agg ()

    GdaDictAggregate* gda_query_field_agg_get_ref_agg
                                                (GdaQueryFieldAgg *agg);

Get the real GdaDictAggregate object used by `agg`

`agg` : | a GdaQueryFieldAgg object
Returns : | the GdaDictAggregate object, or NULL if `agg` is not active

### gda_query_field_agg_set_arg ()

    gboolean    gda_query_field_agg_set_arg     (GdaQueryFieldAgg *agg,
                                                 GdaQueryField *arg);

Sets the argument of `agg`. If `arg` is `NULL`, then the argument (if there was one) is removed.

If `agg` is not active, then no check on the provided arg is performed.

`agg` : | a GdaQueryFieldAgg object
`arg` : | a GdaQueryField object
Returns : | TRUE if no error occurred

## Properties

### The "`aggregate`" property

      "aggregate"            gpointer              : Read / Write

### The "`aggregate-id`" property

      "aggregate-id"         gchararray            : Write

Default value: NULL

### The "`aggregate-name`" property

      "aggregate-name"       gchararray            : Write

Default value: NULL

### The "`query`" property

      "query"                gpointer              : Read / Write / Construct Only