Data Fields
ua_statuscode *	add_results
	List of StatusCodes for the items to add. More...

int32_t	num_add_results
	Number of elements in ua_settriggeringresponse::add_results.

struct ua_diagnosticinfo *	add_diag_infos
	List of diagnostic information for the links to add. More...

int32_t	num_add_diag_infos
	Number of elements in ua_settriggeringresponse::add_diag_infos.

ua_statuscode *	remove_results
	List of StatusCodes for the items to delete. More...

int32_t	num_remove_results
	Number of elements in ua_settriggeringresponse::remove_results.

struct ua_diagnosticinfo *	remove_diag_infos
	List of diagnostic information for the links to delete. More...

int32_t	num_remove_diag_infos
	Number of elements in ua_settriggeringresponse::remove_diag_infos.

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

void	ua_settriggeringresponse_clear (struct ua_settriggeringresponse *t)
	Clear all resources alloctated in an ua_settriggeringresponse struct. More...

int	ua_settriggeringresponse_compare (const struct ua_settriggeringresponse a, const struct ua_settriggeringresponse b)
	Compare two ua_settriggeringresponse structs. More...

int	ua_settriggeringresponse_copy (struct ua_settriggeringresponse dst, const struct ua_settriggeringresponse src)
	Create a copy of a ua_settriggeringresponse struct. More...

static int	ua_settriggeringresponse_resize_add_results_array (struct ua_settriggeringresponse *val, int32_t new_len)
	Resize the add_results array of a ua_settriggeringresponse struct. More...

static int	ua_settriggeringresponse_resize_add_diag_infos_array (struct ua_settriggeringresponse *val, int32_t new_len)
	Resize the add_diag_infos array of a ua_settriggeringresponse struct. More...

static int	ua_settriggeringresponse_resize_remove_results_array (struct ua_settriggeringresponse *val, int32_t new_len)
	Resize the remove_results array of a ua_settriggeringresponse struct. More...

static int	ua_settriggeringresponse_resize_remove_diag_infos_array (struct ua_settriggeringresponse *val, int32_t new_len)
	Resize the remove_diag_infos array of a ua_settriggeringresponse struct. More...

Friends And Related Function Documentation

void ua_settriggeringresponse_clear ( struct ua_settriggeringresponse * t )

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

int ua_settriggeringresponse_compare	(	const struct ua_settriggeringresponse *	a,
		const struct ua_settriggeringresponse *	b
	)

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

int ua_settriggeringresponse_copy	(	struct ua_settriggeringresponse *	dst,
		const struct ua_settriggeringresponse *	src
	)

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

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

static int ua_settriggeringresponse_resize_add_diag_infos_array	(	struct ua_settriggeringresponse *	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 add_diag_infos array in number of members.

Returns: Zero on success or ua_statuscode on failure.

static int ua_settriggeringresponse_resize_add_results_array	(	struct ua_settriggeringresponse *	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 add_results array in number of members.

Returns: Zero on success or ua_statuscode on failure.

static int ua_settriggeringresponse_resize_remove_diag_infos_array	(	struct ua_settriggeringresponse *	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 remove_diag_infos array in number of members.

Returns: Zero on success or ua_statuscode on failure.

static int ua_settriggeringresponse_resize_remove_results_array	(	struct ua_settriggeringresponse *	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 remove_results array in number of members.

Returns: Zero on success or ua_statuscode on failure.

Field Documentation

add_diag_infos

List of diagnostic information for the links to add.

The size and order of the list matches the size and order of the request parameter. 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.

add_results

List of StatusCodes for the items to add.

The size and order of the list matches the size and order of the ua_SetTriggeringRequest::links_to_add parameter specified in the request.

remove_diag_infos

List of diagnostic information for the links to delete.

The size and order of the list matches the size and order of the request parameter. 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.

remove_results

List of StatusCodes for the items to delete.

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

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

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

Data Fields

Related Functions

Friends And Related Function Documentation

Field Documentation