GETARCHCOL archIdent, locRecDstIdent, timeFromIdent_TmA, timeToIdent_TmA, stepIdent_Int, maxValsIdent_Int, statusIdent_Int [,archivInstance_Int] [TIMEBYROW | TIMEBYCOL] |
archIdent | in | Reference to an item of:
or reference to one-column historical value. |
locRecDstIdent | out | The local structured variable for a read result. |
timeFromIdent_TmA | in | An Identifier of the Absolute time type - interval beginning. |
timeToIdent_TmA | in | An Identifier of the Absolute time type - interval end. |
stepIdent_Int | in | An Identifier of the Int type - time step for archive values resampling. For resampling details, see Resampling note. |
maxValsIdent_Int | in | The maximum number of values. If the given interval contains more data, the action will trim off the data and return ERR_MORE_DATA warning in the parameter statusIdent_Int. |
statusIdent_Int | out | Read success. |
TIMEBYROW | Places result values by time into rows. | |
TIMEBYCOL | Places result values by time into columns. | |
archivInstance_Int | in | Optional identifier of Int type - identification of archive instance. If the parameter is not defined, the value 0 will replace it. |
The parameter archIdent can be defined by one of the following ways:
The read result is stored in the local structured variable defined by the parameter _locRecDstIdent. The result of every request is either one value or a sequence of values. Every sequence of values is stored in the local variable _locRecDstIdent:
The value of parameter archivInstance_Int defines the instance of the archive which executes the request. If the parameter is not defined (or the value is 0), the active instance of archive will execute the request.
The variable statusIdent_Int indicates the success of reading the action. If this variable acquires the value _ERR_NO_DATA(22), it means that all archives, which were used when reading, do not contain any data. If at least one of the archives contains data, the action returns _ERR_NO_ERR(0).