Reference

OpcReadEventHistoryDetails Members

Type

OpcReadEventHistoryDetails

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Constructors

OpcReadEventHistoryDetails

4 overloads · since v2.54

Overload	Description
OpcReadEventHistoryDetails(int, OpcEventFilter)since v2.54	Initializes a new instance of the OpcReadEventHistoryDetails class using the specified numberOfEvents to select the historical events.
OpcReadEventHistoryDetails(DateTime?, int, OpcEventFilter)since v2.54	Initializes a new instance of the OpcReadEventHistoryDetails class using the specified startTime and numberOfEvents to use to select the historical events.
OpcReadEventHistoryDetails(DateTime?, DateTime?, int, OpcEventFilter)since v2.54	Initializes a new instance of the OpcReadEventHistoryDetails class using the specified startTime, endTime and numberOfEvents to use to select the historical events.
OpcReadEventHistoryDetails(DateTime?, DateTime?, OpcEventFilter)since v2.54	Initializes a new instance of the OpcReadEventHistoryDetails class using the specified startTime and endTime to use to select the historical events.

Exceptions (all overloads)

Exception	Condition
ArgumentNullException	The filter is a null reference (Nothing in Visual Basic).

OpcReadEventHistoryDetails(int, OpcEventFilter)

since v2.54

Initializes a new instance of the OpcReadEventHistoryDetails class using the specified numberOfEvents to select the historical events.

public OpcReadEventHistoryDetails(int numberOfEvents, OpcEventFilter filter)

Public Sub New(numberOfEvents As Integer, filter As OpcEventFilter)

Parameters

Name	Type	Description
numberOfEvents	Int32	The maximum number of events returned for any node over the time range.
filter	OpcEventFilter

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The numberOfEvents is lower or equals zero.

OpcReadEventHistoryDetails(DateTime?, int, OpcEventFilter)

since v2.54

Initializes a new instance of the OpcReadEventHistoryDetails class using the specified startTime and numberOfEvents to use to select the historical events.

public OpcReadEventHistoryDetails(
    DateTime? startTime,
    int numberOfEvents,
    OpcEventFilter filter)

Public Sub New(
    startTime As Date?,
    numberOfEvents As Integer,
    filter As OpcEventFilter)

Parameters

Name	Type	Description
startTime	Nullable<DateTime>	The beginning of the period to read.
numberOfEvents	Int32	The maximum number of events returned for any node over the time range. If only one time is specified, the time range shall extend to return this number of events.
filter	OpcEventFilter

Exceptions

Exception	Condition
ArgumentException	The startTime is a null reference (Nothing in Visual Basic) or equals MinValue.
ArgumentOutOfRangeException	The numberOfEvents is lower or equals zero.

OpcReadEventHistoryDetails(DateTime?, DateTime?, int, OpcEventFilter)

since v2.54

Initializes a new instance of the OpcReadEventHistoryDetails class using the specified startTime, endTime and numberOfEvents to use to select the historical events.

public OpcReadEventHistoryDetails(
    DateTime? startTime,
    DateTime? endTime,
    int numberOfEvents,
    OpcEventFilter filter)

Public Sub New(
    startTime As Date?,
    endTime As Date?,
    numberOfEvents As Integer,
    filter As OpcEventFilter)

Parameters

Name	Type	Description
startTime	Nullable<DateTime>	The beginning of the period to read or a null reference (Nothing in Visual Basic) if no specific start time is specified. If startTime is not specified and the numberOfEvents is equals zero the endTime needs to be specified.
endTime	Nullable<DateTime>	The end of the period to read or a null reference (Nothing in Visual Basic) if no specific end time is specified. If endTime is not specified and the numberOfEvents is equals zero the startTime needs to be specified.
numberOfEvents	Int32	The maximum number of events returned for any node over the time range. If only one time is specified, the time range shall extend to return this number of events.
filter	OpcEventFilter

Exceptions

Exception	Condition
ArgumentException	The startTime and endTime are a null reference (Nothing in Visual Basic) or are equals MinValue and numberOfEvents is lower or equals zero.

OpcReadEventHistoryDetails(DateTime?, DateTime?, OpcEventFilter)

since v2.54

Initializes a new instance of the OpcReadEventHistoryDetails class using the specified startTime and endTime to use to select the historical events.

public OpcReadEventHistoryDetails(
    DateTime? startTime,
    DateTime? endTime,
    OpcEventFilter filter)

Public Sub New(startTime As Date?, endTime As Date?, filter As OpcEventFilter)

Parameters

Name	Type	Description
startTime	Nullable<DateTime>	The beginning of the period to read or a null reference (Nothing in Visual Basic) if no specific start time is specified. If startTime is not specified the endTime needs to be specified.
endTime	Nullable<DateTime>	The end of the period to read or a null reference (Nothing in Visual Basic) if no specific end time is specified. If endTime is not specified the startTime needs to be specified.
filter	OpcEventFilter

Exceptions

Exception	Condition
ArgumentException	The startTime and endTime are a null reference (Nothing in Visual Basic) or are equals MinValue.

Properties

EndTime

Gets or sets the end of the period to read.

public DateTime? EndTime { get; set; }

Public Property EndTime As Date?

Property value

Nullable<DateTime>

The DateTime of the end of the period to read or a null reference (Nothing in Visual Basic) if no specific end time is specified.

Remarks

If EndTime is not specified and NumberOfEvents is equals zero the StartTime needs to be specified.

Filter

public OpcEventFilter Filter { get; set; }

Public Property Filter As OpcEventFilter

Property value

OpcEventFilter

Exceptions

Exception	Condition
ArgumentNullException

NumberOfEvents

since v2.54

Gets or sets the maximum number of events returned for any node over the time range.

public int NumberOfEvents { get; set; }

Public Property NumberOfEvents As Integer

Property value

Int32

The maximum number of events returned over the time range. The default value is zero and indicates that there is no maximum.

Remarks

If only time (either StartTime or EndTime) is specified, the time range shall extend to return this number of events.

StartTime

Gets or sets the beginning of the period to read.

public DateTime? StartTime { get; set; }

Public Property StartTime As Date?

Property value

Nullable<DateTime>

The DateTime of the beginning of the period read or a null reference (Nothing in Visual Basic) if no specific start time is specified.

Remarks

If StartTime is not specified the EndTime needs to be specified.