A structure that is defined as the type of the browsePaths parameter of the TranslateBrowsePathsToNodeIds service. More...

#include <browsepath.h>

Data Fields
struct ua_nodeid	starting_node
	NodeId of the starting Node for the browse path.

struct ua_relativepath	relative_path
	The path to follow from the startingNode. More...

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

void	ua_browsepath_clear (struct ua_browsepath *t)
	Clear all resources alloctated in an ua_browsepath struct. More...

int	ua_browsepath_compare (const struct ua_browsepath a, const struct ua_browsepath b)
	Compare two ua_browsepath structs. More...

int	ua_browsepath_copy (struct ua_browsepath dst, const struct ua_browsepath src)
	Create a copy of a ua_browsepath struct. More...

Detailed Description

A structure that is defined as the type of the browsePaths parameter of the TranslateBrowsePathsToNodeIds service.

Friends And Related Function Documentation

void ua_browsepath_clear ( struct ua_browsepath * t )

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

int ua_browsepath_compare	(	const struct ua_browsepath *	a,
		const struct ua_browsepath *	b
	)

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

int ua_browsepath_copy	(	struct ua_browsepath *	dst,
		const struct ua_browsepath *	src
	)

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

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

Field Documentation

relative_path

The path to follow from the startingNode.

The last element in the relativePath shall always have a targetName specified. This further restricts the definition of the RelativePath type. The Server shall return Bad_BrowseNameInvalid if the targetName is missing.

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

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

Data Fields

Related Functions

Detailed Description

Friends And Related Function Documentation

Field Documentation