High Performance OPC UA Server SDK  1.2.0.193
ua_addreferencesitem Struct Reference

A structure that is defined as the type of the referencesToAdd parameter of the AddReferences Service. More...

#include <addreferencesitem.h>

Data Fields

struct ua_nodeid source_node_id
 NodeId of the node to which the reference is to be added. More...
 
struct ua_nodeid reference_type_id
 NodeId of the ReferenceType that defines the reference.
 
bool is_forward
 If the value is TRUE, the Server creates a forward reference; if the value is FALSE, the Server creates an inverse Reference.
 
struct ua_string target_server_uri
 URI of the remote Server. More...
 
struct ua_expandednodeid target_node_id
 Expanded NodeId of the target node.
 
enum ua_nodeclass target_node_class
 NodeClass of the target node. More...
 

Related Functions

void ua_addreferencesitem_init (struct ua_addreferencesitem *t)
 Initialize an ua_addreferencesitem struct with a valid value. More...
 
void ua_addreferencesitem_clear (struct ua_addreferencesitem *t)
 Clear all resources alloctated in an ua_addreferencesitem struct. More...
 
int ua_addreferencesitem_compare (const struct ua_addreferencesitem *a, const struct ua_addreferencesitem *b)
 Compare two ua_addreferencesitem structs. More...
 
int ua_addreferencesitem_copy (struct ua_addreferencesitem *dst, const struct ua_addreferencesitem *src)
 Create a copy of a ua_addreferencesitem struct. More...
 

Detailed Description

A structure that is defined as the type of the referencesToAdd parameter of the AddReferences Service.

Friends And Related Function Documentation

void ua_addreferencesitem_clear ( struct ua_addreferencesitem t)
related

Clear all resources alloctated in an ua_addreferencesitem struct.

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

int ua_addreferencesitem_compare ( const struct ua_addreferencesitem a,
const struct ua_addreferencesitem b 
)
related

Compare two ua_addreferencesitem structs.

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

int ua_addreferencesitem_copy ( struct ua_addreferencesitem dst,
const struct ua_addreferencesitem src 
)
related

Create a copy of a ua_addreferencesitem struct.

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

Initialize an ua_addreferencesitem 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_addreferencesitem struct can also be passed to ua_addreferencesitem_compare, ua_addreferencesitem_copy and ua_addreferencesitem_clear. This function will always succeed as long as an ua_addreferencesitem struct is passed to it.

Field Documentation

source_node_id

NodeId of the node to which the reference is to be added.

The source node shall always exist in the Server to add the reference. The IsForward parameter can be set to FALSE if the target node is on the local Server and the source node on the remote Server.

target_node_class

NodeClass of the target node.

The Client shall specify this since the target node might not be accessible directly by the Server.

target_server_uri

URI of the remote Server.

If this parameter is not null, it overrides the serverIndex in the TargetNodeId.


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