kerio::web::Logs Interface Reference

import "Logs.idl";

Public Member Functions
void	cancelSearch (in string searchId)
void	clear (in LogType logName)
void	exportLog (out Download fileDownload, in LogType logName, in long fromLine, in long countLines, in ExportFormat type)
void	exportLogRelative (out Download fileDownload, in LogType logName, in long fromLine, in long countLines, in ExportFormat type)
void	get (out LogRowList viewport, out long totalItems, in LogType logName, in long fromLine, in long countLines)
void	getHighlightRules (out HighlightRules rules)
void	getLogSet (out LogSet logSet)
void	getMessages (out TreeLeafList messages)
void	getSearchProgress (out LogRowList viewport, out long firstLine, out long totalItems, out SearchStatus status, out long percentage, in long countLines, in string searchId)
void	getSettings (out LogSettings currentSettings, in LogType logName)
void	search (out string searchId, in LogType logName, in string what, in long fromLine, in long toLine, in boolean forward)
void	setHighlightRules (in HighlightRules rules)
void	setMessages (in TreeLeafList messages)
void	setSettings (in LogType logName, in LogSettings newSettings)

Detailed Description

Log object

Member Function Documentation

void kerio::web::Logs::cancelSearch

(

in string

searchId

)

Cancel search on server (useful for large logs).

Parameters

searchId

- identifier from search()

void kerio::web::Logs::clear

(

in LogType

logName

)

Delete all log lines.

Parameters

logName

- unique name of the log

void kerio::web::Logs::exportLog	(	out Download	fileDownload,
		in LogType	logName,
		in long	fromLine,
		in long	countLines,
		in ExportFormat	type
	)

Exporting a given log.

Parameters

fileDownload	- file download structure
logName	- unique name of the log
fromLine	- number of the line to start the search from;
countLines	- number of lines to transfer; Unlimited - symbolic name for end of log
type	- export file type

void kerio::web::Logs::exportLogRelative	(	out Download	fileDownload,
		in LogType	logName,
		in long	fromLine,
		in long	countLines,
		in ExportFormat	type
	)

Exporting a given log with relative download path.

Parameters

fileDownload	- file download structure
logName	- unique name of the log
fromLine	- number of the line to start the search from;
countLines	- number of lines to transfer; Unlimited - symbolic name for end of log
type	- export file type

void kerio::web::Logs::get	(	out LogRowList	viewport,
		out long	totalItems,
		in LogType	logName,
		in long	fromLine,
		in long	countLines
	)

Obtain log data without linebreaks.

Parameters

viewport	- list of log lines; count of lines = min(count, NUMBER_OF_CURRENT LINES - from)
totalItems	- current count of all log lines
logName	- unique name of the log
fromLine	- number of the line to start from; if (fromLine == Unlimited) then fromline is end of log minus countLines
countLines	- number of lines to transfer

void kerio::web::Logs::getHighlightRules

(

out HighlightRules

rules

)

Obtain a list of sorted highlighting rules.

Parameters

rules

- highlight rules

void kerio::web::Logs::getLogSet

(

out LogSet

logSet

)

Retrieve set of valid logs.

Parameters

logSet

- list of valid logs

void kerio::web::Logs::getMessages

(

out TreeLeafList

messages

)

Obtain log message settings; make sense only if LogItem.hasMessages == true.

Parameters

messages

- tree of log messages

void kerio::web::Logs::getSearchProgress	(	out LogRowList	viewport,
		out long	firstLine,
		out long	totalItems,
		out SearchStatus	status,
		out long	percentage,
		in long	countLines,
		in string	searchId
	)

Clears timeout for search() and obtains status of the search.

Parameters

viewport	- list of log lines
firstLine	- first matching line
totalItems	- current count of all log lines
status	- current status of the search
percentage	- already finished search <0;100>
countLines	- number of lines to transfer
searchId	- identifier from search()

void kerio::web::Logs::getSettings	(	out LogSettings	currentSettings,
		in LogType	logName
	)

Obtain log settings.

Parameters

currentSettings	- current valid settings (or undefined data on failure)
logName	- unique name of the log

void kerio::web::Logs::search	(	out string	searchId,
		in LogType	logName,
		in string	what,
		in long	fromLine,
		in long	toLine,
		in boolean	forward
	)

Start searching for a string in a given log; The search exists 1 minute unless prolonged by getSearchProgress.

Parameters

searchId	- identifier that can be used for cancelSearch and getSearchProgress
logName	- unique name of the log
what	- searched string
fromLine	- line to start searching from; fromLine>toLine means search up; Unlimited - symbolic name for end of log
toLine	- line to start searching from; fromLine<toLine means search down
forward	- direction of the search; true = forward, false = backward

void kerio::web::Logs::setHighlightRules

(

in HighlightRules

rules

)

Set highlighting rules, rules have to be sorted purposely, the only way to change a rule is to change the whole ruleset.

Parameters

rules

- highlight rules (ordered by priority)

void kerio::web::Logs::setMessages

(

in TreeLeafList

messages

)

Change log message settings; makes sense only if LogItem.hasMessages == true.

Parameters

messages

- tree of log messages

void kerio::web::Logs::setSettings	(	in LogType	logName,
		in LogSettings	newSettings
	)

Change log settings.

Parameters

logName	- unique name of the log
newSettings

---

The documentation for this interface was generated from the following file:

• Logs.idl