---
product: Chilkat
product_version: 11.7.0
language: activex
language_label: ActiveX
class: Stream
license: free
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/xChilkatStreamRef.html
---
# Chilkat Stream — ActiveX — v11.7.0

> Chilkat 11.7.0 · language=activex · 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/activex/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**

```clike
Note:
For a specific major version, use "Chilkat.Stream.<major_version>", such as "Chilkat.Stream.10" for Chilkat v10.*.*
See Chilkat ActiveX Object Creation

(ASP)
set obj = Server.CreateObject("Chilkat.Stream")

(AutoIt)
$obj = ObjCreate("Chilkat.Stream")

(Visual Basic 6.0)
Dim obj As New ChilkatStream

(VBScript)
set obj = CreateObject("Chilkat.Stream")

(VBA, such as Excel)
Dim obj As New ChilkatStream
See How to Use ActiveX in Excel

(Delphi)
obj := TChilkatStream.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat.Stream')

(Xbase++)
oObject := CreateObject("Chilkat.Stream")

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat.Stream")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat.Stream', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat.Stream");
```

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 ActiveX.

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

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AbortCurrent` | property, read/write | `AbortCurrent As Long` |
| `CanRead` | property, read-only | `CanRead As Long (read-only)` |
| `CanWrite` | property, read-only | `CanWrite As Long (read-only)` |
| `DataAvailable` | property, read-only | `DataAvailable As Long (read-only)` |
| `DefaultChunkSize` | property, read/write | `DefaultChunkSize As Long` |
| `EndOfStream` | property, read-only | `EndOfStream As Long (read-only)` |
| `HeartbeatMs` | property, read/write | `HeartbeatMs As Long` |
| `IsWriteClosed` | property, read-only | `IsWriteClosed As Long (read-only)` |
| `Length32` | property, read/write | `Length32 As Long` |
| `ReadFailReason` | property, read-only | `ReadFailReason As Long (read-only)` |
| `ReadTimeoutMs` | property, read/write | `ReadTimeoutMs As Long` |
| `SinkFile` | property, read/write | `SinkFile As String` |
| `SinkFileAppend` | property, read/write | `SinkFileAppend As Long` |
| `SourceFile` | property, read/write | `SourceFile As String` |
| `SourceFilePart` | property, read/write | `SourceFilePart As Long` |
| `SourceFilePartSize` | property, read/write | `SourceFilePartSize As Long` |
| `StringBom` | property, read/write | `StringBom As Long` |
| `StringCharset` | property, read/write | `StringCharset As String` |
| `WriteFailReason` | property, read-only | `WriteFailReason As Long (read-only)` |
| `WriteTimeoutMs` | property, read/write | `WriteTimeoutMs As Long` |
| `LoadTaskCaller` | method | `LoadTaskCaller(task As ChilkatTask) As Long` |
| `ReadBd` | method | `ReadBd(binData As ChilkatBinData) As Long` |
| `ReadBytes` | method | `ReadBytes() As Variant` |
| `ReadBytesENC` | method | `ReadBytesENC(encoding As String) As String` |
| `ReadNBytes` | method | `ReadNBytes(ByVal numBytes As Long) As Variant` |
| `ReadNBytesENC` | method | `ReadNBytesENC(ByVal numBytes As Long, encoding As String) As String` |
| `ReadSb` | method | `ReadSb(sb As ChilkatStringBuilder) As Long` |
| `ReadString` | method | `ReadString() As String` |
| `ReadToCRLF` | method | `ReadToCRLF() As String` |
| `ReadUntilMatch` | method | `ReadUntilMatch(matchStr As String) As String` |
| `Reset` | method | `Reset()` |
| `SetSourceBytes` | method | `SetSourceBytes(sourceData As Variant) As Long` |
| `SetSourceString` | method | `SetSourceString(srcStr As String, charset As String) As Long` |
| `ToDecimalStr` | method | `ToDecimalStr(propertyName As String) As String` |
| `WriteBd` | method | `WriteBd(binData As ChilkatBinData) As Long` |
| `WriteByte` | method | `WriteByte(ByVal byteVal As Long) As Long` |
| `WriteBytes` | method | `WriteBytes(byteData As Variant) As Long` |
| `WriteBytesENC` | method | `WriteBytesENC(byteData As String, encoding As String) As Long` |
| `WriteClose` | method | `WriteClose() As Long` |
| `WriteSb` | method | `WriteSb(sb As ChilkatStringBuilder) As Long` |
| `WriteString` | method | `WriteString(str As String) As Long` |

## Properties

### Stream.AbortCurrent

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

```
AbortCurrent As Long
```

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 · activex · Stream · CanRead · property · read-only · since 9.5.0.56`

