ClearLoggedEvents

ClearLoggedEvents 1:

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

Syntax

METHOD ClearLoggedEvents : HRESULT
VAR_INPUT
    ipClearSettings      : I_TcClearLoggedEventsSettings;
END_VAR

ClearLoggedEvents 2: Inputs

Name

Type

Description

ipClearSettings

I_TcClearLoggedEventsSettings

Optional
(otherwise the entire cache is emptied)

ClearLoggedEvents 3: Return value

Name

Type

Description

ClearLoggedEvents

HRESULT

Returns S_PENDING as long as the request has not yet been completed. Returns S_OK if the method call was successful, otherwise an HRESULT as the error code.

Use of 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) = S_OK);
END_IF