A structure that is defined as the type of the nodesToDelete parameter of the DeleteNodes Service. More...

#include <deletenodesitem.h>

Data Fields
struct ua_nodeid	node_id
	NodeId of the node to delete.

bool	delete_target_references
	A boolean parameter indicating whether to delete references for which the node to delete is the target node. More...

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

void	ua_deletenodesitem_clear (struct ua_deletenodesitem *t)
	Clear all resources alloctated in an ua_deletenodesitem struct. More...

int	ua_deletenodesitem_compare (const struct ua_deletenodesitem a, const struct ua_deletenodesitem b)
	Compare two ua_deletenodesitem structs. More...

int	ua_deletenodesitem_copy (struct ua_deletenodesitem dst, const struct ua_deletenodesitem src)
	Create a copy of a ua_deletenodesitem struct. More...

Detailed Description

A structure that is defined as the type of the nodesToDelete parameter of the DeleteNodes Service.

Friends And Related Function Documentation

void ua_deletenodesitem_clear ( struct ua_deletenodesitem * t )

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

int ua_deletenodesitem_compare	(	const struct ua_deletenodesitem *	a,
		const struct ua_deletenodesitem *	b
	)

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

int ua_deletenodesitem_copy	(	struct ua_deletenodesitem *	dst,
		const struct ua_deletenodesitem *	src
	)

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

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

Field Documentation

delete_target_references

A boolean parameter indicating whether to delete references for which the node to delete is the target node.

It has the following values:

TRUE: delete References in TargetNodes that Reference the Node to delete.
FALSE: delete only the References for which the Node to delete is the source.

The Server cannot guarantee that it is able to delete all references from target nodes if this parameter is TRUE.

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

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

Data Fields

Related Functions

Detailed Description

Friends And Related Function Documentation

Field Documentation