Root > Reference > All Functions > ConfigReadBool

Function ConfigReadBool

Previous pageReturn to chapter overviewNext page   

Reads boolean value from specified key and section.

 

Unit

EConfig

 

Syntax

 

Code (Delphi)

function ConfigReadBool(

const ASection, AName: String;

const ADefault: Boolean = False

): Boolean;

 

Parameters

ASection

Section name. Can't be empty. Can't contain '\' or '/'.

 

AName

Key name. Can't be empty.

 

ADefault

Default value, if key or section doesn't exits or key's value have a wrong format. Optional.

 

Return value

Returns key's value on success or ADefault in case of non-existent key or section or wrong value's format.

 

Exceptions

System.SysUtils.EOSError

Raises this exception on failure.

 

Remarks

Reads boolean value from EurekaLog configuration.

 

See EConfig unit description for basic desciption of EurekaLog configuration.

 

This function is a wrapper for ConfigReadString function.

 

Examples

 

Code (Delphi)

CheckUpdates.Checked := ConfigReadBool(IDESectionName, IDECanCheckUpdatesName, True);

 

See also




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