ClearLoggedEvents

ClearLoggedEvents 1:

Async method for clearing logged events. Returns TRUE if the asynchronous request is no longer assigned.

Syntax

METHOD ClearLoggedEvents : BOOL
VAR_INPUT
    ipClearSettings      : I_TcClearLoggedEventsSettings;
END_VAR
VAR_OUTPUT
    bError               : BOOL;
    hrErrorCode          : HRESULT;
END_VAR

ClearLoggedEvents 2: Inputs

Name

Type

Description

ipClearSettings

I_TcClearLoggedEventsSettings

Optional
(otherwise the entire cache is emptied)

ClearLoggedEvents 3: Return values

Name

Type

Description

ClearLoggedEvents

BOOL

Returns TRUE as soon as the request has been processed.

ClearLoggedEvents 4: Outputs

Name

Type

Description

bError

BOOL

Returns TRUE if the query is incorrect.

hrErrorCode

HRESULT

Returns an error code if the query is incorrect.

Application sample for the method

This method is asynchronous, i.e. it requires several cycles to deliver the return value. The following use is intended:

IF bClearLoggedEvents THEN
   bClearLoggedEvents:= NOT fbLogger.ClearLoggedEvents(0);
END_IF