docs

Home All functions Legacy functions Categories

vuClearDiagnosticsLog()

Clarion prototype

Prototype: vuClearDiagnosticsLog(), SIGNED, PROC, PASCAL, RAW, NAME(‘vuClearDiagnosticsLog’)

Description

Clears the current vuMailKit diagnostics log file.

This function is the preferred clear function for diagnostics. The older diagnostics clear function remains supported:

This function does not clear the legacy sent-mail CSV log selected by vuLogSetFile() / vuSetMailLog().

Parameters

This function takes no parameters.

Return value

Value Meaning
1 if diagnostics logs were cleared, or if no diagnostics files are currently configured.
0 if the logs could not be cleared. Call vuMailLastError() for details.

Notes

Use vuClearMailLog() when you want to clear the legacy sent-mail CSV log.

Example (Clarion)

Result SIGNED

Result = vuClearDiagnosticsLog()
IF Result = 0
  MESSAGE('Could not clear diagnostics log: ' & vuMailLastError())
END
Home All functions Legacy functions Categories