High Performance OPC UA Server SDK  1.2.0.193
ua_deletereferencesrequest Struct Reference

Asynchronously deletes references from the OPC UA server’s address space. More...

#include <deletereferencesrequest.h>

Data Fields

struct ua_deletereferencesitemreferences_to_delete
 List of references to delete.
 
int32_t num_references_to_delete
 Number of elements in ua_deletereferencesrequest::references_to_delete.
 

Related Functions

void ua_deletereferencesrequest_init (struct ua_deletereferencesrequest *t)
 Initialize an ua_deletereferencesrequest struct with a valid value. More...
 
void ua_deletereferencesrequest_clear (struct ua_deletereferencesrequest *t)
 Clear all resources alloctated in an ua_deletereferencesrequest struct. More...
 
int ua_deletereferencesrequest_compare (const struct ua_deletereferencesrequest *a, const struct ua_deletereferencesrequest *b)
 Compare two ua_deletereferencesrequest structs. More...
 
int ua_deletereferencesrequest_copy (struct ua_deletereferencesrequest *dst, const struct ua_deletereferencesrequest *src)
 Create a copy of a ua_deletereferencesrequest struct. More...
 
static int ua_deletereferencesrequest_resize_references_to_delete_array (struct ua_deletereferencesrequest *val, int32_t new_len)
 Resize the references_to_delete array of a ua_deletereferencesrequest struct. More...
 

Detailed Description

Asynchronously deletes references from the OPC UA server’s address space.

If any of the references deleted by an invocation of this service are contained in a view, then the ViewVersion property is updated if this property is supported.

Friends And Related Function Documentation

void ua_deletereferencesrequest_clear ( struct ua_deletereferencesrequest t)
related

Clear all resources alloctated in an ua_deletereferencesrequest struct.

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

int ua_deletereferencesrequest_compare ( const struct ua_deletereferencesrequest a,
const struct ua_deletereferencesrequest b 
)
related

Compare two ua_deletereferencesrequest structs.

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

int ua_deletereferencesrequest_copy ( struct ua_deletereferencesrequest dst,
const struct ua_deletereferencesrequest src 
)
related

Create a copy of a ua_deletereferencesrequest struct.

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

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

static int ua_deletereferencesrequest_resize_references_to_delete_array ( struct ua_deletereferencesrequest val,
int32_t  new_len 
)
related

Resize the references_to_delete array of a ua_deletereferencesrequest 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 references_to_delete 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: