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

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

```csharp
Chilkat.Stream obj = new 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 C#.

Minimal complete program:

```csharp
// Required once per process. Any string unlocks a 30-day trial; use your purchased code in production.
Chilkat.Global glob = new Chilkat.Global();
if (!glob.UnlockBundle("Anything for 30-day trial"))
{
    Console.WriteLine(glob.LastErrorText);
    return;
}

Chilkat.Stream stream = new Chilkat.Stream();

bool success = stream.SetSourceString("<srcStr>", "<charset>");
if (!success)
{
    Console.WriteLine(stream.LastErrorText);   // full diagnostic of what went wrong
    return;
}
```

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` | `public string DebugLogFilePath {get; set; }` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastErrorHtml` | `public string LastErrorHtml {get; }` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `public string LastErrorText {get; }` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `public string LastErrorXml {get; }` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `public bool LastMethodSuccess {get; set; }` | read/write | Indicates the success or failure of the most recent method call: `true` means success, `false` means failure. |
| `VerboseLogging` | `public bool VerboseLogging {get; set; }` | read/write | If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `public string Version {get; }` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AbortCurrent` | property, read/write | `public bool AbortCurrent {get; set; }` |
| `CanRead` | property, read-only | `public bool CanRead {get; }` |
| `CanWrite` | property, read-only | `public bool CanWrite {get; }` |
| `DataAvailable` | property, read-only | `public bool DataAvailable {get; }` |
| `DefaultChunkSize` | property, read/write | `public int DefaultChunkSize {get; set; }` |
| `EndOfStream` | property, read-only | `public bool EndOfStream {get; }` |
| `HeartbeatMs` | property, read/write | `public int HeartbeatMs {get; set; }` |
| `IsWriteClosed` | property, read-only | `public bool IsWriteClosed {get; }` |
| `Length` | property, read/write | `public long Length {get; set; }` |
| `Length32` | property, read/write | `public int Length32 {get; set; }` |
| `NumReceived` | property, read-only | `public long NumReceived {get; }` |
| `NumSent` | property, read-only | `public long NumSent {get; }` |
| `ReadFailReason` | property, read-only | `public int ReadFailReason {get; }` |
| `ReadTimeoutMs` | property, read/write | `public int ReadTimeoutMs {get; set; }` |
| `SinkFile` | property, read/write | `public string SinkFile {get; set; }` |
| `SinkFileAppend` | property, read/write | `public bool SinkFileAppend {get; set; }` |
| `SourceFile` | property, read/write | `public string SourceFile {get; set; }` |
| `SourceFilePart` | property, read/write | `public int SourceFilePart {get; set; }` |
| `SourceFilePartSize` | property, read/write | `public int SourceFilePartSize {get; set; }` |
| `StringBom` | property, read/write | `public bool StringBom {get; set; }` |
| `StringCharset` | property, read/write | `public string StringCharset {get; set; }` |
| `WriteFailReason` | property, read-only | `public int WriteFailReason {get; }` |
| `WriteTimeoutMs` | property, read/write | `public int WriteTimeoutMs {get; set; }` |
| `LoadTaskCaller` | method | `public bool LoadTaskCaller(Task task);` |
| `ReadBd` | method | `public bool ReadBd(BinData binData);` |
| `ReadBytes` | method | `public byte[] ReadBytes();` |
| `ReadBytesENC` | method | `public string ReadBytesENC(string encoding);` |
| `ReadNBytes` | method | `public byte[] ReadNBytes(int numBytes);` |
| `ReadNBytesENC` | method | `public string ReadNBytesENC(int numBytes, string encoding);` |
| `ReadSb` | method | `public bool ReadSb(StringBuilder sb);` |
| `ReadString` | method | `public string ReadString();` |
| `ReadToCRLF` | method | `public string ReadToCRLF();` |
| `ReadUntilMatch` | method | `public string ReadUntilMatch(string matchStr);` |
| `Reset` | method | `public void Reset();` |
| `SetSourceBytes` | method | `public bool SetSourceBytes(byte[] sourceData);` |
| `SetSourceString` | method | `public bool SetSourceString(string srcStr, string charset);` |
| `WriteBd` | method | `public bool WriteBd(BinData binData);` |
| `WriteByte` | method | `public bool WriteByte(int byteVal);` |
| `WriteBytes` | method | `public bool WriteBytes(byte[] byteData);` |
| `WriteBytesENC` | method | `public bool WriteBytesENC(string byteData, string encoding);` |
| `WriteClose` | method | `public bool WriteClose();` |
| `WriteSb` | method | `public bool WriteSb(StringBuilder sb);` |
| `WriteString` | method | `public bool WriteString(string str);` |

