GdaQueryFieldFunc

GdaQueryFieldFunc — Represents a function (selected by a GdaDictFunction object)

Functions

Properties

GdaDictFunction * function Read / Write
gchar * function-id Write
gchar * function-name Write
GdaQuery * query Read / Write / Construct Only

Types and Values

Object Hierarchy

    GObject
    ╰── GdaObject
        ╰── GdaQueryObject
            ╰── GdaQueryField
                ╰── GdaQueryFieldFunc

Implemented Interfaces

GdaQueryFieldFunc implements GdaXmlStorage, GdaEntityField, GdaRenderer and GdaReferer.

Description

The function is applied to zero or more GdaQueryField objects of the same query

Functions

gda_query_field_func_new ()

GdaQueryField *
gda_query_field_func_new (GdaQuery *query,
                          const gchar *func_name);

Creates a new GdaQueryFieldFunc object which represents the func_name function

Parameters

query

a GdaQuery in which the new object will be

 

func_name

the name of the function to use

 

Returns

the new object


gda_query_field_func_get_ref_func ()

GdaDictFunction *
gda_query_field_func_get_ref_func (GdaQueryFieldFunc *func);

Get the name of the function which func represents

Parameters

func

a GdaQueryFieldFunc object

 

Returns

the function name


gda_query_field_func_get_ref_func_name ()

const gchar *
gda_query_field_func_get_ref_func_name
                               (GdaQueryFieldFunc *func);

Returns


gda_query_field_func_set_args ()

gboolean
gda_query_field_func_set_args (GdaQueryFieldFunc *func,
                               GSList *args);

Sets the argument(s) of func . If args is NULL, then all the arguments (if there was any) are removed.

If func is not active, then no check on the provided args is performed.

Parameters

func

a GdaQueryFieldFunc object

 

args

a list of GdaQueryField objects

 

Returns

TRUE if no error occurred


gda_query_field_func_get_args ()

GSList *
gda_query_field_func_get_args (GdaQueryFieldFunc *func);

Get a list of the other GdaQueryField objects which are arguments of func . If some of them are missing, then a NULL is inserted where it should have been.

Parameters

func

a GdaQueryFieldFunc object

 

Returns

a new list of arguments

Types and Values

GdaQueryFieldFunc

typedef struct _GdaQueryFieldFunc GdaQueryFieldFunc;

Property Details

The “function” property

  “function”                 GdaDictFunction *

Flags: Read / Write


The “function-id” property

  “function-id”              gchar *

Flags: Write

Default value: NULL


The “function-name” property

  “function-name”            gchar *

Flags: Write

Default value: NULL


The “query” property

  “query”                    GdaQuery *

Flags: Read / Write / Construct Only