High Performance OPC UA Server SDK  1.2.0.193
ua_browseresult Struct Reference

The results of a Browse operation. More...

#include <browseresult.h>

Data Fields

ua_statuscode status_code
 The status for the BrowseDescription. More...
 
struct ua_bytestring continuation_point
 A Server defined opaque value that identifies the continuation point.
 
struct ua_referencedescriptionreferences
 The set of references that meet the criteria specified in the BrowseDescription. More...
 
int32_t num_references
 Number of elements in ua_browseresult::references.
 

Related Functions

void ua_browseresult_init (struct ua_browseresult *t)
 Initialize an ua_browseresult struct with a valid value. More...
 
void ua_browseresult_clear (struct ua_browseresult *t)
 Clear all resources alloctated in an ua_browseresult struct. More...
 
int ua_browseresult_compare (const struct ua_browseresult *a, const struct ua_browseresult *b)
 Compare two ua_browseresult structs. More...
 
int ua_browseresult_copy (struct ua_browseresult *dst, const struct ua_browseresult *src)
 Create a copy of a ua_browseresult struct. More...
 
static int ua_browseresult_resize_references_array (struct ua_browseresult *val, int32_t new_len)
 Resize the references array of a ua_browseresult struct. More...
 

Detailed Description

The results of a Browse operation.

Friends And Related Function Documentation

void ua_browseresult_clear ( struct ua_browseresult t)
related

Clear all resources alloctated in an ua_browseresult struct.

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

int ua_browseresult_compare ( const struct ua_browseresult a,
const struct ua_browseresult b 
)
related

Compare two ua_browseresult structs.

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

int ua_browseresult_copy ( struct ua_browseresult dst,
const struct ua_browseresult src 
)
related

Create a copy of a ua_browseresult struct.

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

Initialize an ua_browseresult 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_browseresult struct can also be passed to ua_browseresult_compare, ua_browseresult_copy and ua_browseresult_clear. This function will always succeed as long as an ua_browseresult struct is passed to it.

static int ua_browseresult_resize_references_array ( struct ua_browseresult val,
int32_t  new_len 
)
related

Resize the references array of a ua_browseresult 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 references array in number of members.
Returns
Zero on success or ua_statuscode on failure.

Field Documentation

references

The set of references that meet the criteria specified in the BrowseDescription.

Empty if no references met the criteria.

status_code

The status for the BrowseDescription.

This value is set to Good if there are still references to return for the BrowseDescription.


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