Root > Reference > All Functions > SetEurekaLogState

Function SetEurekaLogState

Previous pageReturn to chapter overviewNext page   

Enables or disables EurekaLog in this application.

 

Unit

EBase

 

Syntax

 

Code (Delphi)

function SetEurekaLogState(

const AActivate: Boolean

): Boolean;

 

Parameters

AActivate [in]

True - if you want to enable EurekaLog, False - if you want to disable EurekaLog.

 

Remarks

You can use this procedure to manually enable and disable EurekaLog in your application.

 

EurekaLog is considered to be active if it should do its work. You can get EurekaLog activation status by calling IsEurekaLogActive procedure.

 

If EurekaLog is not installed - then it's always disabled (not active).

 

This function changes global status for all application. If you want to change activation status on per-thread basis - use SetEurekaLogStateInThread procedure.

 

Examples

 

Code (Delphi)

// Enable EurekaLog in application (by default)

SetEurekaLogState(True);

raise Exception.Create('Error message'); // <- this exception will be handled by EurekaLog, since EurekaLog is enabled

 

Code (Delphi)

// Disable EurekaLog in application

SetEurekaLogState(False);

raise Exception.Create('Error message'); // <- this exception will not be handled by EurekaLog, since EurekaLog is disabled

 

See also

_IsEurekaLogActive



Send feedback... Build date: 2024-12-11
Last edited: 2024-12-11
PRIVACY STATEMENT
The documentation team uses the feedback submitted to improve the EurekaLog documentation. We do not use your e-mail address for any other purpose. We will remove your e-mail address from our system after the issue you are reporting has been resolved. While we are working to resolve this issue, we may send you an e-mail message to request more information about your feedback. After the issues have been addressed, we may send you an email message to let you know that your feedback has been addressed.


Permanent link to this article: https://www.eurekalog.com/help/eurekalog/topic_function_ebase_seteurekalogstate.php