RegisterArchBlock

RegisterArchBlock

RegisterArchBlock function


Function

The function registers an archive block.

Declaration

RegisterArchBlock(COM_ID, FUNCTION, ARCH_OBJECT1, BT, ET, ARCH_OBJECT2, VALUE, Step)

Parameters

The parameters ARCH_OBJECT2, VALUE and Step are optional. The parameters COM_ID, FUNCTION, ARCH_OBJECT1, BT and ET must be always set always.

COM_ID

Identifier of archive block. If the block name is incorrect, the function acquires one of these values:

  • „Name of block ?“ - missing block name.

  • „Incorrect name of block" - wrong division of name of block

  • „Registering must be called from DECLARATION side !!!“.

  • „Duplicate name of archive block -> XXXX“ - COM_ID is not unique within workbook. XXXX - reference to a cell with previous registering.

FUNCTION

Name of function, which will be worked with values from archive. The list of implemented functions is mentioned in the chapter The functions working with archive values.

ARCH_OBJECT1

Name of archive object. If parameter is not defined, the function acquires the value „Archive object?“.

BT

Begin absolute time.

ET

End absolute time. If BT > ET, the functions acquires the value "BT > ET !!!".

ARCH_OBJECT2

Name of conditional archive object for SUMP function. The parameter is optional for other functions. If it is required and undefined, the function acquires the value "Archive object 2?".

VALUE

Reference value for the functions SUMT, SUMB, SUMA. The parameter is optional for other functions.

Step

Required time step between values from archive. If it is not defined, all values will be loaded as they were archived. Step can be either a number - defines the step in days, or time (e.g. 00:01:00 - 1 minute).


Related pages:

Implemented functions