A structure defined as the type of the parameter nodesToBrowse of the Browse service. More...

#include <browsedescription.h>

Data Fields
struct ua_nodeid	node_id
	NodeId of the Node to be browsed. More...

enum ua_browsedirection	browse_direction
	An enumeration that specifies the direction of References to follow. More...

struct ua_nodeid	reference_type_id
	Specifies the NodeId of the ReferenceType to follow. More...

bool	include_subtypes
	Indicates whether subtypes of the ReferenceType should be included in the browse. More...

uint32_t	node_class_mask
	Specifies the NodeClasses of the TargetNodes. More...

uint32_t	result_mask
	Specifies the fields in the ReferenceDescription structure that should be returned. More...

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

void	ua_browsedescription_clear (struct ua_browsedescription *t)
	Clear all resources alloctated in an ua_browsedescription struct. More...

int	ua_browsedescription_compare (const struct ua_browsedescription a, const struct ua_browsedescription b)
	Compare two ua_browsedescription structs. More...

int	ua_browsedescription_copy (struct ua_browsedescription dst, const struct ua_browsedescription src)
	Create a copy of a ua_browsedescription struct. More...

Detailed Description

A structure defined as the type of the parameter nodesToBrowse of the Browse service.

Friends And Related Function Documentation

void ua_browsedescription_clear ( struct ua_browsedescription * t )

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

int ua_browsedescription_compare	(	const struct ua_browsedescription *	a,
		const struct ua_browsedescription *	b
	)

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

int ua_browsedescription_copy	(	struct ua_browsedescription *	dst,
		const struct ua_browsedescription *	src
	)

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

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

Field Documentation

browse_direction

An enumeration that specifies the direction of References to follow.

The returned references do indicate the direction the Server followed in the isForward parameter of the ReferenceDescription.

Symmetric references are always considered to be in forward direction, therefore the isForward flag is always set to TRUE and symmetric references are not returned if browseDirection is set to INVERSE_1.

include_subtypes

Indicates whether subtypes of the ReferenceType should be included in the browse.

If TRUE, then instances of referenceTypeId and all of its subtypes are returned.

node_class_mask

Specifies the NodeClasses of the TargetNodes.

Only TargetNodes with the selected NodeClasses are returned. The NodeClasses are assigned the following bits:

Bit	Node Class
0	Object
1	Variable
2	Method
3	ObjectType
4	VariableType
5	ReferenceType
6	DataType
7	View

If set to zero, then all NodeClasses are returned.

node_id

NodeId of the Node to be browsed.

If a view is provided, it shall include this Node.

reference_type_id

Specifies the NodeId of the ReferenceType to follow.

Only instances of this ReferenceType or its subtypes are returned.

If not specified, all References are returned and includeSubtypes is ignored.

result_mask

Specifies the fields in the ReferenceDescription structure that should be returned.

The fields are assigned the following bits:

Bit	Result
0	ReferenceType
1	IsForward
2	NodeClass
3	BrowseName
4	DisplayName
5	TypeDefinition

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

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

Data Fields

Related Functions

Detailed Description

Friends And Related Function Documentation

Field Documentation