High Performance OPC UA Server SDK  1.1.0.158
ua_browsepathresult Struct Reference

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

#include <browsepathresult.h>

Data Fields

ua_statuscode status_code
 StatusCode for the browse path.
 
struct ua_browsepathtargettargets
 List of targets for the relativePath from the startingNode.
 
int32_t num_targets
 Number of elements in ua_browsepathresult::targets.
 

Related Functions

void ua_browsepathresult_init (struct ua_browsepathresult *t)
 Initialize an ua_browsepathresult struct with a valid value. More...
 
void ua_browsepathresult_clear (struct ua_browsepathresult *t)
 Clear all resources alloctated in an ua_browsepathresult struct. More...
 
int ua_browsepathresult_compare (const struct ua_browsepathresult *a, const struct ua_browsepathresult *b)
 Compare two ua_browsepathresult structs. More...
 
int ua_browsepathresult_copy (struct ua_browsepathresult *dst, const struct ua_browsepathresult *src)
 Create a copy of a ua_browsepathresult struct. More...
 
static int ua_browsepathresult_resize_targets_array (struct ua_browsepathresult *val, int32_t new_len)
 Resize the targets array of a ua_browsepathresult struct. More...
 

Detailed Description

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

Friends And Related Function Documentation

void ua_browsepathresult_clear ( struct ua_browsepathresult t)
related

Clear all resources alloctated in an ua_browsepathresult struct.

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

int ua_browsepathresult_compare ( const struct ua_browsepathresult a,
const struct ua_browsepathresult b 
)
related

Compare two ua_browsepathresult structs.

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

int ua_browsepathresult_copy ( struct ua_browsepathresult dst,
const struct ua_browsepathresult src 
)
related

Create a copy of a ua_browsepathresult struct.

Copy all fields from struct ua_browsepathresult 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_browsepathresult_init ( struct ua_browsepathresult t)
related

Initialize an ua_browsepathresult struct with a valid value.

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

static int ua_browsepathresult_resize_targets_array ( struct ua_browsepathresult val,
int32_t  new_len 
)
related

Resize the targets array of a ua_browsepathresult struct.

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_lenNew length of the targets 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: