Defines a sequence of References and BrowseNames to follow. More...

#include <relativepath.h>

Data Fields
struct ua_relativepathelement *	elements
	A sequence of References and BrowseNames to follow.

int32_t	num_elements
	Number of elements in ua_relativepath::elements.

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

void	ua_relativepath_clear (struct ua_relativepath *t)
	Clear all resources alloctated in an ua_relativepath struct. More...

int	ua_relativepath_compare (const struct ua_relativepath a, const struct ua_relativepath b)
	Compare two ua_relativepath structs. More...

int	ua_relativepath_copy (struct ua_relativepath dst, const struct ua_relativepath src)
	Create a copy of a ua_relativepath struct. More...

static int	ua_relativepath_resize_elements_array (struct ua_relativepath *val, int32_t new_len)
	Resize the elements array of a ua_relativepath struct. More...

Detailed Description

Defines a sequence of References and BrowseNames to follow.

Friends And Related Function Documentation

void ua_relativepath_clear ( struct ua_relativepath * t )

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

int ua_relativepath_compare	(	const struct ua_relativepath *	a,
		const struct ua_relativepath *	b
	)

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

int ua_relativepath_copy	(	struct ua_relativepath *	dst,
		const struct ua_relativepath *	src
	)

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

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

static int ua_relativepath_resize_elements_array	(	struct ua_relativepath *	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 elements array in number of members.

Returns: Zero on success or ua_statuscode on failure.

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

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

Data Fields

Related Functions

Detailed Description

Friends And Related Function Documentation