High Performance OPC UA Server SDK  1.2.0.193
ua_historyupdaterequest Struct Reference

Asynchronously updates historical values or events of one or more nodes. More...

#include <historyupdaterequest.h>

Data Fields

struct ua_extensionobjecthistory_update_details
 Specifies the types of history updates that can be performed. More...
 
int32_t num_history_update_details
 Number of elements in ua_historyupdaterequest::history_update_details.
 

Related Functions

void ua_historyupdaterequest_init (struct ua_historyupdaterequest *t)
 Initialize an ua_historyupdaterequest struct with a valid value. More...
 
void ua_historyupdaterequest_clear (struct ua_historyupdaterequest *t)
 Clear all resources alloctated in an ua_historyupdaterequest struct. More...
 
int ua_historyupdaterequest_compare (const struct ua_historyupdaterequest *a, const struct ua_historyupdaterequest *b)
 Compare two ua_historyupdaterequest structs. More...
 
int ua_historyupdaterequest_copy (struct ua_historyupdaterequest *dst, const struct ua_historyupdaterequest *src)
 Create a copy of a ua_historyupdaterequest struct. More...
 
static int ua_historyupdaterequest_resize_history_update_details_array (struct ua_historyupdaterequest *val, int32_t new_len)
 Resize the history_update_details array of a ua_historyupdaterequest struct. More...
 

Detailed Description

Asynchronously updates historical values or events of one or more nodes.

Friends And Related Function Documentation

void ua_historyupdaterequest_clear ( struct ua_historyupdaterequest t)
related

Clear all resources alloctated in an ua_historyupdaterequest struct.

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

int ua_historyupdaterequest_compare ( const struct ua_historyupdaterequest a,
const struct ua_historyupdaterequest b 
)
related

Compare two ua_historyupdaterequest structs.

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

int ua_historyupdaterequest_copy ( struct ua_historyupdaterequest dst,
const struct ua_historyupdaterequest src 
)
related

Create a copy of a ua_historyupdaterequest struct.

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

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

static int ua_historyupdaterequest_resize_history_update_details_array ( struct ua_historyupdaterequest val,
int32_t  new_len 
)
related

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

Field Documentation

history_update_details

Specifies the types of history updates that can be performed.

The HistoryUpdateDetails is an extensible parameter. It may contain one of the following: ua_updatedatadetails, ua_updatestructuredatadetails, ua_updateeventdetails, ua_deleterawmodifieddetails, ua_deleteattimedetails, ua_deleteeventdetails.


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