High Performance OPC UA Server SDK  1.2.0.193
ua_deleteeventdetails Struct Reference

Deletes all event entries from the history database matching the EventId for one or more HistoricalEventNodes. More...

#include <deleteeventdetails.h>

Data Fields

struct ua_nodeid node_id
 NodeId of the object for which history values are to be deleted.
 
struct ua_bytestringevent_ids
 An array of EventIds to identify which events are to be deleted.
 
int32_t num_event_ids
 Number of elements in ua_deleteeventdetails::event_ids.
 

Related Functions

void ua_deleteeventdetails_init (struct ua_deleteeventdetails *t)
 Initialize an ua_deleteeventdetails struct with a valid value. More...
 
void ua_deleteeventdetails_clear (struct ua_deleteeventdetails *t)
 Clear all resources alloctated in an ua_deleteeventdetails struct. More...
 
int ua_deleteeventdetails_compare (const struct ua_deleteeventdetails *a, const struct ua_deleteeventdetails *b)
 Compare two ua_deleteeventdetails structs. More...
 
int ua_deleteeventdetails_copy (struct ua_deleteeventdetails *dst, const struct ua_deleteeventdetails *src)
 Create a copy of a ua_deleteeventdetails struct. More...
 
static int ua_deleteeventdetails_resize_event_ids_array (struct ua_deleteeventdetails *val, int32_t new_len)
 Resize the event_ids array of a ua_deleteeventdetails struct. More...
 

Detailed Description

Deletes all event entries from the history database matching the EventId for one or more HistoricalEventNodes.

If no events are found that match the specified filter for a HistoricalEventNode, the StatusCode for that Node is Bad_NoData.

Friends And Related Function Documentation

void ua_deleteeventdetails_clear ( struct ua_deleteeventdetails t)
related

Clear all resources alloctated in an ua_deleteeventdetails struct.

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

int ua_deleteeventdetails_compare ( const struct ua_deleteeventdetails a,
const struct ua_deleteeventdetails b 
)
related

Compare two ua_deleteeventdetails structs.

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

int ua_deleteeventdetails_copy ( struct ua_deleteeventdetails dst,
const struct ua_deleteeventdetails src 
)
related

Create a copy of a ua_deleteeventdetails struct.

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

Initialize an ua_deleteeventdetails 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_deleteeventdetails struct can also be passed to ua_deleteeventdetails_compare, ua_deleteeventdetails_copy and ua_deleteeventdetails_clear. This function will always succeed as long as an ua_deleteeventdetails struct is passed to it.

static int ua_deleteeventdetails_resize_event_ids_array ( struct ua_deleteeventdetails val,
int32_t  new_len 
)
related

Resize the event_ids array of a ua_deleteeventdetails 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 event_ids 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: