High Performance OPC UA Server SDK  1.2.0.193
ua_endpointurllistdatatype Struct Reference

Structure representing a list of URLs of an Endpoint. More...

#include <endpointurllistdatatype.h>

Data Fields

struct ua_stringendpoint_url_list
 List of URLs of an Endpoint.
 
int32_t num_endpoint_url_list
 Number of elements in ua_endpointurllistdatatype::endpoint_url_list.
 

Related Functions

void ua_endpointurllistdatatype_init (struct ua_endpointurllistdatatype *t)
 Initialize an ua_endpointurllistdatatype struct with a valid value. More...
 
void ua_endpointurllistdatatype_clear (struct ua_endpointurllistdatatype *t)
 Clear all resources alloctated in an ua_endpointurllistdatatype struct. More...
 
int ua_endpointurllistdatatype_compare (const struct ua_endpointurllistdatatype *a, const struct ua_endpointurllistdatatype *b)
 Compare two ua_endpointurllistdatatype structs. More...
 
int ua_endpointurllistdatatype_copy (struct ua_endpointurllistdatatype *dst, const struct ua_endpointurllistdatatype *src)
 Create a copy of a ua_endpointurllistdatatype struct. More...
 
static int ua_endpointurllistdatatype_resize_endpoint_url_list_array (struct ua_endpointurllistdatatype *val, int32_t new_len)
 Resize the endpoint_url_list array of a ua_endpointurllistdatatype struct. More...
 

Detailed Description

Structure representing a list of URLs of an Endpoint.

Friends And Related Function Documentation

void ua_endpointurllistdatatype_clear ( struct ua_endpointurllistdatatype t)
related

Clear all resources alloctated in an ua_endpointurllistdatatype struct.

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

int ua_endpointurllistdatatype_compare ( const struct ua_endpointurllistdatatype a,
const struct ua_endpointurllistdatatype b 
)
related

Compare two ua_endpointurllistdatatype structs.

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

int ua_endpointurllistdatatype_copy ( struct ua_endpointurllistdatatype dst,
const struct ua_endpointurllistdatatype src 
)
related

Create a copy of a ua_endpointurllistdatatype struct.

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

Initialize an ua_endpointurllistdatatype 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_endpointurllistdatatype struct can also be passed to ua_endpointurllistdatatype_compare, ua_endpointurllistdatatype_copy and ua_endpointurllistdatatype_clear. This function will always succeed as long as an ua_endpointurllistdatatype struct is passed to it.

static int ua_endpointurllistdatatype_resize_endpoint_url_list_array ( struct ua_endpointurllistdatatype val,
int32_t  new_len 
)
related

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

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