High Performance OPC UA Server SDK
1.2.0.193
|
A structure that is defined as the type of the results parameter of the HistoryRead Service. More...
#include <historyreadresult.h>
Data Fields | |
ua_statuscode | status_code |
StatusCode for the nodesToRead item. | |
struct ua_bytestring | continuation_point |
This parameter is used only if the number of values to be returned is too large to be returned in a single response or if the timeout provided as hint by the Client is close to expiring and not all nodes have been processed. More... | |
struct ua_extensionobject | history_data |
The history data returned for the node. More... | |
Related Functions | |
void | ua_historyreadresult_init (struct ua_historyreadresult *t) |
Initialize an ua_historyreadresult struct with a valid value. More... | |
void | ua_historyreadresult_clear (struct ua_historyreadresult *t) |
Clear all resources alloctated in an ua_historyreadresult struct. More... | |
int | ua_historyreadresult_compare (const struct ua_historyreadresult *a, const struct ua_historyreadresult *b) |
Compare two ua_historyreadresult structs. More... | |
int | ua_historyreadresult_copy (struct ua_historyreadresult *dst, const struct ua_historyreadresult *src) |
Create a copy of a ua_historyreadresult struct. More... | |
A structure that is defined as the type of the results parameter of the HistoryRead Service.
|
related |
Clear all resources alloctated in an ua_historyreadresult struct.
Frees allocated memory like arrays and resets numeric values. The ua_historyreadresult struct itself is not freed and must be freed by the caller if required. This function always succeeds for a valid ua_historyreadresult struct, that was validly decoded, initilized by ua_historyreadresult_init or created with ua_historyreadresult_copy.
|
related |
Compare two ua_historyreadresult structs.
Compares the content of the ua_historyreadresult struct a
to the content of the ua_historyreadresult 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_historyreadresult structs, so it is well suited to not only determine equality, but also sort multiple instances of this struct.
|
related |
Create a copy of a ua_historyreadresult struct.
Copy all fields from struct ua_historyreadresult 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.
|
related |
Initialize an ua_historyreadresult 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_historyreadresult struct can also be passed to ua_historyreadresult_compare, ua_historyreadresult_copy and ua_historyreadresult_clear. This function will always succeed as long as an ua_historyreadresult struct is passed to it.
continuation_point |
This parameter is used only if the number of values to be returned is too large to be returned in a single response or if the timeout provided as hint by the Client is close to expiring and not all nodes have been processed.
If this parameter is not used, its value is null.
Servers shall support at least one continuation point per Session. Servers specify a maximum number of history continuation points per Session in the Server capabilities object defined in Part 5 of the OPC UA specification. A continuation point shall remain active until the Client passes the continuation point to HistoryRead or the Session is closed. If the maximum number of continuation points have been reached, the oldest continuation point shall be reset.
history_data |
The history data returned for the node.
The HistoryData parameter type is an extensible parameter type formally defined in Part 11 of the OPC UA Specification. It specifies the types of history data that can be returned.