Describes Annotation information for the history data items. More...

#include <annotation.h>

Data Fields
struct ua_string	message
	Annotation message or text.

struct ua_string	user_name
	The user that added the Annotation, as supplied by underlying system.

ua_datetime	annotation_time
	The time the Annotation was added. More...

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

void	ua_annotation_clear (struct ua_annotation *t)
	Clear all resources alloctated in an ua_annotation struct. More...

int	ua_annotation_compare (const struct ua_annotation a, const struct ua_annotation b)
	Compare two ua_annotation structs. More...

int	ua_annotation_copy (struct ua_annotation dst, const struct ua_annotation src)
	Create a copy of a ua_annotation struct. More...

Detailed Description

Describes Annotation information for the history data items.

Friends And Related Function Documentation

void ua_annotation_clear ( struct ua_annotation * t )

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

int ua_annotation_compare	(	const struct ua_annotation *	a,
		const struct ua_annotation *	b
	)

Compares the content of the ua_annotation struct a to the content of the ua_annotation 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_annotation structs, so it is well suited to not only determine equality, but also sort multiple instances of this struct.

int ua_annotation_copy	(	struct ua_annotation *	dst,
		const struct ua_annotation *	src
	)

Copy all fields from struct ua_annotation 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_annotation_init ( struct ua_annotation * t )

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

Field Documentation

annotation_time

The time the Annotation was added.

This will probably be different than the SourceTimestamp.

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

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

Data Fields

Related Functions

Detailed Description

Friends And Related Function Documentation

Field Documentation