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

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

**Create/Dispose**

```c
HCkStream instance = CkStream_Create();
// ...
CkStream_Dispose(instance);
```

`HCkStream CkStream_Create(void);`

Creates an instance of the HCkStream object and returns a handle ("void \*" pointer). The handle is passed in the 1st argument for the functions listed on this page.

`void CkStream_Dispose(HCkStream handle);`

Objects created by calling CkStream_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkStream_Dispose.

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.

## 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` | `void CkStream_getDebugLogFilePath(HCkStream cHandle, HCkString retval); void CkStream_putDebugLogFilePath(HCkStream cHandle, const char *newVal); const char *CkStream_debugLogFilePath(HCkStream cHandle);` | 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` | `void CkStream_getLastErrorHtml(HCkStream cHandle, HCkString retval); const char *CkStream_lastErrorHtml(HCkStream cHandle);` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `void CkStream_getLastErrorText(HCkStream cHandle, HCkString retval); const char *CkStream_lastErrorText(HCkStream cHandle);` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `void CkStream_getLastErrorXml(HCkStream cHandle, HCkString retval); const char *CkStream_lastErrorXml(HCkStream cHandle);` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `BOOL CkStream_getLastMethodSuccess(HCkStream cHandle); void CkStream_putLastMethodSuccess(HCkStream cHandle, BOOL newVal);` | read/write | Indicates the success or failure of the most recent method call: `TRUE` means success, `FALSE` means failure. |
| `Utf8` | `BOOL CkStream_getUtf8(HCkStream cHandle); void CkStream_putUtf8(HCkStream cHandle, BOOL newVal);` | read/write | When set to `TRUE`, all `const char *` arguments and return values are interpreted as UTF-8 strings. |
| `VerboseLogging` | `BOOL CkStream_getVerboseLogging(HCkStream cHandle); void CkStream_putVerboseLogging(HCkStream cHandle, BOOL newVal);` | read/write | If set to `TRUE`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `void CkStream_getVersion(HCkStream cHandle, HCkString retval); const char *CkStream_version(HCkStream cHandle);` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AbortCurrent` | property, read/write | `BOOL CkStream_getAbortCurrent(HCkStream cHandle); void CkStream_putAbortCurrent(HCkStream cHandle, BOOL newVal);` |
| `CanRead` | property, read-only | `BOOL CkStream_getCanRead(HCkStream cHandle);` |
| `CanWrite` | property, read-only | `BOOL CkStream_getCanWrite(HCkStream cHandle);` |
| `DataAvailable` | property, read-only | `BOOL CkStream_getDataAvailable(HCkStream cHandle);` |
| `DefaultChunkSize` | property, read/write | `int CkStream_getDefaultChunkSize(HCkStream cHandle); void CkStream_putDefaultChunkSize(HCkStream cHandle, int newVal);` |
| `EndOfStream` | property, read-only | `BOOL CkStream_getEndOfStream(HCkStream cHandle);` |
| `HeartbeatMs` | property, read/write | `int CkStream_getHeartbeatMs(HCkStream cHandle); void CkStream_putHeartbeatMs(HCkStream cHandle, int newVal);` |
| `IsWriteClosed` | property, read-only | `BOOL CkStream_getIsWriteClosed(HCkStream cHandle);` |
| `Length` | property, read/write | `__int64 CkStream_getLength(HCkStream cHandle); void CkStream_putLength(HCkStream cHandle, __int64 newVal);` |
| `Length32` | property, read/write | `int CkStream_getLength32(HCkStream cHandle); void CkStream_putLength32(HCkStream cHandle, int newVal);` |
| `NumReceived` | property, read-only | `__int64 CkStream_getNumReceived(HCkStream cHandle);` |
| `NumSent` | property, read-only | `__int64 CkStream_getNumSent(HCkStream cHandle);` |
| `ReadFailReason` | property, read-only | `int CkStream_getReadFailReason(HCkStream cHandle);` |
| `ReadTimeoutMs` | property, read/write | `int CkStream_getReadTimeoutMs(HCkStream cHandle); void CkStream_putReadTimeoutMs(HCkStream cHandle, int newVal);` |
| `SinkFile` | property, read/write | `void CkStream_getSinkFile(HCkStream cHandle, HCkString retval); void CkStream_putSinkFile(HCkStream cHandle, const char *newVal); const char *CkStream_sinkFile(HCkStream cHandle);` |
| `SinkFileAppend` | property, read/write | `BOOL CkStream_getSinkFileAppend(HCkStream cHandle); void CkStream_putSinkFileAppend(HCkStream cHandle, BOOL newVal);` |
| `SourceFile` | property, read/write | `void CkStream_getSourceFile(HCkStream cHandle, HCkString retval); void CkStream_putSourceFile(HCkStream cHandle, const char *newVal); const char *CkStream_sourceFile(HCkStream cHandle);` |
| `SourceFilePart` | property, read/write | `int CkStream_getSourceFilePart(HCkStream cHandle); void CkStream_putSourceFilePart(HCkStream cHandle, int newVal);` |
| `SourceFilePartSize` | property, read/write | `int CkStream_getSourceFilePartSize(HCkStream cHandle); void CkStream_putSourceFilePartSize(HCkStream cHandle, int newVal);` |
| `StringBom` | property, read/write | `BOOL CkStream_getStringBom(HCkStream cHandle); void CkStream_putStringBom(HCkStream cHandle, BOOL newVal);` |
| `StringCharset` | property, read/write | `void CkStream_getStringCharset(HCkStream cHandle, HCkString retval); void CkStream_putStringCharset(HCkStream cHandle, const char *newVal); const char *CkStream_stringCharset(HCkStream cHandle);` |
| `WriteFailReason` | property, read-only | `int CkStream_getWriteFailReason(HCkStream cHandle);` |
| `WriteTimeoutMs` | property, read/write | `int CkStream_getWriteTimeoutMs(HCkStream cHandle); void CkStream_putWriteTimeoutMs(HCkStream cHandle, int newVal);` |
| `LoadTaskCaller` | method | `BOOL CkStream_LoadTaskCaller(HCkStream cHandle, HCkTask task);` |
| `ReadBd` | method | `BOOL CkStream_ReadBd(HCkStream cHandle, HCkBinData binData);` |
| `ReadBytesENC` | method | `BOOL CkStream_ReadBytesENC(HCkStream cHandle, const char *encoding, HCkString outStr); const char *CkStream_readBytesENC(HCkStream cHandle, const char *encoding);` |
| `ReadNBytesENC` | method | `BOOL CkStream_ReadNBytesENC(HCkStream cHandle, int numBytes, const char *encoding, HCkString outStr); const char *CkStream_readNBytesENC(HCkStream cHandle, int numBytes, const char *encoding);` |
| `ReadSb` | method | `BOOL CkStream_ReadSb(HCkStream cHandle, HCkStringBuilder sb);` |
| `ReadString` | method | `BOOL CkStream_ReadString(HCkStream cHandle, HCkString outStr); const char *CkStream_readString(HCkStream cHandle);` |
| `ReadToCRLF` | method | `BOOL CkStream_ReadToCRLF(HCkStream cHandle, HCkString outStr); const char *CkStream_readToCRLF(HCkStream cHandle);` |
| `ReadUntilMatch` | method | `BOOL CkStream_ReadUntilMatch(HCkStream cHandle, const char *matchStr, HCkString outStr); const char *CkStream_readUntilMatch(HCkStream cHandle, const char *matchStr);` |
| `Reset` | method | `void CkStream_Reset(HCkStream cHandle);` |
| `SetSourceString` | method | `BOOL CkStream_SetSourceString(HCkStream cHandle, const char *srcStr, const char *charset);` |
| `WriteBd` | method | `BOOL CkStream_WriteBd(HCkStream cHandle, HCkBinData binData);` |
| `WriteByte` | method | `BOOL CkStream_WriteByte(HCkStream cHandle, int byteVal);` |
| `WriteBytes2` | method | `BOOL CkStream_WriteBytes2(HCkStream cHandle, const unsigned char *pByteData, unsigned long szByteData);` |
| `WriteBytesENC` | method | `BOOL CkStream_WriteBytesENC(HCkStream cHandle, const char *byteData, const char *encoding);` |
| `WriteClose` | method | `BOOL CkStream_WriteClose(HCkStream cHandle);` |
| `WriteSb` | method | `BOOL CkStream_WriteSb(HCkStream cHandle, HCkStringBuilder sb);` |
| `WriteString` | method | `BOOL CkStream_WriteString(HCkStream cHandle, const char *str);` |

Deprecated members are listed at the end of this file with their replacements; do not use them in new code.

## Properties

### Stream.AbortCurrent

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

```c
BOOL CkStream_getAbortCurrent(HCkStream cHandle);
void CkStream_putAbortCurrent(HCkStream cHandle, BOOL newVal);
```

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

```c
BOOL CkStream_getCanRead(HCkStream cHandle);
```

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

```c
BOOL CkStream_getCanWrite(HCkStream cHandle);
```

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

```c
BOOL CkStream_getDataAvailable(HCkStream cHandle);
```

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

```c
int CkStream_getDefaultChunkSize(HCkStream cHandle);
void CkStream_putDefaultChunkSize(HCkStream cHandle, int newVal);
```

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

```c
BOOL CkStream_getEndOfStream(HCkStream cHandle);
```

`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 · c · Stream · HeartbeatMs · property · read/write · since 9.5.0.97`

```c
int CkStream_getHeartbeatMs(HCkStream cHandle);
void CkStream_putHeartbeatMs(HCkStream cHandle, int newVal);
```

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

```c
BOOL CkStream_getIsWriteClosed(HCkStream cHandle);
```

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

```c
__int64 CkStream_getLength(HCkStream cHandle);
void CkStream_putLength(HCkStream cHandle, __int64 newVal);
```

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

```c
int CkStream_getLength32(HCkStream cHandle);
void CkStream_putLength32(HCkStream cHandle, int newVal);
```

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

```c
__int64 CkStream_getNumReceived(HCkStream cHandle);
```

The number of bytes received by the stream.

### Stream.NumSent

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

```c
__int64 CkStream_getNumSent(HCkStream cHandle);
```

The number of bytes sent by the stream.

### Stream.ReadFailReason

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

```c
int CkStream_getReadFailReason(HCkStream cHandle);
```

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

```c
int CkStream_getReadTimeoutMs(HCkStream cHandle);
void CkStream_putReadTimeoutMs(HCkStream cHandle, int newVal);
```

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

```c
void CkStream_getSinkFile(HCkStream cHandle, HCkString retval);
void CkStream_putSinkFile(HCkStream cHandle, const char *newVal);
const char *CkStream_sinkFile(HCkStream cHandle);
```

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

```c
BOOL CkStream_getSinkFileAppend(HCkStream cHandle);
void CkStream_putSinkFileAppend(HCkStream cHandle, BOOL newVal);
```

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

```c
void CkStream_getSourceFile(HCkStream cHandle, HCkString retval);
void CkStream_putSourceFile(HCkStream cHandle, const char *newVal);
const char *CkStream_sourceFile(HCkStream cHandle);
```

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

```c
int CkStream_getSourceFilePart(HCkStream cHandle);
void CkStream_putSourceFilePart(HCkStream cHandle, int newVal);
```

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

```c
int CkStream_getSourceFilePartSize(HCkStream cHandle);
void CkStream_putSourceFilePartSize(HCkStream cHandle, int newVal);
```

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

```c
BOOL CkStream_getStringBom(HCkStream cHandle);
void CkStream_putStringBom(HCkStream cHandle, BOOL newVal);
```

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

```c
void CkStream_getStringCharset(HCkStream cHandle, HCkString retval);
void CkStream_putStringCharset(HCkStream cHandle, const char *newVal);
const char *CkStream_stringCharset(HCkStream cHandle);
```

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

```c
int CkStream_getWriteFailReason(HCkStream cHandle);
```

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

```c
int CkStream_getWriteTimeoutMs(HCkStream cHandle);
void CkStream_putWriteTimeoutMs(HCkStream cHandle, int newVal);
```

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

```c
BOOL CkStream_LoadTaskCaller(HCkStream cHandle, HCkTask task);
```

Loads the caller of the task's async method.

Returns TRUE for success, FALSE for failure.

### Stream.ReadBd

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

```c
BOOL CkStream_ReadBd(HCkStream cHandle, HCkBinData 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.ReadBytesENC

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

```c
BOOL CkStream_ReadBytesENC(HCkStream cHandle, const char *encoding, HCkString outStr);
const char *CkStream_readBytesENC(HCkStream cHandle, const char *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 TRUE for success, FALSE for failure.

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

### Stream.ReadNBytesENC

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

```c
BOOL CkStream_ReadNBytesENC(HCkStream cHandle, int numBytes, const char *encoding, HCkString outStr);
const char *CkStream_readNBytesENC(HCkStream cHandle, int numBytes, const char *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 TRUE for success, FALSE for failure.

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

### Stream.ReadSb

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

```c
BOOL CkStream_ReadSb(HCkStream cHandle, HCkStringBuilder 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 · c · Stream · ReadString · method · since 9.5.0.56`

```c
BOOL CkStream_ReadString(HCkStream cHandle, HCkString outStr);
const char *CkStream_readString(HCkStream cHandle);
```

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 TRUE for success, FALSE for failure.

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

### Stream.ReadToCRLF

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

```c
BOOL CkStream_ReadToCRLF(HCkStream cHandle, HCkString outStr);
const char *CkStream_readToCRLF(HCkStream cHandle);
```

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 TRUE for success, FALSE for failure.

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

### Stream.ReadUntilMatch

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

```c
BOOL CkStream_ReadUntilMatch(HCkStream cHandle, const char *matchStr, HCkString outStr);
const char *CkStream_readUntilMatch(HCkStream cHandle, const char *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 TRUE for success, FALSE for failure.

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

### Stream.Reset

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

```c
void CkStream_Reset(HCkStream cHandle);
```

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 · c · Stream · SetSourceString · method · since 9.5.0.56`

```c
BOOL CkStream_SetSourceString(HCkStream cHandle, const char *srcStr, const char *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 · c · Stream · WriteBd · method · since 9.5.0.67`

```c
BOOL CkStream_WriteBd(HCkStream cHandle, HCkBinData 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 · c · Stream · WriteByte · method · since 9.5.0.56`

```c
BOOL CkStream_WriteByte(HCkStream cHandle, 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.WriteBytes2

`Chilkat 11.7.0 · c · Stream · WriteBytes2 · method · since 9.5.0.82`

```c
BOOL CkStream_WriteBytes2(HCkStream cHandle, const unsigned char *pByteData, unsigned long szByteData);
```

Writes binary bytes to a stream.

Returns TRUE for success, FALSE for failure.

### Stream.WriteBytesENC

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

```c
BOOL CkStream_WriteBytesENC(HCkStream cHandle, const char *byteData, const char *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 · c · Stream · WriteClose · method · since 9.5.0.56`

```c
BOOL CkStream_WriteClose(HCkStream cHandle);
```

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

Returns TRUE for success, FALSE for failure.

### Stream.WriteSb

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

```c
BOOL CkStream_WriteSb(HCkStream cHandle, HCkStringBuilder 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 · c · Stream · WriteString · method · since 9.5.0.56`

```c
BOOL CkStream_WriteString(HCkStream cHandle, const char *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

This binding delivers progress information through callbacks (AbortCheck, PercentDone, ProgressInfo, TaskCompleted) rather than events. See `guide.md` for how to attach them in C.

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

```c
HCkTask CkStream_ReadBdAsync(HCkStream cHandle, HCkBinData binData);
HCkTask CkStream_ReadBytesENCAsync(HCkStream cHandle, const char *encoding);
HCkTask CkStream_ReadNBytesENCAsync(HCkStream cHandle, int numBytes, const char *encoding);
HCkTask CkStream_ReadSbAsync(HCkStream cHandle, HCkStringBuilder sb);
HCkTask CkStream_ReadStringAsync(HCkStream cHandle);
HCkTask CkStream_ReadToCRLFAsync(HCkStream cHandle);
HCkTask CkStream_ReadUntilMatchAsync(HCkStream cHandle, const char *matchStr);
HCkTask CkStream_WriteBdAsync(HCkStream cHandle, HCkBinData binData);
HCkTask CkStream_WriteByteAsync(HCkStream cHandle, int byteVal);
HCkTask CkStream_WriteBytesENCAsync(HCkStream cHandle, const char *byteData, const char *encoding);
HCkTask CkStream_WriteSbAsync(HCkStream cHandle, HCkStringBuilder sb);
HCkTask CkStream_WriteStringAsync(HCkStream cHandle, const char *str);
```

## Deprecated members — do not use in new code

| Member | Kind | Deprecated in | Use instead |
|---|---|---|---|
| `ReadBytes` | method | before 11.6.1 | — |
| `ReadNBytes` | method | before 11.6.1 | — |
| `SetSourceBytes` | method | before 11.6.1 | — |
| `WriteBytes` | method | before 11.6.1 | — |

## Related classes

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

