Nyx Text Message

Collaboration diagram for Nyx Text Message:

Functions
nyx_dict_t *	nyx_text_prop_new (STR_t name, __NYX_NULLABLE__ STR_t label, __NYX_NULLABLE__ STR_t value, bool managed)
	Allocates a new INDI / Nyx text property.
bool	nyx_text_prop_set (const nyx_dict_t *prop, __NYX_NULLABLE__ STR_t value, bool managed)
	Sets the text value of the provided property object.
STR_t	nyx_text_prop_get (const nyx_dict_t *prop)
	Gets the text value of the provided property object.
nyx_dict_t *	nyx_text_vector_new (STR_t device, STR_t name, nyx_state_t state, nyx_perm_t perm, nyx_dict_t *props[], __NYX_NULLABLE__ const nyx_opts_t *opts)
	Allocates a new INDI / Nyx text vector.

Detailed Description

Nyx Text Message

Function Documentation

nyx_text_prop_new()

nyx_dict_t * nyx_text_prop_new	(	STR_t	name,
		__NYX_NULLABLE__ STR_t	label,
		__NYX_NULLABLE__ STR_t	value,
		bool	managed )

Allocates a new INDI / Nyx text property.

Parameters

name	Property name.
label	Property label.
value	Initial text value.
managed	If true, ownership of the provided value is transferred to the property object.

Returns

The new property object.

nyx_text_prop_set()

bool nyx_text_prop_set	(	const nyx_dict_t *	prop,
		__NYX_NULLABLE__ STR_t	value,
		bool	managed )

Sets the text value of the provided property object.

Parameters

prop	Property object.
value	Text value.
managed	If true, ownership of the provided value is transferred to the property object.

Returns

true if the value was modified, false otherwise.

nyx_text_prop_get()

STR_t nyx_text_prop_get

(

const nyx_dict_t *

prop

)

Gets the text value of the provided property object.

Parameters

prop	Property object.

Returns

The text value.

Note

The returned text value remains valid until the property object is modified or released.

Definition at line 70 of file indi_text.c.

nyx_text_vector_new()

nyx_dict_t * nyx_text_vector_new	(	STR_t	device,
		STR_t	name,
		nyx_state_t	state,
		nyx_perm_t	perm,
		nyx_dict_t *	props[],
		__NYX_NULLABLE__ const nyx_opts_t *	opts )

Allocates a new INDI / Nyx text vector.

Parameters

device	Device name.
name	Vector name.
state	Vector state.
perm	Vector permissions.
props	Array of properties with NULL sentinel.
opts	Options (group, label, hints, timeout, message).

Returns

The new vector object.