High Performance OPC UA Server SDK  1.2.0.193
ua_contentfilterelementresult Struct Reference

A structure that is defined as the type of the elementResults parameter of the ContentFilterResult structure. More...

#include <contentfilterelementresult.h>

Data Fields

ua_statuscode status_code
 The status code for a single element.
 
ua_statuscodeoperand_status_codes
 A list of status codes for the operands in an element. More...
 
int32_t num_operand_status_codes
 Number of elements in ua_contentfilterelementresult::operand_status_codes.
 
struct ua_diagnosticinfooperand_diag_infos
 A list of diagnostic information for the operands in an element. More...
 
int32_t num_operand_diag_infos
 Number of elements in ua_contentfilterelementresult::operand_diag_infos.
 

Related Functions

void ua_contentfilterelementresult_init (struct ua_contentfilterelementresult *t)
 Initialize an ua_contentfilterelementresult struct with a valid value. More...
 
void ua_contentfilterelementresult_clear (struct ua_contentfilterelementresult *t)
 Clear all resources alloctated in an ua_contentfilterelementresult struct. More...
 
int ua_contentfilterelementresult_compare (const struct ua_contentfilterelementresult *a, const struct ua_contentfilterelementresult *b)
 Compare two ua_contentfilterelementresult structs. More...
 
int ua_contentfilterelementresult_copy (struct ua_contentfilterelementresult *dst, const struct ua_contentfilterelementresult *src)
 Create a copy of a ua_contentfilterelementresult struct. More...
 
static int ua_contentfilterelementresult_resize_operand_status_codes_array (struct ua_contentfilterelementresult *val, int32_t new_len)
 Resize the operand_status_codes array of a ua_contentfilterelementresult struct. More...
 
static int ua_contentfilterelementresult_resize_operand_diag_infos_array (struct ua_contentfilterelementresult *val, int32_t new_len)
 Resize the operand_diag_infos array of a ua_contentfilterelementresult struct. More...
 

Detailed Description

A structure that is defined as the type of the elementResults parameter of the ContentFilterResult structure.

The size and order of the list matches the size and order of the elements in the ContentFilter parameter.

Friends And Related Function Documentation

void ua_contentfilterelementresult_clear ( struct ua_contentfilterelementresult t)
related

Clear all resources alloctated in an ua_contentfilterelementresult struct.

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

int ua_contentfilterelementresult_compare ( const struct ua_contentfilterelementresult a,
const struct ua_contentfilterelementresult b 
)
related

Compare two ua_contentfilterelementresult structs.

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

int ua_contentfilterelementresult_copy ( struct ua_contentfilterelementresult dst,
const struct ua_contentfilterelementresult src 
)
related

Create a copy of a ua_contentfilterelementresult struct.

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

Initialize an ua_contentfilterelementresult 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_contentfilterelementresult struct can also be passed to ua_contentfilterelementresult_compare, ua_contentfilterelementresult_copy and ua_contentfilterelementresult_clear. This function will always succeed as long as an ua_contentfilterelementresult struct is passed to it.

static int ua_contentfilterelementresult_resize_operand_diag_infos_array ( struct ua_contentfilterelementresult val,
int32_t  new_len 
)
related

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

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

Field Documentation

operand_diag_infos

A list of diagnostic information for the operands in an element.

The size and order of the list matches the size and order of the operands in the ContentFilterElement. 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 operands. A list of diagnostic information for individual

operand_status_codes

A list of status codes for the operands in an element.

The size and order of the list matches the size and order of the operands in the ContentFilterElement. This list is empty if no operand errors occurred.


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