IsTimeInRingBuffer (FPScript)

21.09.2021

Checks whether the specified date and time is present in the HistoryBase ring buffer. Returns TRUE if present. Otherwise, it returns FALSE.

Syntax

IsTimeInRingBuffer(HistoryBaseFile, Machine, Time)

 

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

Part

Description

HistoryBaseFile

Path to the HistoryBase ring storage file to be read.

Permitted data structures are scalar value. Supported data types are string (file name).

Machine

Name of a computer on the network on which the specified ring buffer file is already in use by a HistoryBase component. This argument can be an empty text. In this case the running instance of HistoryBase will be searched or, if necessary, instantiated on the executing machine.

Permitted data structures are scalar value. Supported data types are string.

Time

UTC date and time whose existence in the ring buffer is to be checked.

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 scalar value.

The Weisang HistoryBase ring buffer version 2.4 or higher has to be installed on the executing system and, if applicable, on the system specified by 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

IsTimeInRingBuffer("C:\RingBuffer.rbf", "RemoteMachine", '2010/1/1 11:45')


See Also

RingBufferRead Function

RingBufferReadTime Function

RingBufferFirstTime Function

RingBufferLastTime Function

Share article or send as email:

You might be interested in these articles