SetValueByTime - method of object PmTrend

Description:

The method searches the record with the time mark by the tTime parameter and if such record is found, then it writes the value (the array of values) of a variable (more variables) from the vData parameter into it. The time mark of the record is searched by the tTime and sParam parameters and it can differ from the time of the tTime parameter by the specified accuracy at the most. See the parameters description.

Syntax:

SetValueByTime(vData As Variant, sWhat As String, tTime As Date, nTimeType As Long, sParam As String) As Boolean

Calling:

retval = oTrend.SetValueByTime(vData, sWhat, tTime, nTimeType, sParam)

Parameters:

vData	(Variant) Value or array of values. The number of values unambiguously refers to the number of variables entered to the sWhat parameter. The order of variable in the sWhat string specifies the order of values in the vData array if more variables are defined in the sWhat. If sWhat includes only one variable, then there is either a single value or an array with one item in vData.
sWhat	(String) Specification of the variable (or variables) whose stored value(s) has to be passed. It is possible to enter, for example, "a1;" or "a1;a2;a3;" if there has to be written into the array of the variables from the Data page. At the variables it is necessary to keep the order by the order from the page. For example, if the order of the variables from the page is a1,a2,a3,..., then it is possible to enter, for example, "a1;a3;" in the parameter but "a3;a1" is wrong.
tTime	(Date) Time whose record of variables values has to be searched.
nTimeType	(Long) Time type of the tTime parameter 1 - tTime is "local time" (the "standard time" in the standard season and the "daylight-saving time" in the daylight-saving season, corresponds to the computer time depending on the locale setting of Windows system) 2 - tTime is "standard time" (in the daylight-saving and standard seasons).
sParam	(String) Way of searching the time specified in the tTime parameter. "eq:xxx" - Record whose time mark equals the tTime time, is searched. The string xxx specifies the accuracy of the equality. For xxx the values Nsec, Nmin are enabled, where N is a real number that sets the number of seconds, respectively the number of minutes. If, for example, 15 seconds (...,14:00,14:15,14:30,...) values are stored by the PmTrend object, then after entering tTime=14:17, sParam="eq:3sec", the record of variables with the time mark 14:15 will be found.

Return Values:

If the record is found by the time and the writing proceeded in order, then returns true, otherwise false.

Example:

A record by the tTime time is searched. The time mark of the record can differ from the tTime time by 1 second at the most. If the record is found, then the value of the variable a0 that corresponds to this time, is overwritten by the value of the vData(0) parameter and the value of the variable a1 is overwritten by the value of the vData(1) parameter.

VBScriptSelect and copy to clipboard


Dim vData, tTime
vData = Array(10, 20)

'tTime setting
If oTrend.SetValueByTime(vData, "a0;a1", tTime, 1, "eq:1sec") Then
  'variables a0,a1 are overwritten by values 10,20 successfully.
End If