--- product: Chilkat product_version: 11.7.0 language: dataflex language_label: DataFlex class: SecureString license: free deprecated: false reference_html: https://www.chilkatsoft.com/refdoc/dataflexSecureStringRef.html --- # Chilkat SecureString — DataFlex — v11.7.0 > Chilkat 11.7.0 · language=dataflex · class=SecureString > Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0//classes/SecureString.md`. > Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/dataflex/guide.md`. ## Purpose **Store, append, compare, hash, verify, and securely access sensitive string values.** `Chilkat.SecureString` holds sensitive text in an encrypted in-memory form while still allowing controlled operations on the value. It can append clear-text strings, append text from a `StringBuilder`, append another `SecureString`, load text from a file, return the clear-text value when needed, compare secure strings, mark the value read-only, maintain a hash of the current value, and verify a supplied hash against that maintained value. **Encrypted in-memory value** Store sensitive text in a form that is decrypted only when needed for access, modification, comparison, or hashing. **Append safely** Append clear-text strings, `StringBuilder` content, or another `SecureString`; the value is then re-encrypted. **Read-only protection** Set `ReadOnly` to prevent later modification of the secure string. **Hash maintenance** Set `MaintainHash` to a supported hash algorithm such as `sha256`, `sha512`, `sha1`, or `md5`. **Hash output and verification** Retrieve the current hash value in an encoding such as hex or Base64, or verify a supplied encoded hash with `VerifyHash`. **Compare and access** Compare two secure strings with `SecStrEquals`, or call `Access` when the clear-text value is required. **Common pattern:** Create a `SecureString`, load or append the sensitive text, set `MaintainHash` if later verification is needed, and optionally set `ReadOnly` after the final value is established. Use `Access` only at the point where the clear-text string is actually needed, and check `LastErrorText` if an append, file load, hash, or verification operation fails. **Hash note:** `VerifyHash` depends on `MaintainHash` having already been set so the object maintains an internal hash for the current secure string value. ## Object creation, unlocking and error handling **Object Creation** ```dataflex // (Dataflex programs use the 32-bit Chilkat ActiveX) Handle hoSecureString Get Create(RefClass(cComChilkatSecureString)) to hoSecureString ``` Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in DataFlex. How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called. ## Members common to every Chilkat class Documented once per language in `common-members.md`; listed here so this page is self-contained. | Property | Signature | Access | Meaning | |---|---|---|---| | `DebugLogFilePath` | `Function ComDebugLogFilePath Returns String Procedure Set ComDebugLogFilePath String value` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. | | `LastBinaryResult` | `Function ComLastBinaryResult Returns Variant` | read-only | This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. | | `LastErrorHtml` | `Function ComLastErrorHtml Returns String` | read-only | Provides HTML-formatted information about the last called method or property. | | `LastErrorText` | `Function ComLastErrorText Returns String` | read-only | Provides plain text information about the last called method or property. | | `LastErrorXml` | `Function ComLastErrorXml Returns String` | read-only | Provides XML-formatted information about the last called method or property. | | `LastMethodSuccess` | `Function ComLastMethodSuccess Returns Boolean Procedure Set ComLastMethodSuccess Boolean value` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. | | `LastStringResult` | `Function ComLastStringResult Returns String` | read-only | In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. | | `LastStringResultLen` | `Function ComLastStringResultLen Returns Integer` | read-only | The length, in characters, of the string contained in the LastStringResult property. | | `VerboseLogging` | `Function ComVerboseLogging Returns Boolean Procedure Set ComVerboseLogging Boolean value` | read/write | If set to `True`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. | | `Version` | `Function ComVersion Returns String` | read-only | Version of the component/library, such as "10.1.0" | ## Member index | Member | Kind | Signature | |---|---|---| | `MaintainHash` | property, read/write | `Function ComMaintainHash Returns String Procedure Set ComMaintainHash String value` | | `ReadOnly` | property, read/write | `Function ComReadOnly Returns Boolean Procedure Set ComReadOnly Boolean value` | | `Access` | method | `Function ComAccess Returns String` | | `Append` | method | `Function ComAppend String str Returns Boolean` | | `AppendSb` | method | `Function ComAppendSb cComChilkatStringBuilder sb Returns Boolean` | | `AppendSecure` | method | `Function ComAppendSecure cComChilkatSecureString secStr Returns Boolean` | | `HashVal` | method | `Function ComHashVal String encoding Returns String` | | `LoadFile` | method | `Function ComLoadFile String path String charset Returns Boolean` | | `SecStrEquals` | method | `Function ComSecStrEquals cComChilkatSecureString secStr Returns Boolean` | | `VerifyHash` | method | `Function ComVerifyHash String hashVal String encoding Returns Boolean` | ## Properties ### SecureString.MaintainHash `Chilkat 11.7.0 · dataflex · SecureString · MaintainHash · property · read/write · since 9.5.0.71` ```dataflex Function ComMaintainHash Returns String Procedure Set ComMaintainHash String value ``` If set to the name of a hash algorithm, then a hash of the current string value is maintained. This allows for the hash to be verified via the VerifyHash method. Possible hash algorithm names are `sha1`, `sha256`, `sha384`, `sha512`, `md5`, `md2`, `ripemd160`, `ripemd128`,`ripemd256`, and `ripemd320`. ### SecureString.ReadOnly `Chilkat 11.7.0 · dataflex · SecureString · ReadOnly · property · read/write · since 9.5.0.71` ```dataflex Function ComReadOnly Returns Boolean Procedure Set ComReadOnly Boolean value ``` Can be set to `True` to make this secure string read-only (cannot be modified). ## Methods ### SecureString.Access `Chilkat 11.7.0 · dataflex · SecureString · Access · method · since 9.5.0.71` ```dataflex Function ComAccess Returns String ``` Returns the clear-text string value. Returns `null` on failure ### SecureString.Append `Chilkat 11.7.0 · dataflex · SecureString · Append · method · since 9.5.0.71` ```dataflex Function ComAppend String str Returns Boolean ``` Appends a clear-text string to this secure string. The in-memory data will be decrypted, the string will be appended, and then it will be re-encrypted. Can return `False` if the string has been marked as read-only via the ReadOnly property. Returns True for success, False for failure. ### SecureString.AppendSb `Chilkat 11.7.0 · dataflex · SecureString · AppendSb · method · since 9.5.0.71` ```dataflex Function ComAppendSb cComChilkatStringBuilder sb Returns Boolean ``` Appends a clear-text string contained in a StringBuilder to this secure string. The in-memory data will be decrypted, the string will be appended, and then it will be re-encrypted. Can return `False` if the string has been marked as read-only via the ReadOnly property. Returns True for success, False for failure. ### SecureString.AppendSecure `Chilkat 11.7.0 · dataflex · SecureString · AppendSecure · method · since 9.5.0.71` ```dataflex Function ComAppendSecure cComChilkatSecureString secStr Returns Boolean ``` Appends the contents of a secure string to this secure string. The in-memory data will be decrypted, the secure string will be appended, and then it will be re-encrypted. Can return `False` if this string has been marked as read-only via the ReadOnly property. Returns True for success, False for failure. ### SecureString.HashVal `Chilkat 11.7.0 · dataflex · SecureString · HashVal · method · since 9.5.0.71` ```dataflex Function ComHashVal String encoding Returns String ``` Returns the hash value for the current value of this secure string. The `encoding` specifies the encoding to be used. It can be any of the binary encoding algorithms, such as `base64`, `hex`, and many more listed at [Chilkat Binary Encodings](https://www.chilkatsoft.com/binary_encodings.asp) Returns `null` on failure ### SecureString.LoadFile `Chilkat 11.7.0 · dataflex · SecureString · LoadFile · method · since 9.5.0.71` ```dataflex Function ComLoadFile String path String charset Returns Boolean ``` Loads the contents of a file into this secure string. The current contents of this object are replaced with the new text from the file. Returns True for success, False for failure. ### SecureString.SecStrEquals `Chilkat 11.7.0 · dataflex · SecureString · SecStrEquals · method · since 9.5.0.71` ```dataflex Function ComSecStrEquals cComChilkatSecureString secStr Returns Boolean ``` Returns `True` if the `secStr` equals the contents of this secure string. Returns True for success, False for failure. ### SecureString.VerifyHash `Chilkat 11.7.0 · dataflex · SecureString · VerifyHash · method · since 9.5.0.71` ```dataflex Function ComVerifyHash String hashVal String encoding Returns Boolean ``` Verifies the `hashVal` against the hash value stored for the current value of this secure string. The MaintainHash property must've previously been set for this secure string to maintain an internal hash. The `encoding` specifies the encoding of the `hashVal`. It can be any of the binary encoding algorithms, such as `base64`, `hex`, and many more listed at [Chilkat Binary Encodings](https://www.chilkatsoft.com/binary_encodings.asp) Returns True for success, False for failure. ## Related classes [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/dataflex/classes/StringBuilder.md)