```
CanRead As Long (read-only)
```

`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 · activex · Stream · CanWrite · property · read-only · since 9.5.0.56`

```
CanWrite As Long (read-only)
```

`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 · activex · Stream · DataAvailable · property · read-only · since 9.5.0.56`

```
DataAvailable As Long (read-only)
```

`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 · activex · Stream · DefaultChunkSize · property · read/write · since 9.5.0.56`

```
DefaultChunkSize As Long
```

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 · activex · Stream · EndOfStream · property · read-only · since 9.5.0.56`

```
EndOfStream As Long (read-only)
```

`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.HeartbeatMs

`Chilkat 11.7.0 · activex · Stream · HeartbeatMs · property · read/write · since 9.5.0.97`

```
HeartbeatMs As Long
```

**Full documentation for this property (same in every language):** [Event Callback Examples](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/event_callback_examples.md)

The interval in milliseconds between each `AbortCheck` event callback, which enables an application to abort certain method calls before they complete. **By default, HeartbeatMs is set to** `0`**, meaning no AbortCheck event callbacks will trigger.**

### Stream.IsWriteClosed

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

```
IsWriteClosed As Long (read-only)
```

`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 · activex · Stream · Length32 · property · read/write · since 9.5.0.58`

```
Length32 As Long
```

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 · activex · Stream · ReadFailReason · property · read-only · since 9.5.0.56`

```
ReadFailReason As Long (read-only)
```

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 · activex · Stream · ReadTimeoutMs · property · read/write · since 9.5.0.56`

```
ReadTimeoutMs As Long
```

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 · activex · Stream · SinkFile · property · read/write · since 9.5.0.56`

```
SinkFile As String
```

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 · activex · Stream · SinkFileAppend · property · read/write · since 9.5.0.83`

```
SinkFileAppend As Long
```

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 · activex · Stream · SourceFile · property · read/write · since 9.5.0.56`

```
SourceFile As String
```

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 · activex · Stream · SourceFilePart · property · read/write · since 9.5.0.59`

```
SourceFilePart As Long
```

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 · activex · Stream · SourceFilePartSize · property · read/write · since 9.5.0.59`

```
SourceFilePartSize As Long
```

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 · activex · Stream · StringBom · property · read/write · since 9.5.0.56`

```
StringBom As Long
```

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 · activex · Stream · StringCharset · property · read/write · since 9.5.0.56`

```
StringCharset As String
```

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 · activex · Stream · WriteFailReason · property · read-only · since 9.5.0.56`

