Reference parameters returned for the Browse Service. More...

#include <referencedescription.h>

Data Fields
struct ua_nodeid	reference_type_id
	NodeId of the ReferenceType that defines the Reference.

bool	is_forward
	If the value is TRUE, the Server followed a forward Reference. More...

struct ua_expandednodeid	node_id
	NodeId of the TargetNode as assigned by the Server identified by the Server index. More...

struct ua_qualifiedname	browse_name
	The BrowseName of the TargetNode.

struct ua_localizedtext	display_name
	The DisplayName of the TargetNode.

enum ua_nodeclass	node_class
	NodeClass of the TargetNode.

struct ua_expandednodeid	type_definition
	Type definition NodeId of the TargetNode. More...

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

void	ua_referencedescription_clear (struct ua_referencedescription *t)
	Clear all resources alloctated in an ua_referencedescription struct. More...

int	ua_referencedescription_compare (const struct ua_referencedescription a, const struct ua_referencedescription b)
	Compare two ua_referencedescription structs. More...

int	ua_referencedescription_copy (struct ua_referencedescription dst, const struct ua_referencedescription src)
	Create a copy of a ua_referencedescription struct. More...

Detailed Description

Reference parameters returned for the Browse Service.

Friends And Related Function Documentation

void ua_referencedescription_clear ( struct ua_referencedescription * t )

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

int ua_referencedescription_compare	(	const struct ua_referencedescription *	a,
		const struct ua_referencedescription *	b
	)

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

int ua_referencedescription_copy	(	struct ua_referencedescription *	dst,
		const struct ua_referencedescription *	src
	)

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

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

Field Documentation

is_forward

If the value is TRUE, the Server followed a forward Reference.

If the value is FALSE, the Server followed an inverse Reference.

node_id

NodeId of the TargetNode as assigned by the Server identified by the Server index.

If the serverIndex indicates that the TargetNode is a remote Node, then the nodeId shall contain the absolute namespace URI. If the TargetNode is a local Node the nodeId shall contain the namespace index.

type_definition

Type definition NodeId of the TargetNode.

Type definitions are only available for the NodeClasses object and Variable. For all other NodeClasses a null NodeId shall be returned.

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

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

Data Fields

Related Functions

Detailed Description

Friends And Related Function Documentation

Field Documentation