[Overview][Resource strings][Types][Classes][Index] Reference for unit 'eventlog' (#fcl)

TEventLog

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

Event logging class

Declaration

Source position: eventlog.pp line 30

type TEventLog = class(TComponent)

public

  destructor Destroy; override;

  

Clean up TEventLog instance

  function EventTypeToString();

  

Create a string representation of an event type

  function RegisterMessageFile(); virtual;

  

Register message file

  function UnRegisterMessageFile; virtual;

  

Unregister the message file (needed on windows only)

  procedure Pause;

  

Pause the sending of log messages.

  procedure Resume;

  

Resume sending of log messages if sending was paused

  procedure Log();

  

Log a message to the system log.

  procedure Warning();

  

Log a warning message.

  procedure Error();

  

Log an error message to

  procedure Debug();

  

Log a debug message

  procedure Info();

  

Log an informational message

published

  property AppendContent: Boolean; [rw]

  

Control whether output is appended to an existing file

  property Identification: string; [rw]

  

Identification string for messages

  property LogType: TLogType; [rw]

  

Log type

  property Active: Boolean; [rw]

  

Activate the log mechanism

  property RaiseExceptionOnError: Boolean; [rw]

  

Determines whether logging errors are reported or ignored

  property DefaultEventType: TEventType; [rw]

  

Default event type for the Log call.

  property FileName: string; [rw]

  

File name for log file

  property TimeStampFormat: string; [rw]

  

Format for the timestamp string

  property CustomLogType: Word; [rw]

  

Custom log type ID

  property EventIDOffset: DWord; [rw]

  

Offset for event ID messages identifiers

  property OnGetCustomCategory: TLogCategoryEvent; [rw]

  

Event to retrieve custom message category

  property OnGetCustomEventID: TLogCodeEvent; [rw]

  

Event to retrieve custom event ID

  property OnGetCustomEvent: TLogCodeEvent; [rw]

  

Event to retrieve custom event Code

  property Paused: Boolean; [rw]

  

Is the message sending paused ?

end;

Inheritance

TEventLog

  

Event logging class

|

TComponent,IUnknown,IInterfaceComponentReference

|

TPersistent,IFPObserved

|

TObject

Description

TEventLog is a component which can be used to send messages to the system log. In case no system log exists (such as on Windows 95/98 or DOS), the messages are written to a file. Messages can be logged using the general Log call, or the specialized Warning, Error, Info or Debug calls, which have the event type predefined.

See also

Log

  

Log a message to the system log.

Warning

  

Log a warning message.

Error

  

Log an error message to

Info

  

Log an informational message

Debug

  

Log a debug message


Documentation generated on: Jun 22 2020