Root > Reference > Main routines > CurrentEurekaLogOptions

Function CurrentEurekaLogOptions

Previous pageReturn to chapter overviewNext page   

Returns current EurekaLog's options.

 

Unit

ExceptionLog7

 

Syntax

 

Code (Delphi)

function CurrentEurekaLogOptions: TEurekaModuleOptions;

 

Return value

Current EurekaLog's options.

 

Remarks

This function returns options for EurekaLog in current executable module. Options are present if EurekaLog was installed.

 

Important!

If EurekaLog is not active - any attempt to call this function will result in error message "Cannot use ''CurrentEurekaLogOptions'' function in module "XYZ" without activate EurekaLog" and immediate process termination.

 

This behaviour is "as designed". It's done to avoid cases when you ship your application with EurekaLog's code but without EurekaLog active.

 

Default options are set based on EurekaLog's projects settings - as set by you in IDE expert or standalone Settings Editor Tool. Options can be changed at run-time at any time.

 

Note

Some options are read-only. That's because these options can not be changed after activation.

 

CurrentEurekaLogOptions represents global EurekaLog's options. These options can also be captured locally. In this case changes to global options will have no effect for captured options.

 

For example, when exception is raised - it creates a copy of options. Thus, if you change options globally - this will have no effect on already active exceptions.

 

If you want to change options for such exceptions - you should use local copy of options (i.e. Options property for dialogs, Options argument in event handlers, etc.).

 

See TEurekaModuleOptions for detailed description of available EurekaLog's options.

 

Note

It's highly recommended to use enviroment variables when possible instead of customizing options at run-time. That's because some exceptions can occur before you get chance to setup options.

 

Note

This is a wrapper for EModules.CurrentEurekaLogOptions function.

 

Examples

 

Code (Delphi)

// Disable sending if run on my machine

if ApplicationRunOnDeveloperMachine then

CurrentEurekaLogOptions.SenderClasses := '';

 




Send feedback... Build date: 2018-11-26
Last edited: 2018-11-26
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_exceptionlog7_currenteurekalogoptions.php