A structure that is defined as the type of the results parameter of the HistoryUpdate Service. More...

#include <historyupdateresult.h>

Data Fields
ua_statuscode	status_code
	StatusCode for the update of the node.

ua_statuscode *	operation_results
	List of StatusCodes for the operations to be performed on a node. More...

int32_t	num_operation_results
	Number of elements in ua_historyupdateresult::operation_results.

struct ua_diagnosticinfo *	diag_infos
	List of diagnostic information for the operations to be performed on a node. More...

int32_t	num_diag_infos
	Number of elements in ua_historyupdateresult::diag_infos.

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

void	ua_historyupdateresult_clear (struct ua_historyupdateresult *t)
	Clear all resources alloctated in an ua_historyupdateresult struct. More...

int	ua_historyupdateresult_compare (const struct ua_historyupdateresult a, const struct ua_historyupdateresult b)
	Compare two ua_historyupdateresult structs. More...

int	ua_historyupdateresult_copy (struct ua_historyupdateresult dst, const struct ua_historyupdateresult src)
	Create a copy of a ua_historyupdateresult struct. More...

static int	ua_historyupdateresult_resize_operation_results_array (struct ua_historyupdateresult *val, int32_t new_len)
	Resize the operation_results array of a ua_historyupdateresult struct. More...

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

Detailed Description

A structure that is defined as the type of the results parameter of the HistoryUpdate Service.

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

Friends And Related Function Documentation

void ua_historyupdateresult_clear ( struct ua_historyupdateresult * t )

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

int ua_historyupdateresult_compare	(	const struct ua_historyupdateresult *	a,
		const struct ua_historyupdateresult *	b
	)

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

int ua_historyupdateresult_copy	(	struct ua_historyupdateresult *	dst,
		const struct ua_historyupdateresult *	src
	)

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

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

static int ua_historyupdateresult_resize_diag_infos_array	(	struct ua_historyupdateresult *	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_historyupdateresult_resize_operation_results_array	(	struct ua_historyupdateresult *	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 operation_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 operations to be performed on a node.

The size and order of the list matches the size and order of any list defined by the details element being reported by this updateResults entry. 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.

operation_results

List of StatusCodes for the operations to be performed on a node.

The size and order of the list matches the size and order of any list defined by the details element being reported by this updateResults entry.

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

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

Data Fields

Related Functions

Detailed Description

Friends And Related Function Documentation

Field Documentation