Container - Redundant

Container - Redundant — A container class for Redundant subtag

Synopsis

lt_bool_t           lt_redundant_compare                (const lt_redundant_t *v1,
                                                         const lt_redundant_t *v2);
void                lt_redundant_dump                   (const lt_redundant_t *redundant);
const char *        lt_redundant_get_better_tag         (const lt_redundant_t *redundant);
const char *        lt_redundant_get_name               (const lt_redundant_t *redundant);
const char *        lt_redundant_get_preferred_tag      (const lt_redundant_t *redundant);
const char *        lt_redundant_get_tag                (const lt_redundant_t *redundant);
lt_redundant_t *    lt_redundant_ref                    (lt_redundant_t *redundant);
                    lt_redundant_t;
void                lt_redundant_unref                  (lt_redundant_t *redundant);

Description

This container class provides a data access to Redundant subtag entry.

Details

lt_redundant_compare ()

lt_bool_t           lt_redundant_compare                (const lt_redundant_t *v1,
                                                         const lt_redundant_t *v2);

Compare if v1 and v2 is the same object or not.

v1 :

a lt_redundant_t.

v2 :

a lt_redundant_t.

Returns :

TRUE if it's the same. otherwise FALSE.

lt_redundant_dump ()

void                lt_redundant_dump                   (const lt_redundant_t *redundant);

Dumps the container information to the standard output.

redundant :

a lt_redundant_t.

lt_redundant_get_better_tag ()

const char *        lt_redundant_get_better_tag         (const lt_redundant_t *redundant);

Obtains the better tag for use. this is a convenient function to get the preferred-value if available.

redundant :

a lt_redundant_t.

Returns :

a tag string.

lt_redundant_get_name ()

const char *        lt_redundant_get_name               (const lt_redundant_t *redundant);

Obtains the description of the tag.

redundant :

a lt_redundant_t.

Returns :

a description string.

lt_redundant_get_preferred_tag ()

const char *        lt_redundant_get_preferred_tag      (const lt_redundant_t *redundant);

Obtains the preferred-value. this is available only when the tag is marked as deprecated.

redundant :

a lt_redundant_t.

Returns :

a preferred-value for the tag or NULL.

lt_redundant_get_tag ()

const char *        lt_redundant_get_tag                (const lt_redundant_t *redundant);

Obtains the tag name.

redundant :

a lt_redundant_t.

Returns :

a tag string.

lt_redundant_ref ()

lt_redundant_t *    lt_redundant_ref                    (lt_redundant_t *redundant);

Increases the reference count of redundant.

redundant :

a lt_redundant_t.

Returns :

the same redundant object. [transfer none]

lt_redundant_t

typedef struct _lt_redundant_t lt_redundant_t;

All the fields in the lt_redundant_t structure are private to the lt_redundant_t implementation.


lt_redundant_unref ()

void                lt_redundant_unref                  (lt_redundant_t *redundant);

Decreases the reference count of redundant. when its reference count drops to 0, the object is finalized (i.e. its memory is freed).

redundant :

a lt_redundant_t.