---
product: Chilkat
product_version: 11.7.0
language: sqlserver
language_label: SQL Server
class: SecureString
license: free
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/sqlserver_SecureStringRef.html
---
# Chilkat SecureString — SQL Server — v11.7.0

> Chilkat 11.7.0 · language=sqlserver · class=SecureString
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/SecureString.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/sqlserver/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**

```sql
DECLARE @hr int
DECLARE @secureString int
EXEC @hr = sp_OACreate 'Chilkat.SecureString', @secureString OUT
IF @hr <> 0
BEGIN
    PRINT 'Failed to create ActiveX component'
    RETURN
END

-- ... use @secureString ...

EXEC @hr = sp_OADestroy @secureString
```

T-SQL uses the Chilkat ActiveX through the OLE Automation stored procedures. They must be enabled once on the server (`EXEC sp_configure 'Ole Automation Procedures', 1; RECONFIGURE;`), and the Chilkat ActiveX registered must match the bitness of the SQL Server instance (64-bit for a 64-bit SQL Server). To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `sp_OACreate 'Chilkat.SecureString.11'` for Chilkat v11.\*.\*.

`sp_OACreate` returns an object token (an `int`) that is passed as the first argument of every `sp_OAMethod`, `sp_OAGetProperty` and `sp_OASetProperty` call, and released with `sp_OADestroy`. Objects returned by methods (such as an `HttpResponse` or `JsonObject`) are also tokens received through an `int` OUT parameter; they must likewise be destroyed, and the OUT parameter is `NULL` when the method fails to return an object. Objects passed as arguments are passed by their token. When an OLE Automation procedure itself fails (non-zero `@hr`), `sp_OAGetErrorInfo` describes the error.

Data types: strings are `nvarchar(4000)`; integers, booleans (1 or 0) and object tokens are `int`; dates are `datetime`. In the signatures on this page, `@success`, `@iResult`, `@sResult` and the like are the OUT variables receiving a method's return value, `@iValue` / `@sValue` receive or supply a property value, and the remaining `@` variables are the method's arguments in order.