```
WriteFailReason As Long (read-only)
```

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 · activex · Stream · WriteTimeoutMs · property · read/write · since 9.5.0.56`

```
WriteTimeoutMs As Long
```

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.LoadTaskCaller

`Chilkat 11.7.0 · activex · Stream · LoadTaskCaller · method · since 9.5.0.80`

```
LoadTaskCaller(task As ChilkatTask) As Long
```

Loads the caller of the task's async method.

Returns 1 for success, 0 for failure.

### Stream.ReadBd

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

```
ReadBd(binData As ChilkatBinData) As Long
```

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.

Async variant: `ReadBdAsync` — same arguments, returns a `Task` (see Async variants below).

### Stream.ReadBytes

`Chilkat 11.7.0 · activex · Stream · ReadBytes · method · since 9.5.0.56`

```
ReadBytes() As Variant
```

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.

Returns a zero-length byte array (as a Variant) on failure.  
An empty array will have a UBound of -1 meaning 0 elements.

Async variant: `ReadBytesAsync` — same arguments, returns a `Task` (see Async variants below).

### Stream.ReadBytesENC

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

```
ReadBytesENC(encoding As String) As String
```

**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 `Nothing` on failure

Async variant: `ReadBytesENCAsync` — same arguments, returns a `Task` (see Async variants below).

### Stream.ReadNBytes

`Chilkat 11.7.0 · activex · Stream · ReadNBytes · method · since 9.5.0.56`

```
ReadNBytes(ByVal numBytes As Long) As Variant
```

Reads exactly `numBytes` bytes from the stream. If no data is immediately available, it waits up to ReadTimeoutMs milliseconds for data to arrive.

Returns a zero-length byte array (as a Variant) on failure.  
An empty array will have a UBound of -1 meaning 0 elements.

Async variant: `ReadNBytesAsync` — same arguments, returns a `Task` (see Async variants below).

### Stream.ReadNBytesENC

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

```
ReadNBytesENC(ByVal numBytes As Long, encoding As String) As String
```

**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 `Nothing` on failure

Async variant: `ReadNBytesENCAsync` — same arguments, returns a `Task` (see Async variants below).

### Stream.ReadSb

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

```
ReadSb(sb As ChilkatStringBuilder) As Long
```

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.

Async variant: `ReadSbAsync` — same arguments, returns a `Task` (see Async variants below).

### Stream.ReadString

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

```
ReadString() As String
```

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 `Nothing` on failure

Async variant: `ReadStringAsync` — same arguments, returns a `Task` (see Async variants below).

### Stream.ReadToCRLF

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

```
ReadToCRLF() As String
```

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 `Nothing` on failure

Async variant: `ReadToCRLFAsync` — same arguments, returns a `Task` (see Async variants below).

### Stream.ReadUntilMatch

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

```
ReadUntilMatch(matchStr As String) As String
```

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 `Nothing` on failure

Async variant: `ReadUntilMatchAsync` — same arguments, returns a `Task` (see Async variants below).

### Stream.Reset

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

```
Reset()
```

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.SetSourceBytes

`Chilkat 11.7.0 · activex · Stream · SetSourceBytes · method · since 9.5.0.56`

```
SetSourceBytes(sourceData As Variant) As Long
```

Sets the stream's source to the contents of `sourceData`.

Returns 1 for success, 0 for failure.

### Stream.SetSourceString

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

```
SetSourceString(srcStr As String, charset As String) As Long
```

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 · activex · Stream · ToDecimalStr · method · since 9.5.0.56`

```
ToDecimalStr(propertyName As String) As String
```

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 `Nothing` on failure

### Stream.WriteBd

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

```
WriteBd(binData As ChilkatBinData) As Long
```

Writes the contents of `binData` to the stream.

Returns 1 for success, 0 for failure.

Async variant: `WriteBdAsync` — same arguments, returns a `Task` (see Async variants below).

### Stream.WriteByte

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

```
WriteByte(ByVal byteVal As Long) As Long
```

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

Returns 1 for success, 0 for failure.

Async variant: `WriteByteAsync` — same arguments, returns a `Task` (see Async variants below).

### Stream.WriteBytes

`Chilkat 11.7.0 · activex · Stream · WriteBytes · method · since 9.5.0.56`

```
WriteBytes(byteData As Variant) As Long
```

Writes binary bytes to a stream.

Returns 1 for success, 0 for failure.

Async variant: `WriteBytesAsync` — same arguments, returns a `Task` (see Async variants below).

### Stream.WriteBytesENC

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

```
WriteBytesENC(byteData As String, encoding As String) As Long
```

**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.

Async variant: `WriteBytesENCAsync` — same arguments, returns a `Task` (see Async variants below).

### Stream.WriteClose

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

```
WriteClose() As Long
```

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

Returns 1 for success, 0 for failure.

### Stream.WriteSb

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

```
WriteSb(sb As ChilkatStringBuilder) As Long
```

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.

Async variant: `WriteSbAsync` — same arguments, returns a `Task` (see Async variants below).

### Stream.WriteString

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

```
WriteString(str As String) As Long
```

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.

Async variant: `WriteStringAsync` — same arguments, returns a `Task` (see Async variants below).

