AranyaLabel Struct Reference

A label. More...

#include <aranya-client.h>

Related Symbols
(Note that these are not member symbols.)
AranyaError	aranya_label_cleanup (struct AranyaLabel *ptr)
	Releases any resources associated with ptr.
AranyaError	aranya_label_get_id (const struct AranyaLabel *label, struct AranyaLabelId *__output)
	Get ID of label.
AranyaError	aranya_label_get_name (const struct AranyaLabel *label, const char **__output)
	Get name of label.
AranyaError	aranya_label_get_author (const struct AranyaLabel *label, struct AranyaDeviceId *__output)
	Get the author of a label.

Detailed Description

A label.

Friends And Related Symbol Documentation

aranya_label_cleanup()

AranyaError aranya_label_cleanup ( struct AranyaLabel *  ptr )

related

Releases any resources associated with ptr.

ptr must either be null or initialized by ::aranya_label_init.

aranya_label_get_author()

AranyaError aranya_label_get_author ( const struct AranyaLabel *  label, struct AranyaDeviceId *  __output  )

related

Get the author of a label.

Parameters

[in]

label

the label

aranya_label_get_id()

AranyaError aranya_label_get_id ( const struct AranyaLabel *  label, struct AranyaLabelId *  __output  )

related

Get ID of label.

Parameters

[in]

label

the label

aranya_label_get_name()

AranyaError aranya_label_get_name ( const struct AranyaLabel *  label, const char **  __output  )

related

Get name of label.

The resulting string is null-terminated and must not be freed.

Parameters

[in]

label

the label

---

The documentation for this struct was generated from the following file:

• output/aranya-client.h