## Properties

### Stream.AbortCurrent

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

```csharp
public bool AbortCurrent {get; set; }
```

When set to `true`, 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 `false` when the next method is called. When the abort occurs, this property is reset to `false`. 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 · csharp · Stream · CanRead · property · read-only · since 9.5.0.56`

```csharp
public bool CanRead {get; }
```

`true` if the stream supports reading. Otherwise `false`.

**Note:** A stream that supports reading, which has already reached the end-of-stream, will still have a CanRead value of `true`. 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 · csharp · Stream · CanWrite · property · read-only · since 9.5.0.56`

```csharp
public bool CanWrite {get; }
```

`true` if the stream supports writing. Otherwise `false`.

**Note:** A stream that supports writing, which has already been closed for write, will still have a CanWrite value of `true`. 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 · csharp · Stream · DataAvailable · property · read-only · since 9.5.0.56`

```csharp
public bool DataAvailable {get; }
```

`true` if it is known for sure that data is ready and waiting to be read. `false` 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 · csharp · Stream · DefaultChunkSize · property · read/write · since 9.5.0.56`

```csharp
public int DefaultChunkSize {get; set; }
```

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

```csharp
public bool EndOfStream {get; }
```

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

### Stream.HeartbeatMs

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

```csharp
public int HeartbeatMs {get; set; }
```

**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 · csharp · Stream · IsWriteClosed · property · read-only · since 9.5.0.56`

```csharp
public bool IsWriteClosed {get; }
```

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

### Stream.Length

`Chilkat 11.7.0 · csharp · Stream · Length · property · read/write · since 9.5.0.56`

```csharp
public long Length {get; set; }
```

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.

### Stream.Length32

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

```csharp
public int Length32 {get; set; }
```

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

`Chilkat 11.7.0 · csharp · Stream · NumReceived · property · read-only · since 9.5.0.56`

```csharp
public long NumReceived {get; }
```

The number of bytes received by the stream.

### Stream.NumSent

`Chilkat 11.7.0 · csharp · Stream · NumSent · property · read-only · since 9.5.0.56`

```csharp
public long NumSent {get; }
```

The number of bytes sent by the stream.

### Stream.ReadFailReason

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

```csharp
public int ReadFailReason {get; }
```

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

```csharp
public int ReadTimeoutMs {get; set; }
```

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

```csharp
public string SinkFile {get; set; }
```

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

```csharp
public bool SinkFileAppend {get; set; }
```

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

### Stream.SourceFile

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

```csharp
public string SourceFile {get; set; }
```

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

```csharp
public int SourceFilePart {get; set; }
```

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

```csharp
public int SourceFilePartSize {get; set; }
```

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

```csharp
public bool StringBom {get; set; }
```

If `true`, 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 `true`, then include the BOM when writing a string via the WriteString method. The default value of this property is `false`.

### Stream.StringCharset

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

```csharp
public string StringCharset {get; set; }
```

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

```csharp
public int WriteFailReason {get; }
```

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

```csharp
public int WriteTimeoutMs {get; set; }
```

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 · csharp · Stream · LoadTaskCaller · method · since 9.5.0.80`

```csharp
public bool LoadTaskCaller(Task task);
```

