Log SetBackUpLogFile() Method

(SBM On-Premise only) If called with a true value and the log size exceeds value provided to SetMaxSize(), the log will rename the file with a date stamp in the new name, and start a fresh file with the original name.

Function Signature

 bool SetBackUpLogFile( bool value )

Parameters

Parameter	Type	Description
value	bool	If set to false, when the value provided to SetMaxSize() is reached, all previous log data will be lost. This is the default behavior if SetBackUpLogFile() is not set.

Return

Type	Description
bool	Returns the bool value passed in. The default is false.

Technical Details

SBM ModScript version: 11.3.

Example

See Log Message() Method.

Notes

See SetMaxSize() for the size that triggers this behavior.