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

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

## Purpose

**Read, write, pipe, monitor, and control byte or text streams.**

`Chilkat.Stream` is a general-purpose streaming object for moving data between sources and sinks without requiring the entire payload to be handled at once. A stream can read from files, byte arrays, strings, or other sources; write to files, memory, `BinData`, `StringBuilder`, or other sinks; handle binary and text data; apply character-set rules for strings; process file parts; track bytes sent and received; and support timeouts, polling, aborts, async task integration, and end-of-stream handling.

**File and memory sources**

Stream from a source file, byte array, string, or selected file part without manually loading or copying all data first.

**File and object sinks**

Write streamed data to a sink file, append to an existing file, or output to `BinData`, `StringBuilder`, bytes, or strings.

**Binary reads and writes**

Read or write raw bytes, fixed byte counts, encoded byte strings, individual bytes, or `BinData` content.

**Text streaming**

Read and write strings using `StringCharset`, optionally use a BOM, and read text until CRLF or a matching delimiter.

**Timeouts and polling**

Control read and write wait behavior, poll for immediately available data, and inspect read or write failure reasons.

**Progress and lifecycle**

Track bytes sent and received, detect end-of-stream or write-closed state, reset streams, close writing, and abort long-running operations.

**Common pattern:** Configure the stream's source and sink, set the character set or chunk size if needed, then read or write using the method that matches the data type: bytes, encoded bytes, strings, `BinData`, or `StringBuilder`. Check `EndOfStream`, `ReadFailReason`, `WriteFailReason`, `NumReceived`, `NumSent`, and `LastErrorText` to understand stream progress and failures.

**Timeout note:** For `ReadTimeoutMs`, a value of `0` means a polling read, not an infinite timeout. For `WriteTimeoutMs`, `0` means return immediately if the stream cannot be written to right away.

## Object creation, unlocking and error handling

**Object Creation**

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

-- ... use @stream ...

