High Performance OPC UA Server SDK  1.2.0.193
ua_deletenodesrequest Struct Reference

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

#include <deletenodesrequest.h>

Data Fields

struct ua_deletenodesitemnodes
 List of nodes to delete.
 
int32_t num_nodes
 Number of elements in ua_deletenodesrequest::nodes.
 

Related Functions

void ua_deletenodesrequest_init (struct ua_deletenodesrequest *t)
 Initialize an ua_deletenodesrequest struct with a valid value. More...
 
void ua_deletenodesrequest_clear (struct ua_deletenodesrequest *t)
 Clear all resources alloctated in an ua_deletenodesrequest struct. More...
 
int ua_deletenodesrequest_compare (const struct ua_deletenodesrequest *a, const struct ua_deletenodesrequest *b)
 Compare two ua_deletenodesrequest structs. More...
 
int ua_deletenodesrequest_copy (struct ua_deletenodesrequest *dst, const struct ua_deletenodesrequest *src)
 Create a copy of a ua_deletenodesrequest struct. More...
 
static int ua_deletenodesrequest_resize_nodes_array (struct ua_deletenodesrequest *val, int32_t new_len)
 Resize the nodes array of a ua_deletenodesrequest struct. More...
 

Detailed Description

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

If any of the Nodes deleted by an invocation of this service is the target node of a reference, those references are left unresolved based on the deleteTargetReferences parameter.

If any of the nodes deleted by an invocation of this service is being monitored, a notification containing the status code Bad_NodeIdUnknown is sent to the monitoring Client indicating that the node has been deleted.

Friends And Related Function Documentation

void ua_deletenodesrequest_clear ( struct ua_deletenodesrequest t)
related

Clear all resources alloctated in an ua_deletenodesrequest struct.

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

int ua_deletenodesrequest_compare ( const struct ua_deletenodesrequest a,
const struct ua_deletenodesrequest b 
)
related

Compare two ua_deletenodesrequest structs.

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

int ua_deletenodesrequest_copy ( struct ua_deletenodesrequest dst,
const struct ua_deletenodesrequest src 
)
related

Create a copy of a ua_deletenodesrequest struct.

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

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

static int ua_deletenodesrequest_resize_nodes_array ( struct ua_deletenodesrequest val,
int32_t  new_len 
)
related

Resize the nodes array of a ua_deletenodesrequest 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 nodes 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: