Root > Reference > All Functions > EncodeConfigValue

Function EncodeConfigValue

Previous pageReturn to chapter overviewNext page   

Low-level routine to encode data before saving to configuration storage.

 

Unit

EConfig

 

Syntax

 

Code (Delphi)

function EncodeConfigValue(

const AValue: String

): String;

 

Parameters

AValue

A data to encode.

 

Return value

Encoded data. Exact encoded format is unspecified.

 

Remarks

 

Warning

This is low-level routine. Use it only to implement your own custom high-level wrapper.

 

Use ConfigReadString or ConfigWriteString (or their equivalents) to read and write configurations.

 

Encodes data by escaping special characters (like #0, line breaks, trailing spaces, etc).

 

Usually you don't need to use this function, because you're encouraged to use ConfigWriteString or it's wrapper. These ConfigWriteXYZ functions perform such encoding automatically.

 

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