Data Fields
struct ua_historyupdateresult *	results
	List of update results for the history update details. More...

int32_t	num_results
	Number of elements in ua_historyupdateresponse::results.

struct ua_diagnosticinfo *	diag_infos
	List of diagnostic information for the history update details. More...

int32_t	num_diag_infos
	Number of elements in ua_historyupdateresponse::diag_infos.

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

void	ua_historyupdateresponse_clear (struct ua_historyupdateresponse *t)
	Clear all resources alloctated in an ua_historyupdateresponse struct. More...

int	ua_historyupdateresponse_compare (const struct ua_historyupdateresponse a, const struct ua_historyupdateresponse b)
	Compare two ua_historyupdateresponse structs. More...

int	ua_historyupdateresponse_copy (struct ua_historyupdateresponse dst, const struct ua_historyupdateresponse src)
	Create a copy of a ua_historyupdateresponse struct. More...

static int	ua_historyupdateresponse_resize_results_array (struct ua_historyupdateresponse *val, int32_t new_len)
	Resize the results array of a ua_historyupdateresponse struct. More...

static int	ua_historyupdateresponse_resize_diag_infos_array (struct ua_historyupdateresponse *val, int32_t new_len)
	Resize the diag_infos array of a ua_historyupdateresponse struct. More...

Friends And Related Function Documentation

void ua_historyupdateresponse_clear ( struct ua_historyupdateresponse * t )

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

int ua_historyupdateresponse_compare	(	const struct ua_historyupdateresponse *	a,
		const struct ua_historyupdateresponse *	b
	)

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

int ua_historyupdateresponse_copy	(	struct ua_historyupdateresponse *	dst,
		const struct ua_historyupdateresponse *	src
	)

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

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

static int ua_historyupdateresponse_resize_diag_infos_array	(	struct ua_historyupdateresponse *	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 diag_infos array in number of members.

Returns: Zero on success or ua_statuscode on failure.

static int ua_historyupdateresponse_resize_results_array	(	struct ua_historyupdateresponse *	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 results array in number of members.

Returns: Zero on success or ua_statuscode on failure.

Field Documentation

diag_infos

List of diagnostic information for the history update details.

The size and order of the list matches the size and order of the details element of the historyUpdateDetails parameter specified in the request. This list is empty if diagnostics information was not requested in the request header or if no diagnostic information was encountered in processing of the request.

results

List of update results for the history update details.

The size and order of the list matches the size and order of the details element of the historyUpdateDetails parameter specified in the request.

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

C:/work/embeddedstack/src/uabase/service/historyupdateresponse.h
C:/work/embeddedstack/src/uabase/service/historyupdateresponse.c

Data Fields

Related Functions

Friends And Related Function Documentation

Field Documentation