Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

upf::ILog Interface Reference

import "ILog.idl";

Inheritance diagram for upf::ILog:

Inheritance graph
[legend]
List of all members.

Detailed Description

Errors logging interface.

Functions defined in UPF don't return descriptive error code if an error occurs.. Instead, they return failure flag (usually false) and the error is logged in human-readable form to the log. ILog can handle the information as it see fit: it may or may not display it to the user.

Note:
You can provide your own log implementation.
See also:
SERVICE_LOG, IServiceManager


Public Types

enum  LogType { LOG_INFO, LOG_WARNING, LOG_ERROR }
 Type of logged event. More...


Public Methods

void log (in string origin, in LogType type, in string text)
 Logs an event.


Member Enumeration Documentation

enum upf::ILog::LogType
 

Type of logged event.

Enumeration values:
LOG_INFO  Informative message (shouldn't interrupt user's work).
LOG_WARNING  Warning (isn't fatal).
LOG_ERROR  Error.


Member Function Documentation

void upf::ILog::log in string    origin,
in LogType    type,
in string    text
 

Logs an event.

Parameters:
origin  String identifier of the component that logged this error. "upf" is reserved for use by UPF, but that is the only limitation imposed on this string
type  Type (importance) of logged message
text  Human-readable description of the error


Generated on Wed Jan 15 23:10:55 2003 for Universal Plugins Framework by doxygen1.2.18