Data Fields
struct ua_variant *	event_fields
	List of selected Event fields. More...

int32_t	num_event_fields
	Number of elements in ua_historyeventfieldlist::event_fields.

Related Functions
void	ua_historyeventfieldlist_init (struct ua_historyeventfieldlist *t)
	Initialize an ua_historyeventfieldlist struct with a valid value. More...

void	ua_historyeventfieldlist_clear (struct ua_historyeventfieldlist *t)
	Clear all resources alloctated in an ua_historyeventfieldlist struct. More...

int	ua_historyeventfieldlist_compare (const struct ua_historyeventfieldlist a, const struct ua_historyeventfieldlist b)
	Compare two ua_historyeventfieldlist structs. More...

int	ua_historyeventfieldlist_copy (struct ua_historyeventfieldlist dst, const struct ua_historyeventfieldlist src)
	Create a copy of a ua_historyeventfieldlist struct. More...

static int	ua_historyeventfieldlist_resize_event_fields_array (struct ua_historyeventfieldlist *val, int32_t new_len)
	Resize the event_fields array of a ua_historyeventfieldlist struct. More...

Friends And Related Function Documentation

void ua_historyeventfieldlist_clear ( struct ua_historyeventfieldlist * t )

Frees allocated memory like arrays and resets numeric values. The ua_historyeventfieldlist struct itself is not freed and must be freed by the caller if required. This function always succeeds for a valid ua_historyeventfieldlist struct, that was validly decoded, initilized by ua_historyeventfieldlist_init or created with ua_historyeventfieldlist_copy.

int ua_historyeventfieldlist_compare	(	const struct ua_historyeventfieldlist *	a,
		const struct ua_historyeventfieldlist *	b
	)

Compares the content of the ua_historyeventfieldlist struct a to the content of the ua_historyeventfieldlist struct b. If a is smaller than b, an integer less than zero is returned, if a is bigger than b, an integer greater than zero is returned. If both structs are equal zero is returned.

This function creates a total order on ua_historyeventfieldlist structs, so it is well suited to not only determine equality, but also sort multiple instances of this struct.

int ua_historyeventfieldlist_copy	(	struct ua_historyeventfieldlist *	dst,
		const struct ua_historyeventfieldlist *	src
	)

Copy all fields from struct ua_historyeventfieldlist src to dst. Creates a deep copy so all content is recusively copied and both src and dst can be used and must be freed separately.

dst is not cleared before the copy operation, so it must not have any allocated data. It may or may not be initilized by the caller before copy.

Returns: Zero on success or ua_statuscode on failure.

void ua_historyeventfieldlist_init ( struct ua_historyeventfieldlist * t )

After initialization the fields of the struct are set to valid and consistent values and can safley be accessed. An initialized ua_historyeventfieldlist struct can also be passed to ua_historyeventfieldlist_compare, ua_historyeventfieldlist_copy and ua_historyeventfieldlist_clear. This function will always succeed as long as an ua_historyeventfieldlist struct is passed to it.

static int ua_historyeventfieldlist_resize_event_fields_array	(	struct ua_historyeventfieldlist *	val,
		int32_t	new_len
	)

Depending on new_len and the current size of the array, the array will be created, increased, decreased or deleted. In case array members are removed these are cleared properly, new array members are initialized with zero.

Parameters

new_len New length of the event_fields array in number of members.

Returns: Zero on success or ua_statuscode on failure.

Field Documentation

event_fields

List of selected Event fields.

This will be a one to one match with the fields selected in the EventFilter.

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

C:/work/embeddedstack/src/uabase/structure/historyeventfieldlist.h
C:/work/embeddedstack/src/uabase/structure/historyeventfieldlist.c

Data Fields

Related Functions

Friends And Related Function Documentation

Field Documentation