Root > Reference > All Functions > IsEurekaLogActive

Function IsEurekaLogActive

Previous pageReturn to chapter overviewNext page   

Indicates if EurekaLog is active or disabled in this application.

 

Unit

EBase

 

Syntax

 

Code (Delphi)

function IsEurekaLogActive: Boolean;

 

Return value

True if EurekaLog is active, False - otherwise.

 

Remarks

EurekaLog is considered to be active if EurekaLog should do its work. You can control EurekaLog activation by calling SetEurekaLogState procedure.

 

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

 

This is a global status for all application. If you want to check per-thread activation status - use IsEurekaLogActiveInThread function.

 

If you want to change activation status (enable or disable EurekaLog) - use SetEurekaLogState for global status and SetEurekaLogStateInThread for per-thread status.

 

By default, EurekaLog is active at startup (if was installed).

 

Caution!

This function doesn't respect per-thread activation status. Thus, if EurekaLog was disabled in one thread only - this function will still returns True.

 

This function respects "installed" status, so there is no need for additional call to IsEurekaLogInstalled function.

 

Note

This function is for the clients only. EurekaLog's code should use _IsEurekaLogActive_IsEurekaLogActive

 

 

Examples

 

Code (Delphi)

if IsEurekaLogActive then

// this exception will be handled by EurekaLog, since EurekaLog is enabled

raise Exception.Create('Error message')

else

// this exception will not be handled by EurekaLog, since EurekaLog is disabled

raise Exception.Create('Error message');

 

See also

IsEurekaLogInstalled
IsEurekaLogInstalledInThread
_IsEurekaLogActive
_InstallEurekaLog



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_iseurekalogactive.php