## Events and callbacks

### Stream.AbortCheck (event)

`Chilkat 11.7.0 · activex · Stream · AbortCheck · event`

```
AbortCheck(abort As Long)
```

Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the `HeartbeatMs` property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second.

**VB6 Event callback implementation:**

**Important:** Event callbacks from ***asynchronous method calls*** are generally not possible from the ActiveX. See [VB6 Event Callbacks](https://www.chilkatsoft.com/vb6_event_callbacks.asp)

```vb
Dim WithEvents myStream As ChilkatStream

Private Sub myStream_AbortCheck(abort As Long)

	'Insert application code here.

End Sub
```

### Stream.PercentDone (event)

`Chilkat 11.7.0 · activex · Stream · PercentDone · event`

```
PercentDone(ByVal pctDone As Long, abort As Long)
```

This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The `pctDone` argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have `pctDone` equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).

The PercentDone callback also acts as an `AbortCheck` event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.

To abort the operation, set the `abort` output argument to `1`. This will cause the method to terminate and return a failure status or corresponding failure value.

**VB6 Event callback implementation:**

**Important:** Event callbacks from ***asynchronous method calls*** are generally not possible from the ActiveX. See [VB6 Event Callbacks](https://www.chilkatsoft.com/vb6_event_callbacks.asp)

```vb
Dim WithEvents myStream As ChilkatStream

Private Sub myStream_PercentDone(ByVal pctDone As Long, abort As Long)

	'Insert application code here.

End Sub
```

### Stream.ProgressInfo (event)

`Chilkat 11.7.0 · activex · Stream · ProgressInfo · event`

```
ProgressInfo(ByVal name As String, ByVal value As String)
```

This event callback provides `tag name`/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.

Note: Some Chilkat methods don't fire any ProgressInfo events.

**VB6 Event callback implementation:**

**Important:** Event callbacks from ***asynchronous method calls*** are generally not possible from the ActiveX. See [VB6 Event Callbacks](https://www.chilkatsoft.com/vb6_event_callbacks.asp)

```vb
Dim WithEvents myStream As ChilkatStream

Private Sub myStream_ProgressInfo(ByVal name As String, ByVal value As String)

	'Insert application code here.

End Sub
```

### Stream.TaskCompleted (event)

`Chilkat 11.7.0 · activex · Stream · TaskCompleted · event`

```
TaskCompleted(task As ChilkatTask)
```

Called from the background thread when an asynchronous task completes.

**VB6 Event callback implementation:**

**Important:** Event callbacks from ***asynchronous method calls*** are generally not possible from the ActiveX. See [VB6 Event Callbacks](https://www.chilkatsoft.com/vb6_event_callbacks.asp)

```vb
Dim WithEvents myStream As ChilkatStream

Private Sub myStream_TaskCompleted(task As ChilkatTask)

	'Insert application code here.

End Sub
```

## Async variants

Each returns a `Task` instead of the result and takes the same arguments as the synchronous method; run the task, wait for `Finished`, then read the result from the task. No new Async methods are added from 11.7.0 on.

```
ReadBdAsync(binData As ChilkatBinData) As ChilkatTask
ReadBytesAsync() As ChilkatTask
ReadBytesENCAsync(encoding As String) As ChilkatTask
ReadNBytesAsync(ByVal numBytes As Long) As ChilkatTask
ReadNBytesENCAsync(ByVal numBytes As Long, encoding As String) As ChilkatTask
ReadSbAsync(sb As ChilkatStringBuilder) As ChilkatTask
ReadStringAsync() As ChilkatTask
ReadToCRLFAsync() As ChilkatTask
ReadUntilMatchAsync(matchStr As String) As ChilkatTask
WriteBdAsync(binData As ChilkatBinData) As ChilkatTask
WriteByteAsync(ByVal byteVal As Long) As ChilkatTask
WriteBytesAsync(byteData As Variant) As ChilkatTask
WriteBytesENCAsync(byteData As String, encoding As String) As ChilkatTask
WriteSbAsync(sb As ChilkatStringBuilder) As ChilkatTask
WriteStringAsync(str As String) As ChilkatTask
```

## Related classes

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