A string returned through an OUT parameter is limited to 4000 characters. For longer values, retrieve the result as a result set into a table variable instead of an OUT parameter, for example `DECLARE @tmp TABLE (outputLine ntext)` followed by `INSERT INTO @tmp EXEC sp_OAGetProperty @secureString, 'LastErrorText'`. See [string length limitations for strings returned by sp_OAMethod calls](https://www.chilkatsoft.com/sql_server_nvarchar_max_limitation.asp).

Methods that pass or return raw byte arrays are not shown on this page, because `varbinary(max)` values cannot be exchanged through `sp_OAMethod` (see [varbinary(max) limitation](https://www.chilkatsoft.com/sql_server_varbinary_max_limitation.asp)). Use the `BinData`-based alternatives (methods ending in *Bd*) or the base64 / hex string-encoded variants instead. Binary *properties* (such as `LastBinaryResult`) can be retrieved as a result set into a table variable, as shown in their signatures. Asynchronous (*\*Async*) methods and event callbacks are not available from SQL Server.

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 SQL Server.

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` | `EXEC sp_OAGetProperty @secureString, 'DebugLogFilePath', @sValue OUT EXEC sp_OASetProperty @secureString, 'DebugLogFilePath', @sValue` | 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` | `INSERT INTO @tmp EXEC sp_OAGetProperty @secureString, 'LastBinaryResult'` | 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` | `EXEC sp_OAGetProperty @secureString, 'LastErrorHtml', @sValue OUT` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `EXEC sp_OAGetProperty @secureString, 'LastErrorText', @sValue OUT` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `EXEC sp_OAGetProperty @secureString, 'LastErrorXml', @sValue OUT` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `EXEC sp_OAGetProperty @secureString, 'LastMethodSuccess', @iValue OUT EXEC sp_OASetProperty @secureString, 'LastMethodSuccess', @iValue` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `EXEC sp_OAGetProperty @secureString, 'LastStringResult', @sValue OUT` | 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` | `EXEC sp_OAGetProperty @secureString, 'LastStringResultLen', @iValue OUT` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `EXEC sp_OAGetProperty @secureString, 'VerboseLogging', @iValue OUT EXEC sp_OASetProperty @secureString, 'VerboseLogging', @iValue` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `EXEC sp_OAGetProperty @secureString, 'Version', @sValue OUT` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `MaintainHash` | property, read/write | `EXEC sp_OAGetProperty @secureString, 'MaintainHash', @sValue OUT EXEC sp_OASetProperty @secureString, 'MaintainHash', @sValue` |
| `ReadOnly` | property, read/write | `EXEC sp_OAGetProperty @secureString, 'ReadOnly', @iValue OUT EXEC sp_OASetProperty @secureString, 'ReadOnly', @iValue` |
| `Access` | method | `EXEC sp_OAMethod @secureString, 'Access', @sResult OUT` |
| `Append` | method | `EXEC sp_OAMethod @secureString, 'Append', @success OUT, @str` |
| `AppendSb` | method | `EXEC sp_OAMethod @secureString, 'AppendSb', @success OUT, @sb` |
| `AppendSecure` | method | `EXEC sp_OAMethod @secureString, 'AppendSecure', @success OUT, @secStr` |
| `HashVal` | method | `EXEC sp_OAMethod @secureString, 'HashVal', @sResult OUT, @encoding` |
| `LoadFile` | method | `EXEC sp_OAMethod @secureString, 'LoadFile', @success OUT, @path, @charset` |
| `SecStrEquals` | method | `EXEC sp_OAMethod @secureString, 'SecStrEquals', @success OUT, @secStr` |
| `VerifyHash` | method | `EXEC sp_OAMethod @secureString, 'VerifyHash', @success OUT, @hashVal, @encoding` |

## Properties

### SecureString.MaintainHash

`Chilkat 11.7.0 · sqlserver · SecureString · MaintainHash · property · read/write · since 9.5.0.71`

```sql
EXEC sp_OAGetProperty @secureString, 'MaintainHash', @sValue OUT
EXEC sp_OASetProperty @secureString, 'MaintainHash', @sValue
```

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 · sqlserver · SecureString · ReadOnly · property · read/write · since 9.5.0.71`

```sql
EXEC sp_OAGetProperty @secureString, 'ReadOnly', @iValue OUT
EXEC sp_OASetProperty @secureString, 'ReadOnly', @iValue
```

Can be set to `1` to make this secure string read-only (cannot be modified).

## Methods

### SecureString.Access

`Chilkat 11.7.0 · sqlserver · SecureString · Access · method · since 9.5.0.71`

```sql
EXEC sp_OAMethod @secureString, 'Access', @sResult OUT
```

Returns the clear-text string value.

Returns `NULL` on failure

### SecureString.Append

`Chilkat 11.7.0 · sqlserver · SecureString · Append · method · since 9.5.0.71`

```sql
EXEC sp_OAMethod @secureString, 'Append', @success OUT, @str
```

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 `0` if the string has been marked as read-only via the ReadOnly property.

Returns 1 for success, 0 for failure.

### SecureString.AppendSb

`Chilkat 11.7.0 · sqlserver · SecureString · AppendSb · method · since 9.5.0.71`

```sql
EXEC sp_OAMethod @secureString, 'AppendSb', @success OUT, @sb
```

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 `0` if the string has been marked as read-only via the ReadOnly property.

Returns 1 for success, 0 for failure.

### SecureString.AppendSecure

`Chilkat 11.7.0 · sqlserver · SecureString · AppendSecure · method · since 9.5.0.71`

```sql
EXEC sp_OAMethod @secureString, 'AppendSecure', @success OUT, @secStr
```

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 `0` if this string has been marked as read-only via the ReadOnly property.

Returns 1 for success, 0 for failure.

### SecureString.HashVal

`Chilkat 11.7.0 · sqlserver · SecureString · HashVal · method · since 9.5.0.71`

```sql
EXEC sp_OAMethod @secureString, 'HashVal', @sResult OUT, @encoding
```

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 · sqlserver · SecureString · LoadFile · method · since 9.5.0.71`

```sql
EXEC sp_OAMethod @secureString, 'LoadFile', @success OUT, @path, @charset
```

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 1 for success, 0 for failure.

### SecureString.SecStrEquals

`Chilkat 11.7.0 · sqlserver · SecureString · SecStrEquals · method · since 9.5.0.71`

```sql
EXEC sp_OAMethod @secureString, 'SecStrEquals', @success OUT, @secStr
```

Returns `1` if the `secStr` equals the contents of this secure string.

Returns 1 for success, 0 for failure.

### SecureString.VerifyHash

`Chilkat 11.7.0 · sqlserver · SecureString · VerifyHash · method · since 9.5.0.71`

```sql
EXEC sp_OAMethod @secureString, 'VerifyHash', @success OUT, @hashVal, @encoding
```

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 1 for success, 0 for failure.

## Related classes

[`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/sqlserver/classes/StringBuilder.md)

