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

#include <addnodesresult.h>

Data Fields
ua_statuscode	status_code
	StatusCode for the node to add.

struct ua_nodeid	added_node_id
	Server assigned NodeId of the added node. More...

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

void	ua_addnodesresult_clear (struct ua_addnodesresult *t)
	Clear all resources alloctated in an ua_addnodesresult struct. More...

int	ua_addnodesresult_compare (const struct ua_addnodesresult a, const struct ua_addnodesresult b)
	Compare two ua_addnodesresult structs. More...

int	ua_addnodesresult_copy (struct ua_addnodesresult dst, const struct ua_addnodesresult src)
	Create a copy of a ua_addnodesresult struct. More...

Detailed Description

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

Friends And Related Function Documentation

void ua_addnodesresult_clear ( struct ua_addnodesresult * t )

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

int ua_addnodesresult_compare	(	const struct ua_addnodesresult *	a,
		const struct ua_addnodesresult *	b
	)

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

int ua_addnodesresult_copy	(	struct ua_addnodesresult *	dst,
		const struct ua_addnodesresult *	src
	)

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

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

Field Documentation

added_node_id

Server assigned NodeId of the added node.

Null NodeId if the operation failed.

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

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

Data Fields

Related Functions

Detailed Description

Friends And Related Function Documentation

Field Documentation