High Performance OPC UA Server SDK  1.2.0.193
ua_contentfilterresult Struct Reference

A structure that contains any errors associated with the filter. More...

#include <contentfilterresult.h>

Data Fields

struct
ua_contentfilterelementresult
element_results
 A list of results for individual elements in the filter. More...
 
int32_t num_element_results
 Number of elements in ua_contentfilterresult::element_results.
 
struct ua_diagnosticinfoelement_diag_infos
 A list of diagnostic information for individual elements in the filter. More...
 
int32_t num_element_diag_infos
 Number of elements in ua_contentfilterresult::element_diag_infos.
 

Related Functions

void ua_contentfilterresult_init (struct ua_contentfilterresult *t)
 Initialize an ua_contentfilterresult struct with a valid value. More...
 
void ua_contentfilterresult_clear (struct ua_contentfilterresult *t)
 Clear all resources alloctated in an ua_contentfilterresult struct. More...
 
int ua_contentfilterresult_compare (const struct ua_contentfilterresult *a, const struct ua_contentfilterresult *b)
 Compare two ua_contentfilterresult structs. More...
 
int ua_contentfilterresult_copy (struct ua_contentfilterresult *dst, const struct ua_contentfilterresult *src)
 Create a copy of a ua_contentfilterresult struct. More...
 
static int ua_contentfilterresult_resize_element_results_array (struct ua_contentfilterresult *val, int32_t new_len)
 Resize the element_results array of a ua_contentfilterresult struct. More...
 
static int ua_contentfilterresult_resize_element_diag_infos_array (struct ua_contentfilterresult *val, int32_t new_len)
 Resize the element_diag_infos array of a ua_contentfilterresult struct. More...
 

Detailed Description

A structure that contains any errors associated with the filter.

Friends And Related Function Documentation

void ua_contentfilterresult_clear ( struct ua_contentfilterresult t)
related

Clear all resources alloctated in an ua_contentfilterresult struct.

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

int ua_contentfilterresult_compare ( const struct ua_contentfilterresult a,
const struct ua_contentfilterresult b 
)
related

Compare two ua_contentfilterresult structs.

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

int ua_contentfilterresult_copy ( struct ua_contentfilterresult dst,
const struct ua_contentfilterresult src 
)
related

Create a copy of a ua_contentfilterresult struct.

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

Initialize an ua_contentfilterresult 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_contentfilterresult struct can also be passed to ua_contentfilterresult_compare, ua_contentfilterresult_copy and ua_contentfilterresult_clear. This function will always succeed as long as an ua_contentfilterresult struct is passed to it.

static int ua_contentfilterresult_resize_element_diag_infos_array ( struct ua_contentfilterresult val,
int32_t  new_len 
)
related

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

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

Field Documentation

element_diag_infos

A list of diagnostic information for individual elements in the filter.

The size and order of the list matches the size and order of the elements in the filter 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 elements.

element_results

A list of results for individual elements in the filter.

See ua_contentfilterelementresult.


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