## GdaQueryFieldAgg

GdaQueryFieldAgg — Represents a function (selected by a GdaDictAggregate object)

## Synopsis

                        GdaQueryFieldAgg;
    GdaQueryField*      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"                GdaDictAggregate*     : Read / Write
      "aggregate-id"             gchar*                : Write
      "aggregate-name"           gchar*                : Write
      "query"                    GdaQuery*             : Read / Write / Construct Only

## Description

## Details

### GdaQueryFieldAgg

    typedef struct _GdaQueryFieldAgg GdaQueryFieldAgg;

### gda_query_field_agg_new ()

    GdaQueryField*      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

## Property Details

### The `"aggregate"` property

      "aggregate"                GdaDictAggregate*     : Read / Write

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

      "aggregate-id"             gchar*                : Write

Default value: NULL

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

      "aggregate-name"           gchar*                : Write

Default value: NULL

### The `"query"` property

      "query"                    GdaQuery*             : Read / Write / Construct Only