EXEC @hr = sp_OADestroy @stream
```

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.Stream.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 @stream, '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 @stream, 'DebugLogFilePath', @sValue OUT EXEC sp_OASetProperty @stream, '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 @stream, '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 @stream, 'LastErrorHtml', @sValue OUT` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `EXEC sp_OAGetProperty @stream, 'LastErrorText', @sValue OUT` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `EXEC sp_OAGetProperty @stream, 'LastErrorXml', @sValue OUT` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `EXEC sp_OAGetProperty @stream, 'LastMethodSuccess', @iValue OUT EXEC sp_OASetProperty @stream, '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 @stream, '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 @stream, 'LastStringResultLen', @iValue OUT` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `EXEC sp_OAGetProperty @stream, 'VerboseLogging', @iValue OUT EXEC sp_OASetProperty @stream, '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 @stream, 'Version', @sValue OUT` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AbortCurrent` | property, read/write | `EXEC sp_OAGetProperty @stream, 'AbortCurrent', @iValue OUT EXEC sp_OASetProperty @stream, 'AbortCurrent', @iValue` |
| `CanRead` | property, read-only | `EXEC sp_OAGetProperty @stream, 'CanRead', @iValue OUT` |
| `CanWrite` | property, read-only | `EXEC sp_OAGetProperty @stream, 'CanWrite', @iValue OUT` |
| `DataAvailable` | property, read-only | `EXEC sp_OAGetProperty @stream, 'DataAvailable', @iValue OUT` |
| `DefaultChunkSize` | property, read/write | `EXEC sp_OAGetProperty @stream, 'DefaultChunkSize', @iValue OUT EXEC sp_OASetProperty @stream, 'DefaultChunkSize', @iValue` |
| `EndOfStream` | property, read-only | `EXEC sp_OAGetProperty @stream, 'EndOfStream', @iValue OUT` |
| `IsWriteClosed` | property, read-only | `EXEC sp_OAGetProperty @stream, 'IsWriteClosed', @iValue OUT` |
| `Length32` | property, read/write | `EXEC sp_OAGetProperty @stream, 'Length32', @iValue OUT EXEC sp_OASetProperty @stream, 'Length32', @iValue` |
| `ReadFailReason` | property, read-only | `EXEC sp_OAGetProperty @stream, 'ReadFailReason', @iValue OUT` |
| `ReadTimeoutMs` | property, read/write | `EXEC sp_OAGetProperty @stream, 'ReadTimeoutMs', @iValue OUT EXEC sp_OASetProperty @stream, 'ReadTimeoutMs', @iValue` |
| `SinkFile` | property, read/write | `EXEC sp_OAGetProperty @stream, 'SinkFile', @sValue OUT EXEC sp_OASetProperty @stream, 'SinkFile', @sValue` |
| `SinkFileAppend` | property, read/write | `EXEC sp_OAGetProperty @stream, 'SinkFileAppend', @iValue OUT EXEC sp_OASetProperty @stream, 'SinkFileAppend', @iValue` |
| `SourceFile` | property, read/write | `EXEC sp_OAGetProperty @stream, 'SourceFile', @sValue OUT EXEC sp_OASetProperty @stream, 'SourceFile', @sValue` |
| `SourceFilePart` | property, read/write | `EXEC sp_OAGetProperty @stream, 'SourceFilePart', @iValue OUT EXEC sp_OASetProperty @stream, 'SourceFilePart', @iValue` |
| `SourceFilePartSize` | property, read/write | `EXEC sp_OAGetProperty @stream, 'SourceFilePartSize', @iValue OUT EXEC sp_OASetProperty @stream, 'SourceFilePartSize', @iValue` |
| `StringBom` | property, read/write | `EXEC sp_OAGetProperty @stream, 'StringBom', @iValue OUT EXEC sp_OASetProperty @stream, 'StringBom', @iValue` |
| `StringCharset` | property, read/write | `EXEC sp_OAGetProperty @stream, 'StringCharset', @sValue OUT EXEC sp_OASetProperty @stream, 'StringCharset', @sValue` |
| `WriteFailReason` | property, read-only | `EXEC sp_OAGetProperty @stream, 'WriteFailReason', @iValue OUT` |
| `WriteTimeoutMs` | property, read/write | `EXEC sp_OAGetProperty @stream, 'WriteTimeoutMs', @iValue OUT EXEC sp_OASetProperty @stream, 'WriteTimeoutMs', @iValue` |
| `ReadBd` | method | `EXEC sp_OAMethod @stream, 'ReadBd', @success OUT, @binData` |
| `ReadBytesENC` | method | `EXEC sp_OAMethod @stream, 'ReadBytesENC', @sResult OUT, @encoding` |
| `ReadNBytesENC` | method | `EXEC sp_OAMethod @stream, 'ReadNBytesENC', @sResult OUT, @numBytes, @encoding` |
| `ReadSb` | method | `EXEC sp_OAMethod @stream, 'ReadSb', @success OUT, @sb` |
| `ReadString` | method | `EXEC sp_OAMethod @stream, 'ReadString', @sResult OUT` |
| `ReadToCRLF` | method | `EXEC sp_OAMethod @stream, 'ReadToCRLF', @sResult OUT` |
| `ReadUntilMatch` | method | `EXEC sp_OAMethod @stream, 'ReadUntilMatch', @sResult OUT, @matchStr` |
| `Reset` | method | `EXEC sp_OAMethod @stream, 'Reset', NULL` |
| `SetSourceString` | method | `EXEC sp_OAMethod @stream, 'SetSourceString', @success OUT, @srcStr, @charset` |
| `ToDecimalStr` | method | `EXEC sp_OAMethod @stream, 'ToDecimalStr', @sResult OUT, @propertyName` |
| `WriteBd` | method | `EXEC sp_OAMethod @stream, 'WriteBd', @success OUT, @binData` |
| `WriteByte` | method | `EXEC sp_OAMethod @stream, 'WriteByte', @success OUT, @byteVal` |
| `WriteBytesENC` | method | `EXEC sp_OAMethod @stream, 'WriteBytesENC', @success OUT, @byteData, @encoding` |
| `WriteClose` | method | `EXEC sp_OAMethod @stream, 'WriteClose', @success OUT` |
| `WriteSb` | method | `EXEC sp_OAMethod @stream, 'WriteSb', @success OUT, @sb` |
| `WriteString` | method | `EXEC sp_OAMethod @stream, 'WriteString', @success OUT, @str` |

## Properties

### Stream.AbortCurrent

`Chilkat 11.7.0 · sqlserver · Stream · AbortCurrent · property · read/write · since 9.5.0.58`

```sql
EXEC sp_OAGetProperty @stream, 'AbortCurrent', @iValue OUT
EXEC sp_OASetProperty @stream, 'AbortCurrent', @iValue
```

When set to `1`, causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to `0` when the next method is called. When the abort occurs, this property is reset to `0`. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

### Stream.CanRead

`Chilkat 11.7.0 · sqlserver · Stream · CanRead · property · read-only · since 9.5.0.56`

```sql
EXEC sp_OAGetProperty @stream, 'CanRead', @iValue OUT
```

`1` if the stream supports reading. Otherwise `0`.

**Note:** A stream that supports reading, which has already reached the end-of-stream, will still have a CanRead value of `1`. This property indicates the stream's inherent ability, and not whether or not the stream can be read at a particular moment in time.

### Stream.CanWrite

`Chilkat 11.7.0 · sqlserver · Stream · CanWrite · property · read-only · since 9.5.0.56`

```sql
EXEC sp_OAGetProperty @stream, 'CanWrite', @iValue OUT
```

`1` if the stream supports writing. Otherwise `0`.

**Note:** A stream that supports writing, which has already been closed for write, will still have a CanWrite value of `1`. This property indicates the stream's inherent ability, and not whether or not the stream can be written at a particular moment in time.

### Stream.DataAvailable

`Chilkat 11.7.0 · sqlserver · Stream · DataAvailable · property · read-only · since 9.5.0.56`

```sql
EXEC sp_OAGetProperty @stream, 'DataAvailable', @iValue OUT
```

`1` if it is known for sure that data is ready and waiting to be read. `0` if it is not known for sure (it may be that data is immediately available, but reading the stream with a ReadTimeoutMs of 0, which is to poll the stream, is the way to find out).

### Stream.DefaultChunkSize

`Chilkat 11.7.0 · sqlserver · Stream · DefaultChunkSize · property · read/write · since 9.5.0.56`

```sql
EXEC sp_OAGetProperty @stream, 'DefaultChunkSize', @iValue OUT
EXEC sp_OASetProperty @stream, 'DefaultChunkSize', @iValue
```

The default internal chunk size for reading or writing. The default value is 65536. If this property is set to 0, it will cause the default chunk size (65536) to be used. Note: The chunk size can have significant performance impact. If performance is an issue, be sure to experiment with different chunk sizes.

### Stream.EndOfStream

`Chilkat 11.7.0 · sqlserver · Stream · EndOfStream · property · read-only · since 9.5.0.56`

```sql
EXEC sp_OAGetProperty @stream, 'EndOfStream', @iValue OUT
```

`1` if the end-of-stream has already been reached. When the stream has already ended, all calls to Read\* methods will return `0` with the ReadFailReason set to 3 (already at end-of-stream).

### Stream.IsWriteClosed

`Chilkat 11.7.0 · sqlserver · Stream · IsWriteClosed · property · read-only · since 9.5.0.56`

```sql
EXEC sp_OAGetProperty @stream, 'IsWriteClosed', @iValue OUT
```

`1` if the stream is closed for writing. Once closed, no more data may be written to the stream.

### Stream.Length32

`Chilkat 11.7.0 · sqlserver · Stream · Length32 · property · read/write · since 9.5.0.58`

```sql
EXEC sp_OAGetProperty @stream, 'Length32', @iValue OUT
EXEC sp_OASetProperty @stream, 'Length32', @iValue
```

The length (in bytes) of the stream's source. If unknown, then this property will have a value of -1. This property may be set by the application if it knows in advance the length of the stream.

Setting this property also sets the Length property (which is a 64-bit integer).

### Stream.ReadFailReason

`Chilkat 11.7.0 · sqlserver · Stream · ReadFailReason · property · read-only · since 9.5.0.56`

```sql
EXEC sp_OAGetProperty @stream, 'ReadFailReason', @iValue OUT
```

This property is automatically set when a Read\* method is called. It indicates the reason for failure. Possible values are:

0>
0. No failure (success)
1. Timeout, or no data is immediately available for a polling read.
2. Aborted by an application callback.
3. Already at end-of-stream.
4. Fatal stream error.
5. Out-of-memory error (this is very unlikely).

### Stream.ReadTimeoutMs

`Chilkat 11.7.0 · sqlserver · Stream · ReadTimeoutMs · property · read/write · since 9.5.0.56`

```sql
EXEC sp_OAGetProperty @stream, 'ReadTimeoutMs', @iValue OUT
EXEC sp_OASetProperty @stream, 'ReadTimeoutMs', @iValue
```

The maximum number of seconds to wait while reading. The default value is 30 seconds (i.e. 30000ms). A value of 0 indicates a poll. (A polling read is to return with a timeout if no data is immediately available.)

**Important:** For most Chilkat timeout related properties, a value of 0 indicates an infinite timeout. For this property, a value of 0 indicates a poll. If setting a timeout related property (or method argument) to zero, be sure to understand if 0 means `wait forever` or `poll`.

The timeout value is not a total timeout. It is the maximum time to wait while no additional data is forthcoming.

### Stream.SinkFile

`Chilkat 11.7.0 · sqlserver · Stream · SinkFile · property · read/write · since 9.5.0.56`

```sql
EXEC sp_OAGetProperty @stream, 'SinkFile', @sValue OUT
EXEC sp_OASetProperty @stream, 'SinkFile', @sValue
```

Sets the sink to the path of a file. The file does not need to exist at the time of setting this property. The sink file will be automatically opened on demand, when the stream is first written.

**Note:** This property takes priority over other potential sinks. Make sure this property is set to an empty string if the stream's sink is to be something else.

### Stream.SinkFileAppend

`Chilkat 11.7.0 · sqlserver · Stream · SinkFileAppend · property · read/write · since 9.5.0.83`

```sql
EXEC sp_OAGetProperty @stream, 'SinkFileAppend', @iValue OUT
EXEC sp_OASetProperty @stream, 'SinkFileAppend', @iValue
```

If `1`, the stream appends to the SinkFile rather than truncating and re-writing the sink file. The default value is `0`.

### Stream.SourceFile

`Chilkat 11.7.0 · sqlserver · Stream · SourceFile · property · read/write · since 9.5.0.56`

```sql
EXEC sp_OAGetProperty @stream, 'SourceFile', @sValue OUT
EXEC sp_OASetProperty @stream, 'SourceFile', @sValue
```

Sets the source to the path of a file. The file does not need to exist at the time of setting this property. The source file will be automatically opened on demand, when the stream is first read.

**Note:** This property takes priority over other potential sources. Make sure this property is set to an empty string if the stream's source is to be something else.

### Stream.SourceFilePart

`Chilkat 11.7.0 · sqlserver · Stream · SourceFilePart · property · read/write · since 9.5.0.59`

```sql
EXEC sp_OAGetProperty @stream, 'SourceFilePart', @iValue OUT
EXEC sp_OASetProperty @stream, 'SourceFilePart', @iValue
```

If the source is a file, then this property can be used to stream one part of the file. The SourceFilePartSize property defines the size (in bytes) of each part. The SourceFilePart and SourceFilePartSize have default values of 0, which means the entire SourceFile is streamed.

This property is a 0-based index. For example, if the SourceFilePartSize is 1000, then part 0 is for bytes 0 to 999, part 1 is for bytes 1000 to 1999, etc.

### Stream.SourceFilePartSize

`Chilkat 11.7.0 · sqlserver · Stream · SourceFilePartSize · property · read/write · since 9.5.0.59`

```sql
EXEC sp_OAGetProperty @stream, 'SourceFilePartSize', @iValue OUT
EXEC sp_OASetProperty @stream, 'SourceFilePartSize', @iValue
```

If the source is a file, then this property, in conjunction with the SourceFilePart property, can be used to stream a single part of the file. This property defines the size (in bytes) of each part. The SourceFilePart and SourceFilePartSize have default values of 0, which means that by default, the entire SourceFile is streamed.

### Stream.StringBom

`Chilkat 11.7.0 · sqlserver · Stream · StringBom · property · read/write · since 9.5.0.56`

```sql
EXEC sp_OAGetProperty @stream, 'StringBom', @iValue OUT
EXEC sp_OASetProperty @stream, 'StringBom', @iValue
```

If `1`, then include the BOM when creating a string source via SetSourceString where the charset is utf-8, utf-16, etc. (The term `BOM` stands for Byte Order Mark, also known as the preamble.) Also, if `1`, then include the BOM when writing a string via the WriteString method. The default value of this property is `0`.

### Stream.StringCharset

`Chilkat 11.7.0 · sqlserver · Stream · StringCharset · property · read/write · since 9.5.0.56`

```sql
EXEC sp_OAGetProperty @stream, 'StringCharset', @sValue OUT
EXEC sp_OASetProperty @stream, 'StringCharset', @sValue
```

Indicates the expected character encoding, such as utf-8, windows-1256, utf-16, etc. for methods that read text such as: ReadString, ReadToCRLF, ReadUntilMatch. Also controls the character encoding when writing strings with the WriteString method. The supported charsets are indicated at the link below.

The default value is `utf-8`.

See also:

- [Charsets Supported by Chilkat](http://www.cknotes.com/chilkat-charsets-character-encodings-supported/)

### Stream.WriteFailReason

`Chilkat 11.7.0 · sqlserver · Stream · WriteFailReason · property · read-only · since 9.5.0.56`

```sql
EXEC sp_OAGetProperty @stream, 'WriteFailReason', @iValue OUT
```

This property is automatically set when a Write\* method is called. It indicates the reason for failure. Possible values are:

0>
0. No failure (success)
1. Timeout, or unable to immediately write when the WriteTimeoutMs is 0.
2. Aborted by an application callback.
3. The stream has already ended.
4. Fatal stream error.
5. Out-of-memory error (this is very unlikely).

### Stream.WriteTimeoutMs

`Chilkat 11.7.0 · sqlserver · Stream · WriteTimeoutMs · property · read/write · since 9.5.0.56`

```sql
EXEC sp_OAGetProperty @stream, 'WriteTimeoutMs', @iValue OUT
EXEC sp_OASetProperty @stream, 'WriteTimeoutMs', @iValue
```

The maximum number of seconds to wait while writing. The default value is 30 seconds (i.e. 30000ms). A value of 0 indicates to return immediately if it is not possible to write to the sink immediately.

## Methods

### Stream.ReadBd

`Chilkat 11.7.0 · sqlserver · Stream · ReadBd · method · since 9.5.0.67`

```sql
EXEC sp_OAMethod @stream, 'ReadBd', @success OUT, @binData
```

Read as much data as is immediately available on the stream. If no data is immediately available, it waits up to ReadTimeoutMs milliseconds for data to arrive. The incoming data is appended to `binData`.

Returns 1 for success, 0 for failure.

### Stream.ReadBytesENC

`Chilkat 11.7.0 · sqlserver · Stream · ReadBytesENC · method · since 9.5.0.56`

```sql
EXEC sp_OAMethod @stream, 'ReadBytesENC', @sResult OUT, @encoding
```

**Full documentation for this method (same in every language):** [Binary Encodings Supported by Chilkat](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/binary_encodings.md)

The same as ReadBytes, except returns the received bytes in encoded string form. The `encoding` argument indicates the encoding, which can be `base64`, `hex`, or any of the multitude of encodings indicated in the link below.

Returns `NULL` on failure

### Stream.ReadNBytesENC

`Chilkat 11.7.0 · sqlserver · Stream · ReadNBytesENC · method · since 9.5.0.56`

```sql
EXEC sp_OAMethod @stream, 'ReadNBytesENC', @sResult OUT, @numBytes, @encoding
```

**Full documentation for this method (same in every language):** [Binary Encodings Supported by Chilkat](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/binary_encodings.md)

The same as ReadNBytes, except returns the received bytes in encoded string form. The `encoding` argument indicates the encoding, which can be `base64`, `hex`, or any of the multitude of encodings indicated in the link below.

Returns `NULL` on failure

### Stream.ReadSb

`Chilkat 11.7.0 · sqlserver · Stream · ReadSb · method · since 9.5.0.67`

```sql
EXEC sp_OAMethod @stream, 'ReadSb', @success OUT, @sb
```

Read as much data as is immediately available on the stream. If no data is immediately available, it waits up to ReadTimeoutMs milliseconds for data to arrive. The data is appended to `sb`. The incoming bytes are interpreted according to the StringCharset property. For example, if utf-8 bytes are expected, then StringCharset should be set to `utf-8` prior to calling ReadSb.

Returns 1 for success, 0 for failure.

### Stream.ReadString

`Chilkat 11.7.0 · sqlserver · Stream · ReadString · method · since 9.5.0.56`

```sql
EXEC sp_OAMethod @stream, 'ReadString', @sResult OUT
```

Read as much data as is immediately available on the stream. If no data is immediately available, it waits up to ReadTimeoutMs milliseconds for data to arrive. The data is returned as a string. The incoming bytes are interpreted according to the StringCharset property. For example, if utf-8 bytes are expected, then StringCharset should be set to `utf-8` prior to calling ReadString.

Returns `NULL` on failure

### Stream.ReadToCRLF

`Chilkat 11.7.0 · sqlserver · Stream · ReadToCRLF · method · since 9.5.0.56`

```sql
EXEC sp_OAMethod @stream, 'ReadToCRLF', @sResult OUT
```

Reads the stream until a CRLF is received. If no data is immediately available, it waits up to ReadTimeoutMs milliseconds for data to arrive. The data is returned as a string. The incoming bytes are interpreted according to the StringCharset property. For example, if utf-8 bytes are expected, then StringCharset should be set to `utf-8` prior to calling ReadString.

Note: If the end-of-stream is reached prior to receiving the CRLF, then the remaining data is returned, and the ReadFailReason property will be set to 3 (to indicate end-of-file). This is the only case where as string would be returned that does not end with CRLF.

Returns `NULL` on failure

### Stream.ReadUntilMatch

`Chilkat 11.7.0 · sqlserver · Stream · ReadUntilMatch · method · since 9.5.0.56`

```sql
EXEC sp_OAMethod @stream, 'ReadUntilMatch', @sResult OUT, @matchStr
```

Reads the stream until the string indicated by `matchStr` is received. If no data is immediately available, it waits up to ReadTimeoutMs milliseconds for data to arrive. The data is returned as a string. The incoming bytes are interpreted according to the StringCharset property. For example, if utf-8 bytes are expected, then StringCharset should be set to `utf-8` prior to calling ReadString.

Note: If the end-of-stream is reached prior to receiving the match string, then the remaining data is returned, and the ReadFailReason property will be set to 3 (to indicate end-of-file). This is the only case where as string would be returned that does not end with the desired match string.

Returns `NULL` on failure

### Stream.Reset

`Chilkat 11.7.0 · sqlserver · Stream · Reset · method · since 9.5.0.56`

```sql
EXEC sp_OAMethod @stream, 'Reset', NULL
```

Resets the stream. If a source or sink is open, then it is closed. Properties such as EndOfStream and IsWriteClose are reset to default values.

### Stream.SetSourceString

`Chilkat 11.7.0 · sqlserver · Stream · SetSourceString · method · since 9.5.0.56`

```sql
EXEC sp_OAMethod @stream, 'SetSourceString', @success OUT, @srcStr, @charset
```

Sets the stream's source to the contents of `srcStr`. The `charset` indicates the character encoding to be used for the byte representation of the `srcStr`.

Returns 1 for success, 0 for failure.

### Stream.ToDecimalStr

`Chilkat 11.7.0 · sqlserver · Stream · ToDecimalStr · method · since 9.5.0.56`

```sql
EXEC sp_OAMethod @stream, 'ToDecimalStr', @sResult OUT, @propertyName
```

Some programming languages do not support 64-bit integers. The following properties are implemented as 64-bit ints: Length, NumReceived, NumSent. The value of these properties can be retrieved in decimal string form by passing the property name in `propertyName`.

Returns `NULL` on failure

### Stream.WriteBd

`Chilkat 11.7.0 · sqlserver · Stream · WriteBd · method · since 9.5.0.67`

```sql
EXEC sp_OAMethod @stream, 'WriteBd', @success OUT, @binData
```

Writes the contents of `binData` to the stream.

Returns 1 for success, 0 for failure.

### Stream.WriteByte

`Chilkat 11.7.0 · sqlserver · Stream · WriteByte · method · since 9.5.0.56`

```sql
EXEC sp_OAMethod @stream, 'WriteByte', @success OUT, @byteVal
```

Writes a single byte to the stream. The `byteVal` must have a value from 0 to 255.

Returns 1 for success, 0 for failure.

### Stream.WriteBytesENC

`Chilkat 11.7.0 · sqlserver · Stream · WriteBytesENC · method · since 9.5.0.56`

```sql
EXEC sp_OAMethod @stream, 'WriteBytesENC', @success OUT, @byteData, @encoding
```

**Full documentation for this method (same in every language):** [Binary Encodings Supported by Chilkat](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/binary_encodings.md)

Writes binary bytes to a stream. The byte data is passed in encoded string form, where the `encoding` can be `base64`, `hex`, or any of the supported binary encodings listed at the link below.

Returns 1 for success, 0 for failure.

### Stream.WriteClose

`Chilkat 11.7.0 · sqlserver · Stream · WriteClose · method · since 9.5.0.56`

```sql
EXEC sp_OAMethod @stream, 'WriteClose', @success OUT
```

Indicates that no more data will be written to the stream.

Returns 1 for success, 0 for failure.

### Stream.WriteSb

`Chilkat 11.7.0 · sqlserver · Stream · WriteSb · method · since 9.5.0.67`

```sql
EXEC sp_OAMethod @stream, 'WriteSb', @success OUT, @sb
```

Writes the contents of `sb` to the stream. The actual bytes written are the byte representation of the string as indicated by the StringCharset property. For example, to write utf-8 bytes, first set StringCharset equal to `utf-8` and then call WriteSb.

Returns 1 for success, 0 for failure.

### Stream.WriteString

`Chilkat 11.7.0 · sqlserver · Stream · WriteString · method · since 9.5.0.56`

```sql
EXEC sp_OAMethod @stream, 'WriteString', @success OUT, @str
```

Writes a string to a stream. The actual bytes written are the byte representation of the string as indicated by the StringCharset property. For example, to write utf-8 bytes, first set StringCharset equal to `utf-8` and then call WriteString.

Returns 1 for success, 0 for failure.

## Events and callbacks

This binding has no event callbacks.

## Related classes

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

