ArvGcString: Aravis Reference Manual

ArvGcString

ArvGcString — String interface

Functions

const char *	arv_gc_string_get_value ()
void	arv_gc_string_set_value ()
gint64	arv_gc_string_get_max_length ()

Types and Values

ArvGcString

Object Hierarchy

    GInterface
    ╰── ArvGcString

Prerequisites

ArvGcString requires GObject.

Known Implementations

ArvGcString is implemented by ArvGcEnumeration and ArvGcStringRegNode.

Description

Functions

arv_gc_string_get_value ()

const char *
arv_gc_string_get_value (ArvGcString *gc_string,
                         GError **error);

Please note the string content is still owned by the gc_string object, which means the returned pointer may not be still valid after a new call to this function.

Parameters

gc_string	an object implementing ArvGcString
error	a GError placeholder, or `NULL` to ignore

Returns

the string value.

arv_gc_string_set_value ()

void
arv_gc_string_set_value (ArvGcString *gc_string,
                         const char *value,
                         GError **error);

Set value as the new gc_string value.

Parameters

gc_string	an object implementing ArvGcString
value	new string value
error	a GError placeholder, or `NULL` to ignore

arv_gc_string_get_max_length ()

gint64
arv_gc_string_get_max_length (ArvGcString *gc_string,
                              GError **error);

Parameters

gc_string	an object implementing ArvGcString
error	a GError placeholder, or `NULL` to ignore

Returns

the maximum length gc_string can store, excluding the NULL terminal character.

Types and Values

ArvGcString

typedef struct _ArvGcString ArvGcString;