SVLOG
See also
Example
Further information
Extract of logged event records.
WebVue support - Yes.
The use of the verbs EXPORT, EXPORT_LOG and EXPORT_TREND is preferred to verbs SVLOG and SVTREND. The latter are kept for compatibility only.
Mode |
Mnemonic |
Syntax |
1 |
EXTRACT |
1 |
Syntax 1
LongVal = SVLOG(Mode, DestHandle, ParamHandle [, EndVarName [, StatusVarName [, LinesVarName [, StartTime [, EndTime]]]]]);
Return type: LONG.
Argument |
Meaning |
DestHandle |
The handle of a buffer in which the extracted log information will be placed. Type LONG. |
ParamHandle |
The handle of a buffer that contains parameters which will be used to filter the logs to be extracted. The parameters take the form of a comma-separated string. Type LONG. |
EndVarName |
The name of a bit variable that will be set to 1 when the extract has finished. Type STR. |
StatusVarName |
The name of a register variable that will hold the status of the instruction. This parameter is ignored if you use a null string. Type STR. -1 - Extraction in progress. |
|
|
|
|
|
|
LinesVarName |
The name of a register variable into which will be written the number of lines returned. A negative number indicates an error. This parameter is ignored if you use a null string. Type STR. |
StartTime |
The name of a variable in which will be written the timestamp of the first record extracted. Type STR.
This parameter is ignored if you use a null string. |
EndTime |
The name of a variable in which will be written the timestamp of the last record extracted. Type STR. See StartTime for format information. |
Execution
Mode |
Mnemonic |
Action |
1 |
EXTRACT |
Logs that meet the filter criteria are extracted and placed in the buffer defined by the parameter DestHandle. Return: 0 if syntax of instruction is incorrect. The status variable must be used for operational status codes. |
For the format of the parameter buffer, see the topic Parameter Buffer Format and the topic on Native Filter Expressions.
The destination buffer size is limited to 32 Kb.
If the number of rows returned, as indicated in the variable LinesVarName, is equal to the max number of lines requested (see MaxLines in ParamHandle) there may be more data to extract.
Attributes names used in Filter Expressions are not permitted to include spaces. For example, (#A5==T 5) is not permitted.
Example
For an example, select the Example link above.