ArvGcEnumeration: Aravis Reference Manual

ArvGcEnumeration

ArvGcEnumeration — Class for Enumeration nodes

Functions

ArvGcNode *	arv_gc_enumeration_new ()
const char *	arv_gc_enumeration_get_string_value ()
gboolean	arv_gc_enumeration_set_string_value ()
gint64	arv_gc_enumeration_get_int_value ()
gboolean	arv_gc_enumeration_set_int_value ()
const GSList *	arv_gc_enumeration_get_entries ()
gint64 *	arv_gc_enumeration_dup_available_int_values ()
const char **	arv_gc_enumeration_dup_available_string_values ()
const char **	arv_gc_enumeration_dup_available_display_names ()

Types and Values

ArvGcEnumeration

Object Hierarchy

    GObject
    ╰── ArvDomNode
        ╰── ArvDomElement
            ╰── ArvGcNode
                ╰── ArvGcFeatureNode
                    ╰── ArvGcEnumeration

Implemented Interfaces

ArvGcEnumeration implements ArvGcInteger, ArvGcString and ArvGcSelector.

Description

Functions

arv_gc_enumeration_new ()

ArvGcNode *
arv_gc_enumeration_new (void);

arv_gc_enumeration_get_string_value ()

const char *
arv_gc_enumeration_get_string_value (ArvGcEnumeration *enumeration,
                                     GError **error);

arv_gc_enumeration_set_string_value ()

gboolean
arv_gc_enumeration_set_string_value (ArvGcEnumeration *enumeration,
                                     const char *value,
                                     GError **error);

arv_gc_enumeration_get_int_value ()

gint64
arv_gc_enumeration_get_int_value (ArvGcEnumeration *enumeration,
                                  GError **error);

arv_gc_enumeration_set_int_value ()

gboolean
arv_gc_enumeration_set_int_value (ArvGcEnumeration *enumeration,
                                  gint64 value,
                                  GError **error);

arv_gc_enumeration_get_entries ()

const GSList *
arv_gc_enumeration_get_entries (ArvGcEnumeration *enumeration);

Parameters

enumeration

a ArvGcEnumeration

Returns

the list of enumeration entry nodes.

[element-type ArvGcFeatureNode][transfer none]

arv_gc_enumeration_dup_available_int_values ()

gint64 *
arv_gc_enumeration_dup_available_int_values
                               (ArvGcEnumeration *enumeration,
                                guint *n_values,
                                GError **error);

Parameters

enumeration	a ArvGcEnumeration
n_values	the number of values.	[out]
error	the error that occured, or NULL.	[out]

Returns

a newly allocated array of 64 bit integers, to be freed after use using g_free().

[transfer full][array length=n_values]

Since: 0.8.0

arv_gc_enumeration_dup_available_string_values ()

const char **
arv_gc_enumeration_dup_available_string_values
                               (ArvGcEnumeration *enumeration,
                                guint *n_values,
                                GError **error);

Create an array of all available values of enumeration , as strings.

Parameters

enumeration	an ArvGcEnumeration
n_values	placeholder for the number of values.	[out]
error	placeholder for error, may be NULL

Returns

an newly created array of const strings, which must freed after use using g_free, NULL on error.

[array length=n_values][transfer container]

Since: 0.8.0

arv_gc_enumeration_dup_available_display_names ()

const char **
arv_gc_enumeration_dup_available_display_names
                               (ArvGcEnumeration *enumeration,
                                guint *n_values,
                                GError **error);

Create an array of display names of all available entries.

Parameters

enumeration	an ArvGcEnumeration
n_values	placeholder for the number of values.	[out]
error	placeholder for error, may be NULL

Returns

an newly created array of const strings, which must freed after use using g_free, NULL on error.

[array length=n_values][transfer container]

Since: 0.8.0

Types and Values

ArvGcEnumeration

typedef struct _ArvGcEnumeration ArvGcEnumeration;