Loads the caller of the task's async method.

Returns true for success, false for failure.

### Stream.ReadBd

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

```csharp
public bool ReadBd(BinData 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 true for success, false for failure.

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

### Stream.ReadBytes

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

```csharp
public byte[] ReadBytes();
```

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 an empty byte array on failure

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

### Stream.ReadBytesENC

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

```csharp
public string ReadBytesENC(string 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

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

### Stream.ReadNBytes

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

```csharp
public byte[] ReadNBytes(int numBytes);
```

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

Returns an empty byte array on failure

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

### Stream.ReadNBytesENC

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

```csharp
public string ReadNBytesENC(int numBytes, string 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

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

### Stream.ReadSb

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

```csharp
public bool ReadSb(StringBuilder 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 true for success, false for failure.

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

### Stream.ReadString

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

```csharp
public string ReadString();
```

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

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

### Stream.ReadToCRLF

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

```csharp
public string ReadToCRLF();
```

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

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

### Stream.ReadUntilMatch

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

```csharp
public string ReadUntilMatch(string 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

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

### Stream.Reset

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

```csharp
public void 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 · csharp · Stream · SetSourceBytes · method · since 9.5.0.56`

```csharp
public bool SetSourceBytes(byte[] sourceData);
```

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

Returns true for success, false for failure.

### Stream.SetSourceString

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

```csharp
public bool SetSourceString(string srcStr, string 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 true for success, false for failure.

### Stream.WriteBd

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

```csharp
public bool WriteBd(BinData binData);
```

Writes the contents of `binData` to the stream.

Returns true for success, false for failure.

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

### Stream.WriteByte

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

```csharp
public bool WriteByte(int byteVal);
```

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

Returns true for success, false for failure.

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

### Stream.WriteBytes

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

```csharp
public bool WriteBytes(byte[] byteData);
```

Writes binary bytes to a stream.

Returns true for success, false for failure.

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

### Stream.WriteBytesENC

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

```csharp
public bool WriteBytesENC(string byteData, string 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 true for success, false for failure.

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

### Stream.WriteClose

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

```csharp
public bool WriteClose();
```

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

Returns true for success, false for failure.

### Stream.WriteSb

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

```csharp
public bool WriteSb(StringBuilder 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 true for success, false for failure.

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

### Stream.WriteString

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

```csharp
public bool WriteString(string 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 true for success, false for failure.

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

## Events and callbacks

### Stream.AbortCheck (event)

`Chilkat 11.7.0 · csharp · Stream · AbortCheck · event`

```csharp
public event AbortCheckEventHandler OnAbortCheck;
```

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.

### Chilkat .NET Framework Event Implementation

Args are passed using Chilkat.AbortCheckEventArgs

**Event callback implementation:**

```csharp
private void stream_OnAbortCheck(object sender, Chilkat.AbortCheckEventArgs args)
	{
	    // application code goes here.
	}
```

**To add an event handler:**

```csharp
Chilkat.Stream stream = new Chilkat.Stream();
stream.OnAbortCheck += stream_OnAbortCheck;
```

### Chilkat .NET Core Event Implementation

**Event callback implementation:**

```csharp
public void handleAbortCheck(out bool abort)
	{
	    // application code goes here.
	}
```

**To add an event handler:**

```csharp
Chilkat.Stream stream = new Chilkat.Stream();
// ...
Chilkat.Stream.AbortCheck abortCheck = new Chilkat.Stream.AbortCheck(handleAbortCheck);
stream.setAbortCheckCb(abortCheck);
```

### Stream.PercentDone (event)

`Chilkat 11.7.0 · csharp · Stream · PercentDone · event`

```csharp
public event PercentDoneEventHandler OnPercentDone;
```

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 `true`. This will cause the method to terminate and return a failure status or corresponding failure value.

### Chilkat .NET Framework Event Implementation

Args are passed using Chilkat.PercentDoneEventArgs

**Event callback implementation:**

```csharp
private void stream_OnPercentDone(object sender, Chilkat.PercentDoneEventArgs args)
	{
	    // application code goes here.
	}
```

**To add an event handler:**

```csharp
Chilkat.Stream stream = new Chilkat.Stream();
stream.OnPercentDone += stream_OnPercentDone;
```

### Chilkat .NET Core Event Implementation

**Event callback implementation:**

```csharp
public void handlePercentDone(int pctDone, out bool abort)
	{
	    // application code goes here.
	}
```

**To add an event handler:**

```csharp
Chilkat.Stream stream = new Chilkat.Stream();
// ...
Chilkat.Stream.PercentDone percentDone = new Chilkat.Stream.PercentDone(handlePercentDone);
stream.setPercentDoneCb(percentDone);
```

### Stream.ProgressInfo (event)

`Chilkat 11.7.0 · csharp · Stream · ProgressInfo · event`

```csharp
public event ProgressInfoEventHandler OnProgressInfo;
```

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.

### Chilkat .NET Framework Event Implementation

Args are passed using Chilkat.ProgressInfoEventArgs

**Event callback implementation:**

```csharp
private void stream_OnProgressInfo(object sender, Chilkat.ProgressInfoEventArgs args)
	{
	    // application code goes here.
	}
```

**To add an event handler:**

```csharp
Chilkat.Stream stream = new Chilkat.Stream();
stream.OnProgressInfo += stream_OnProgressInfo;
```

### Chilkat .NET Core Event Implementation

**Event callback implementation:**

```csharp
public void handleProgressInfo(string name, string value)
	{
	    // application code goes here.
	}
```

**To add an event handler:**

```csharp
Chilkat.Stream stream = new Chilkat.Stream();
// ...
Chilkat.Stream.ProgressInfo progressInfo = new Chilkat.Stream.ProgressInfo(handleProgressInfo);
stream.setProgressInfoCb(progressInfo);
```

### Stream.TaskCompleted (event)

`Chilkat 11.7.0 · csharp · Stream · TaskCompleted · event`

```csharp
public event TaskCompletedEventHandler OnTaskCompleted;
```

Called from the background thread when an asynchronous task completes.

### Chilkat .NET Framework Event Implementation

Args are passed using Chilkat.TaskCompletedEventArgs

**Event callback implementation:**

```csharp
private void stream_OnTaskCompleted(object sender, Chilkat.TaskCompletedEventArgs args)
	{
	    // application code goes here.
	}
```

**To add an event handler:**

```csharp
Chilkat.Stream stream = new Chilkat.Stream();
stream.OnTaskCompleted += stream_OnTaskCompleted;
```

### Chilkat .NET Core Event Implementation

**Event callback implementation:**

```csharp
public void handleTaskIdCompleted(int taskId)
	{
	    // application code goes here.
	}
```

**To add an event handler:**

```csharp
Chilkat.Stream stream = new Chilkat.Stream();
// ...
Chilkat.Stream.TaskIdCompleted taskIdCompleted = new Chilkat.Stream.TaskIdCompleted(handleTaskIdCompleted);
stream.setTaskIdCompletedCb(taskIdCompleted);
```

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

```csharp
public Task ReadBdAsync(BinData binData);
public Task ReadBytesAsync();
public Task ReadBytesENCAsync(string encoding);
public Task ReadNBytesAsync(int numBytes);
public Task ReadNBytesENCAsync(int numBytes, string encoding);
public Task ReadSbAsync(StringBuilder sb);
public Task ReadStringAsync();
public Task ReadToCRLFAsync();
public Task ReadUntilMatchAsync(string matchStr);
public Task WriteBdAsync(BinData binData);
public Task WriteByteAsync(int byteVal);
public Task WriteBytesAsync(byte[] byteData);
public Task WriteBytesENCAsync(string byteData, string encoding);
public Task WriteSbAsync(StringBuilder sb);
public Task WriteStringAsync(string str);
```

## Related classes

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

