Skip navigation

FlexPro Documentation 2025

RingBufferRead

Reads a section of a trace from a HistoryBase ring buffer.

Syntax

RingBufferRead(HistoryBaseFile, Machine, Group, TraceName, FromTime, ToTime)

 

The syntax of the RingBufferRead function consists of the following parts:

Part

Description

HistoryBaseFile

String with the path of the ring buffer file to be read.

Permitted data structures are Scalar value. Supported data types are String (file name).

Machine

Name of a computer in the network on which the specified ring buffer file is already being used by a HistoryBase component. This argument can also be an empty text. In this case, the HistoryBase instance is searched for or instantiated on the executing system.

Permitted data structures are Scalar value. Supported data types are String.

Group

Name of the trace group in the ring buffer containing the trace to be imported.

Permitted data structures are Scalar value. Supported data types are String.

TraceName

Name of the trace to be imported.

Permitted data structures are Scalar value. Supported data types are String.

FromTime

The date and time of the first (oldest) value to be read from the trace.

Permitted data structures are Scalar value. Supported data types are 32-bit integer, 64-bit floating point und Calendar time.

ToTime

The date and time of the last (most recent) value to be read from the trace. This date and time must be greater than the date and time specified in FromTime.

Permitted data structures are Scalar value. Supported data types are 32-bit integer, 64-bit floating point und Calendar time.

Remarks

The result always has the data structure Data series.

Weisang HistoryBase version 2.4 or higher must be installed on the executing system and, if applicable, on the system specified in Machine.

If an argument is a list, then the first element in the list is taken. If this is also a list, then the process is repeated.

Available in

FlexPro View, Basic, Professional, Developer Suite

Examples

RingBufferRead("C:\RingBuffer.rbf", "RemoteMachine", "SPS", "Signal", '1.1.2010 10:00', '1.1.2010 11:00')


See Also

RingBufferReadTime Function

RingBufferFirstTime Function

RingBufferLastTime Function

IsTimeInRingBuffer Function