High Performance OPC UA Server SDK  1.2.0.193
ua_parsingresult Struct Reference

A structure that is defined as the type of the parsingResults parameter of the Query service. More...

#include <parsingresult.h>

Data Fields

ua_statuscode status_code
 Parsing result for the requested NodeTypeDescription.
 
ua_statuscodedata_status_codes
 List of results for dataToReturn. More...
 
int32_t num_data_status_codes
 Number of elements in ua_parsingresult::data_status_codes.
 
struct ua_diagnosticinfodata_diag_infos
 List of diagnostic information dataToReturn. More...
 
int32_t num_data_diag_infos
 Number of elements in ua_parsingresult::data_diag_infos.
 

Related Functions

void ua_parsingresult_init (struct ua_parsingresult *t)
 Initialize an ua_parsingresult struct with a valid value. More...
 
void ua_parsingresult_clear (struct ua_parsingresult *t)
 Clear all resources alloctated in an ua_parsingresult struct. More...
 
int ua_parsingresult_compare (const struct ua_parsingresult *a, const struct ua_parsingresult *b)
 Compare two ua_parsingresult structs. More...
 
int ua_parsingresult_copy (struct ua_parsingresult *dst, const struct ua_parsingresult *src)
 Create a copy of a ua_parsingresult struct. More...
 
static int ua_parsingresult_resize_data_status_codes_array (struct ua_parsingresult *val, int32_t new_len)
 Resize the data_status_codes array of a ua_parsingresult struct. More...
 
static int ua_parsingresult_resize_data_diag_infos_array (struct ua_parsingresult *val, int32_t new_len)
 Resize the data_diag_infos array of a ua_parsingresult struct. More...
 

Detailed Description

A structure that is defined as the type of the parsingResults parameter of the Query service.

Friends And Related Function Documentation

void ua_parsingresult_clear ( struct ua_parsingresult t)
related

Clear all resources alloctated in an ua_parsingresult struct.

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

int ua_parsingresult_compare ( const struct ua_parsingresult a,
const struct ua_parsingresult b 
)
related

Compare two ua_parsingresult structs.

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

int ua_parsingresult_copy ( struct ua_parsingresult dst,
const struct ua_parsingresult src 
)
related

Create a copy of a ua_parsingresult struct.

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

Initialize an ua_parsingresult 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_parsingresult struct can also be passed to ua_parsingresult_compare, ua_parsingresult_copy and ua_parsingresult_clear. This function will always succeed as long as an ua_parsingresult struct is passed to it.

static int ua_parsingresult_resize_data_diag_infos_array ( struct ua_parsingresult val,
int32_t  new_len 
)
related

Resize the data_diag_infos array of a ua_parsingresult 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 data_diag_infos array in number of members.
Returns
Zero on success or ua_statuscode on failure.
static int ua_parsingresult_resize_data_status_codes_array ( struct ua_parsingresult val,
int32_t  new_len 
)
related

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

Field Documentation

data_diag_infos

List of diagnostic information dataToReturn.

The size and order of the list matches the size and order of the dataToReturn request parameter. This list is empty if diagnostics information was not requested in the request header or if no diagnostic information was encountered in processing of the query request.

data_status_codes

List of results for dataToReturn.

The size and order of the list matches the size and order of the dataToReturn request parameter. The array can be empty if no errors were encountered.


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