High Performance OPC UA Server SDK  1.2.0.193
ua_deletereferencesitem Struct Reference

A structure that is defined as the type of the referencesToDelete parameter of the DeleteReferences service. More...

#include <deletereferencesitem.h>

Data Fields

struct ua_nodeid source_node_id
 NodeId of the node that contains the reference to delete.
 
struct ua_nodeid reference_type_id
 NodeId of the ReferenceType that defines the reference to delete.
 
bool is_forward
 If the value is TRUE, the Server deletes a forward Reference. More...
 
struct ua_expandednodeid target_node_id
 NodeId of the target node of the reference. More...
 
bool delete_bidirectional
 A boolean parameter indicating whether the opposite reference from the target node should be deleted together with the node to delete. More...
 

Related Functions

void ua_deletereferencesitem_init (struct ua_deletereferencesitem *t)
 Initialize an ua_deletereferencesitem struct with a valid value. More...
 
void ua_deletereferencesitem_clear (struct ua_deletereferencesitem *t)
 Clear all resources alloctated in an ua_deletereferencesitem struct. More...
 
int ua_deletereferencesitem_compare (const struct ua_deletereferencesitem *a, const struct ua_deletereferencesitem *b)
 Compare two ua_deletereferencesitem structs. More...
 
int ua_deletereferencesitem_copy (struct ua_deletereferencesitem *dst, const struct ua_deletereferencesitem *src)
 Create a copy of a ua_deletereferencesitem struct. More...
 

Detailed Description

A structure that is defined as the type of the referencesToDelete parameter of the DeleteReferences service.

Friends And Related Function Documentation

void ua_deletereferencesitem_clear ( struct ua_deletereferencesitem t)
related

Clear all resources alloctated in an ua_deletereferencesitem struct.

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

int ua_deletereferencesitem_compare ( const struct ua_deletereferencesitem a,
const struct ua_deletereferencesitem b 
)
related

Compare two ua_deletereferencesitem structs.

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

int ua_deletereferencesitem_copy ( struct ua_deletereferencesitem dst,
const struct ua_deletereferencesitem src 
)
related

Create a copy of a ua_deletereferencesitem struct.

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

Initialize an ua_deletereferencesitem 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_deletereferencesitem struct can also be passed to ua_deletereferencesitem_compare, ua_deletereferencesitem_copy and ua_deletereferencesitem_clear. This function will always succeed as long as an ua_deletereferencesitem struct is passed to it.

Field Documentation

delete_bidirectional

A boolean parameter indicating whether the opposite reference from the target node should be deleted together with the node to delete.

It has the following values:

TRUE
delete the specified Reference and the opposite reference from the target node. If the target node is located in a remote Server, the Server is permitted to delete the specified reference only.
FALSE
delete only the specified reference.
is_forward

If the value is TRUE, the Server deletes a forward Reference.

If the value is FALSE, the Server deletes an inverse Reference.

target_node_id

NodeId of the target node of the reference.

If the Server index indicates that the target node is a remote node, then the nodeId shall contain the absolute namespace URI. If the target node is a local node the nodeId shall contain the namespace index.


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