High Performance OPC UA Server SDK  1.2.0.193
ua_translatebrowsepathstonodeidsresponse Struct Reference

Data Fields

struct ua_browsepathresultresults
 List of results for the list of browse paths. More...
 
int32_t num_results
 Number of elements in ua_translatebrowsepathstonodeidsresponse::results.
 
struct ua_diagnosticinfodiag_infos
 List of diagnostic information for the list of browse paths. More...
 
int32_t num_diag_infos
 Number of elements in ua_translatebrowsepathstonodeidsresponse::diag_infos.
 

Related Functions

void ua_translatebrowsepathstonodeidsresponse_init (struct ua_translatebrowsepathstonodeidsresponse *t)
 Initialize an ua_translatebrowsepathstonodeidsresponse struct with a valid value. More...
 
void ua_translatebrowsepathstonodeidsresponse_clear (struct ua_translatebrowsepathstonodeidsresponse *t)
 Clear all resources alloctated in an ua_translatebrowsepathstonodeidsresponse struct. More...
 
int ua_translatebrowsepathstonodeidsresponse_compare (const struct ua_translatebrowsepathstonodeidsresponse *a, const struct ua_translatebrowsepathstonodeidsresponse *b)
 Compare two ua_translatebrowsepathstonodeidsresponse structs. More...
 
int ua_translatebrowsepathstonodeidsresponse_copy (struct ua_translatebrowsepathstonodeidsresponse *dst, const struct ua_translatebrowsepathstonodeidsresponse *src)
 Create a copy of a ua_translatebrowsepathstonodeidsresponse struct. More...
 
static int ua_translatebrowsepathstonodeidsresponse_resize_results_array (struct ua_translatebrowsepathstonodeidsresponse *val, int32_t new_len)
 Resize the results array of a ua_translatebrowsepathstonodeidsresponse struct. More...
 
static int ua_translatebrowsepathstonodeidsresponse_resize_diag_infos_array (struct ua_translatebrowsepathstonodeidsresponse *val, int32_t new_len)
 Resize the diag_infos array of a ua_translatebrowsepathstonodeidsresponse struct. More...
 

Friends And Related Function Documentation

void ua_translatebrowsepathstonodeidsresponse_clear ( struct ua_translatebrowsepathstonodeidsresponse t)
related

Clear all resources alloctated in an ua_translatebrowsepathstonodeidsresponse struct.

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

int ua_translatebrowsepathstonodeidsresponse_compare ( const struct ua_translatebrowsepathstonodeidsresponse a,
const struct ua_translatebrowsepathstonodeidsresponse b 
)
related

Compare two ua_translatebrowsepathstonodeidsresponse structs.

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

int ua_translatebrowsepathstonodeidsresponse_copy ( struct ua_translatebrowsepathstonodeidsresponse dst,
const struct ua_translatebrowsepathstonodeidsresponse src 
)
related

Create a copy of a ua_translatebrowsepathstonodeidsresponse struct.

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

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

static int ua_translatebrowsepathstonodeidsresponse_resize_diag_infos_array ( struct ua_translatebrowsepathstonodeidsresponse val,
int32_t  new_len 
)
related

Resize the diag_infos array of a ua_translatebrowsepathstonodeidsresponse 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_translatebrowsepathstonodeidsresponse_resize_results_array ( struct ua_translatebrowsepathstonodeidsresponse val,
int32_t  new_len 
)
related

Resize the results array of a ua_translatebrowsepathstonodeidsresponse 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

diag_infos

List of diagnostic information for the list of browse paths.

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

results

List of results for the list of browse paths.

The size and order of the list matches the size and order of the ua_TranslateBrowsePathsToNodeIdsRequest::browse_paths request parameter.


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