High Performance OPC UA Server SDK  1.2.0.193
ua_writeresponse Struct Reference

Data Fields

ua_statuscoderesults
 List of results for the nodes to write. More...
 
int32_t num_results
 Number of elements in ua_writeresponse::results.
 
struct ua_diagnosticinfodiag_infos
 
int32_t num_diag_infos
 

Related Functions

void ua_writeresponse_init (struct ua_writeresponse *t)
 Initialize an ua_writeresponse struct with a valid value. More...
 
void ua_writeresponse_clear (struct ua_writeresponse *t)
 Clear all resources alloctated in an ua_writeresponse struct. More...
 
int ua_writeresponse_compare (const struct ua_writeresponse *a, const struct ua_writeresponse *b)
 Compare two ua_writeresponse structs. More...
 
int ua_writeresponse_copy (struct ua_writeresponse *dst, const struct ua_writeresponse *src)
 Create a copy of a ua_writeresponse struct. More...
 
static int ua_writeresponse_resize_results_array (struct ua_writeresponse *val, int32_t new_len)
 Resize the results array of a ua_writeresponse struct. More...
 
static int ua_writeresponse_resize_diag_infos_array (struct ua_writeresponse *val, int32_t new_len)
 Resize the diag_infos array of a ua_writeresponse struct. More...
 

Friends And Related Function Documentation

void ua_writeresponse_clear ( struct ua_writeresponse t)
related

Clear all resources alloctated in an ua_writeresponse struct.

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

int ua_writeresponse_compare ( const struct ua_writeresponse a,
const struct ua_writeresponse b 
)
related

Compare two ua_writeresponse structs.

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

int ua_writeresponse_copy ( struct ua_writeresponse dst,
const struct ua_writeresponse src 
)
related

Create a copy of a ua_writeresponse struct.

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

Initialize an ua_writeresponse 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_writeresponse struct can also be passed to ua_writeresponse_clear. This function will always succeed as long as an ua_writeresponse struct is passed to it.

static int ua_writeresponse_resize_diag_infos_array ( struct ua_writeresponse val,
int32_t  new_len 
)
related

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

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

Field Documentation

results

List of results for the nodes to write.

The size and order of the list matches the size and order of the ua_WriteRequest::nodes_to_write request parameter. There is one entry in this list for each node contained in the ua_WriteRequest::nodes_to_write parameter.


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