High Performance OPC UA Server SDK  1.2.0.193
ua_deleteattimedetails Struct Reference

The DeleteAtTime structure deletes all entries in the history database for the specified timestamps for one or more HistoricalDataNodes. More...

#include <deleteattimedetails.h>

Data Fields

struct ua_nodeid node_id
 NodeId of the object for which history values are to be deleted.
 
ua_datetimereq_times
 The entries define the specific timestamps for which values are to be deleted.
 
int32_t num_req_times
 Number of elements in ua_deleteattimedetails::req_times.
 

Related Functions

void ua_deleteattimedetails_init (struct ua_deleteattimedetails *t)
 Initialize an ua_deleteattimedetails struct with a valid value. More...
 
void ua_deleteattimedetails_clear (struct ua_deleteattimedetails *t)
 Clear all resources alloctated in an ua_deleteattimedetails struct. More...
 
int ua_deleteattimedetails_compare (const struct ua_deleteattimedetails *a, const struct ua_deleteattimedetails *b)
 Compare two ua_deleteattimedetails structs. More...
 
int ua_deleteattimedetails_copy (struct ua_deleteattimedetails *dst, const struct ua_deleteattimedetails *src)
 Create a copy of a ua_deleteattimedetails struct. More...
 
static int ua_deleteattimedetails_resize_req_times_array (struct ua_deleteattimedetails *val, int32_t new_len)
 Resize the req_times array of a ua_deleteattimedetails struct. More...
 

Detailed Description

The DeleteAtTime structure deletes all entries in the history database for the specified timestamps for one or more HistoricalDataNodes.

This parameter is intended to be used to delete specific data from the history database, e.g. lab data that is incorrect and cannot be correctly reproduced.

Friends And Related Function Documentation

void ua_deleteattimedetails_clear ( struct ua_deleteattimedetails t)
related

Clear all resources alloctated in an ua_deleteattimedetails struct.

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

int ua_deleteattimedetails_compare ( const struct ua_deleteattimedetails a,
const struct ua_deleteattimedetails b 
)
related

Compare two ua_deleteattimedetails structs.

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

int ua_deleteattimedetails_copy ( struct ua_deleteattimedetails dst,
const struct ua_deleteattimedetails src 
)
related

Create a copy of a ua_deleteattimedetails struct.

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

Initialize an ua_deleteattimedetails 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_deleteattimedetails struct can also be passed to ua_deleteattimedetails_compare, ua_deleteattimedetails_copy and ua_deleteattimedetails_clear. This function will always succeed as long as an ua_deleteattimedetails struct is passed to it.

static int ua_deleteattimedetails_resize_req_times_array ( struct ua_deleteattimedetails val,
int32_t  new_len 
)
related

Resize the req_times array of a ua_deleteattimedetails 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 req_times 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: