---
product: Chilkat
product_version: 11.7.0
language: delphidll
language_label: Delphi DLL
class: Stream
license: free
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/dd_CkStreamRef.html
---
# Chilkat Stream — Delphi DLL — v11.7.0

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

```pascal
var
myObject: HCkStream;

begin
myObject := CkStream_Create();

// ...

CkStream_Dispose(myObject);
end;
```

`function CkStream_Create: HCkStream; stdcall;`

Creates an instance of the HCkStream object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

`procedure CkStream_Dispose(handle: HCkStream); stdcall;`

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.

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 Delphi DLL.

## 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` | `procedure CkStream_getDebugLogFilePath(objHandle: HCkStream; outPropVal: HCkString); stdcall; procedure CkStream_putDebugLogFilePath(objHandle: HCkStream; newPropVal: PWideChar); stdcall; function CkStream__debugLogFilePath(objHandle: HCkStream): PWideChar; stdcall;` | 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` | `procedure CkStream_getLastErrorHtml(objHandle: HCkStream; outPropVal: HCkString); stdcall; function CkStream__lastErrorHtml(objHandle: HCkStream): PWideChar; stdcall;` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `procedure CkStream_getLastErrorText(objHandle: HCkStream; outPropVal: HCkString); stdcall; function CkStream__lastErrorText(objHandle: HCkStream): PWideChar; stdcall;` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `procedure CkStream_getLastErrorXml(objHandle: HCkStream; outPropVal: HCkString); stdcall; function CkStream__lastErrorXml(objHandle: HCkStream): PWideChar; stdcall;` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `function CkStream_getLastMethodSuccess(objHandle: HCkStream): wordbool; stdcall; procedure CkStream_putLastMethodSuccess(objHandle: HCkStream; newPropVal: wordbool); stdcall;` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. |
| `VerboseLogging` | `function CkStream_getVerboseLogging(objHandle: HCkStream): wordbool; stdcall; procedure CkStream_putVerboseLogging(objHandle: HCkStream; newPropVal: wordbool); stdcall;` | read/write | If set to `True`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `procedure CkStream_getVersion(objHandle: HCkStream; outPropVal: HCkString); stdcall; function CkStream__version(objHandle: HCkStream): PWideChar; stdcall;` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AbortCurrent` | property, read/write | `function CkStream_getAbortCurrent(objHandle: HCkStream): wordbool; stdcall; procedure CkStream_putAbortCurrent(objHandle: HCkStream; newPropVal: wordbool); stdcall;` |
| `CanRead` | property, read-only | `function CkStream_getCanRead(objHandle: HCkStream): wordbool; stdcall;` |
| `CanWrite` | property, read-only | `function CkStream_getCanWrite(objHandle: HCkStream): wordbool; stdcall;` |
| `DataAvailable` | property, read-only | `function CkStream_getDataAvailable(objHandle: HCkStream): wordbool; stdcall;` |
| `DefaultChunkSize` | property, read/write | `function CkStream_getDefaultChunkSize(objHandle: HCkStream): Integer; stdcall; procedure CkStream_putDefaultChunkSize(objHandle: HCkStream; newPropVal: Integer); stdcall;` |
| `EndOfStream` | property, read-only | `function CkStream_getEndOfStream(objHandle: HCkStream): wordbool; stdcall;` |
| `HeartbeatMs` | property, read/write | `function CkStream_getHeartbeatMs(objHandle: HCkStream): Integer; stdcall; procedure CkStream_putHeartbeatMs(objHandle: HCkStream; newPropVal: Integer); stdcall;` |
| `IsWriteClosed` | property, read-only | `function CkStream_getIsWriteClosed(objHandle: HCkStream): wordbool; stdcall;` |
| `Length` | property, read/write | `function CkStream_getLength(objHandle: HCkStream): Int64; stdcall; procedure CkStream_putLength(objHandle: HCkStream; newPropVal: Int64); stdcall;` |
| `Length32` | property, read/write | `function CkStream_getLength32(objHandle: HCkStream): Integer; stdcall; procedure CkStream_putLength32(objHandle: HCkStream; newPropVal: Integer); stdcall;` |
| `NumReceived` | property, read-only | `function CkStream_getNumReceived(objHandle: HCkStream): Int64; stdcall;` |
| `NumSent` | property, read-only | `function CkStream_getNumSent(objHandle: HCkStream): Int64; stdcall;` |
| `ReadFailReason` | property, read-only | `function CkStream_getReadFailReason(objHandle: HCkStream): Integer; stdcall;` |
| `ReadTimeoutMs` | property, read/write | `function CkStream_getReadTimeoutMs(objHandle: HCkStream): Integer; stdcall; procedure CkStream_putReadTimeoutMs(objHandle: HCkStream; newPropVal: Integer); stdcall;` |
| `SinkFile` | property, read/write | `procedure CkStream_getSinkFile(objHandle: HCkStream; outPropVal: HCkString); stdcall; procedure CkStream_putSinkFile(objHandle: HCkStream; newPropVal: PWideChar); stdcall; function CkStream__sinkFile(objHandle: HCkStream): PWideChar; stdcall;` |
| `SinkFileAppend` | property, read/write | `function CkStream_getSinkFileAppend(objHandle: HCkStream): wordbool; stdcall; procedure CkStream_putSinkFileAppend(objHandle: HCkStream; newPropVal: wordbool); stdcall;` |
| `SourceFile` | property, read/write | `procedure CkStream_getSourceFile(objHandle: HCkStream; outPropVal: HCkString); stdcall; procedure CkStream_putSourceFile(objHandle: HCkStream; newPropVal: PWideChar); stdcall; function CkStream__sourceFile(objHandle: HCkStream): PWideChar; stdcall;` |
| `SourceFilePart` | property, read/write | `function CkStream_getSourceFilePart(objHandle: HCkStream): Integer; stdcall; procedure CkStream_putSourceFilePart(objHandle: HCkStream; newPropVal: Integer); stdcall;` |
| `SourceFilePartSize` | property, read/write | `function CkStream_getSourceFilePartSize(objHandle: HCkStream): Integer; stdcall; procedure CkStream_putSourceFilePartSize(objHandle: HCkStream; newPropVal: Integer); stdcall;` |
| `StringBom` | property, read/write | `function CkStream_getStringBom(objHandle: HCkStream): wordbool; stdcall; procedure CkStream_putStringBom(objHandle: HCkStream; newPropVal: wordbool); stdcall;` |
| `StringCharset` | property, read/write | `procedure CkStream_getStringCharset(objHandle: HCkStream; outPropVal: HCkString); stdcall; procedure CkStream_putStringCharset(objHandle: HCkStream; newPropVal: PWideChar); stdcall; function CkStream__stringCharset(objHandle: HCkStream): PWideChar; stdcall;` |
| `WriteFailReason` | property, read-only | `function CkStream_getWriteFailReason(objHandle: HCkStream): Integer; stdcall;` |
| `WriteTimeoutMs` | property, read/write | `function CkStream_getWriteTimeoutMs(objHandle: HCkStream): Integer; stdcall; procedure CkStream_putWriteTimeoutMs(objHandle: HCkStream; newPropVal: Integer); stdcall;` |
| `LoadTaskCaller` | method | `function CkStream_LoadTaskCaller(objHandle: HCkStream;     task: HCkTask): wordbool; stdcall;` |
| `ReadBd` | method | `function CkStream_ReadBd(objHandle: HCkStream;     binData: HCkBinData): wordbool; stdcall;` |
| `ReadBytesENC` | method | `function CkStream_ReadBytesENC(objHandle: HCkStream;     encoding: PWideChar;     outStr: HCkString): wordbool; stdcall; function CkStream__readBytesENC(objHandle: HCkStream;     encoding: PWideChar): PWideChar; stdcall;` |
| `ReadNBytesENC` | method | `function CkStream_ReadNBytesENC(objHandle: HCkStream;     numBytes: Integer;     encoding: PWideChar;     outStr: HCkString): wordbool; stdcall; function CkStream__readNBytesENC(objHandle: HCkStream;     numBytes: Integer;     encoding: PWideChar): PWideChar; stdcall;` |
| `ReadSb` | method | `function CkStream_ReadSb(objHandle: HCkStream;     sb: HCkStringBuilder): wordbool; stdcall;` |
| `ReadString` | method | `function CkStream_ReadString(objHandle: HCkStream;     outStr: HCkString): wordbool; stdcall; function CkStream__readString(objHandle: HCkStream): PWideChar; stdcall;` |
| `ReadToCRLF` | method | `function CkStream_ReadToCRLF(objHandle: HCkStream;     outStr: HCkString): wordbool; stdcall; function CkStream__readToCRLF(objHandle: HCkStream): PWideChar; stdcall;` |
| `ReadUntilMatch` | method | `function CkStream_ReadUntilMatch(objHandle: HCkStream;     matchStr: PWideChar;     outStr: HCkString): wordbool; stdcall; function CkStream__readUntilMatch(objHandle: HCkStream;     matchStr: PWideChar): PWideChar; stdcall;` |
| `Reset` | method | `procedure CkStream_Reset(objHandle: HCkStream) stdcall;` |
| `SetSourceString` | method | `function CkStream_SetSourceString(objHandle: HCkStream;     srcStr: PWideChar;     charset: PWideChar): wordbool; stdcall;` |
| `WriteBd` | method | `function CkStream_WriteBd(objHandle: HCkStream;     binData: HCkBinData): wordbool; stdcall;` |
| `WriteByte` | method | `function CkStream_WriteByte(objHandle: HCkStream;     byteVal: Integer): wordbool; stdcall;` |
| `WriteBytesENC` | method | `function CkStream_WriteBytesENC(objHandle: HCkStream;     byteData: PWideChar;     encoding: PWideChar): wordbool; stdcall;` |
| `WriteClose` | method | `function CkStream_WriteClose(objHandle: HCkStream): wordbool; stdcall;` |
| `WriteSb` | method | `function CkStream_WriteSb(objHandle: HCkStream;     sb: HCkStringBuilder): wordbool; stdcall;` |
| `WriteString` | method | `function CkStream_WriteString(objHandle: HCkStream;     str: PWideChar): wordbool; stdcall;` |

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

```pascal
function CkStream_getAbortCurrent(objHandle: HCkStream): wordbool; stdcall;
procedure CkStream_putAbortCurrent(objHandle: HCkStream; newPropVal: wordbool); stdcall;
```

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

```pascal
function CkStream_getCanRead(objHandle: HCkStream): wordbool; stdcall;
```

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

```pascal
function CkStream_getCanWrite(objHandle: HCkStream): wordbool; stdcall;
```

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

```pascal
function CkStream_getDataAvailable(objHandle: HCkStream): wordbool; stdcall;
```

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

```pascal
function CkStream_getDefaultChunkSize(objHandle: HCkStream): Integer; stdcall;
procedure CkStream_putDefaultChunkSize(objHandle: HCkStream; newPropVal: Integer); stdcall;
```

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

```pascal
function CkStream_getEndOfStream(objHandle: HCkStream): wordbool; stdcall;
```

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

```pascal
function CkStream_getHeartbeatMs(objHandle: HCkStream): Integer; stdcall;
procedure CkStream_putHeartbeatMs(objHandle: HCkStream; newPropVal: Integer); stdcall;
```

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

```pascal
function CkStream_getIsWriteClosed(objHandle: HCkStream): wordbool; stdcall;
```

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

```pascal
function CkStream_getLength(objHandle: HCkStream): Int64; stdcall;
procedure CkStream_putLength(objHandle: HCkStream; newPropVal: Int64); stdcall;
```

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

```pascal
function CkStream_getLength32(objHandle: HCkStream): Integer; stdcall;
procedure CkStream_putLength32(objHandle: HCkStream; newPropVal: Integer); stdcall;
```

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

```pascal
function CkStream_getNumReceived(objHandle: HCkStream): Int64; stdcall;
```

The number of bytes received by the stream.

### Stream.NumSent

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

```pascal
function CkStream_getNumSent(objHandle: HCkStream): Int64; stdcall;
```

The number of bytes sent by the stream.

### Stream.ReadFailReason

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

```pascal
function CkStream_getReadFailReason(objHandle: HCkStream): Integer; stdcall;
```

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

```pascal
function CkStream_getReadTimeoutMs(objHandle: HCkStream): Integer; stdcall;
procedure CkStream_putReadTimeoutMs(objHandle: HCkStream; newPropVal: Integer); stdcall;
```

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

```pascal
procedure CkStream_getSinkFile(objHandle: HCkStream; outPropVal: HCkString); stdcall;
procedure CkStream_putSinkFile(objHandle: HCkStream; newPropVal: PWideChar); stdcall;
function CkStream__sinkFile(objHandle: HCkStream): PWideChar; stdcall;
```

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

```pascal
function CkStream_getSinkFileAppend(objHandle: HCkStream): wordbool; stdcall;
procedure CkStream_putSinkFileAppend(objHandle: HCkStream; newPropVal: wordbool); stdcall;
```

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

```pascal
procedure CkStream_getSourceFile(objHandle: HCkStream; outPropVal: HCkString); stdcall;
procedure CkStream_putSourceFile(objHandle: HCkStream; newPropVal: PWideChar); stdcall;
function CkStream__sourceFile(objHandle: HCkStream): PWideChar; stdcall;
```

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

```pascal
function CkStream_getSourceFilePart(objHandle: HCkStream): Integer; stdcall;
procedure CkStream_putSourceFilePart(objHandle: HCkStream; newPropVal: Integer); stdcall;
```

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

```pascal
function CkStream_getSourceFilePartSize(objHandle: HCkStream): Integer; stdcall;
procedure CkStream_putSourceFilePartSize(objHandle: HCkStream; newPropVal: Integer); stdcall;
```

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

```pascal
function CkStream_getStringBom(objHandle: HCkStream): wordbool; stdcall;
procedure CkStream_putStringBom(objHandle: HCkStream; newPropVal: wordbool); stdcall;
```

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

```pascal
procedure CkStream_getStringCharset(objHandle: HCkStream; outPropVal: HCkString); stdcall;
procedure CkStream_putStringCharset(objHandle: HCkStream; newPropVal: PWideChar); stdcall;
function CkStream__stringCharset(objHandle: HCkStream): PWideChar; stdcall;
```

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

```pascal
function CkStream_getWriteFailReason(objHandle: HCkStream): Integer; stdcall;
```

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

```pascal
function CkStream_getWriteTimeoutMs(objHandle: HCkStream): Integer; stdcall;
procedure CkStream_putWriteTimeoutMs(objHandle: HCkStream; newPropVal: Integer); stdcall;
```

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

```pascal
function CkStream_LoadTaskCaller(objHandle: HCkStream;
    task: HCkTask): wordbool; stdcall;
```

Loads the caller of the task's async method.

Returns True for success, False for failure.

### Stream.ReadBd

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

```pascal
function CkStream_ReadBd(objHandle: HCkStream;
    binData: HCkBinData): wordbool; stdcall;
```

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 · delphidll · Stream · ReadBytesENC · method · since 9.5.0.56`

```pascal
function CkStream_ReadBytesENC(objHandle: HCkStream;
    encoding: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkStream__readBytesENC(objHandle: HCkStream;
    encoding: PWideChar): PWideChar; stdcall;
```

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

See the notes about [PWideChar memory ownership and validity](https://www.chilkatsoft.com/delphi_pwidechar.asp).

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

### Stream.ReadNBytesENC

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

```pascal
function CkStream_ReadNBytesENC(objHandle: HCkStream;
    numBytes: Integer;
    encoding: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkStream__readNBytesENC(objHandle: HCkStream;
    numBytes: Integer;
    encoding: PWideChar): PWideChar; stdcall;
```

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

See the notes about [PWideChar memory ownership and validity](https://www.chilkatsoft.com/delphi_pwidechar.asp).

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

### Stream.ReadSb

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

```pascal
function CkStream_ReadSb(objHandle: HCkStream;
    sb: HCkStringBuilder): wordbool; stdcall;
```

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 · delphidll · Stream · ReadString · method · since 9.5.0.56`

```pascal
function CkStream_ReadString(objHandle: HCkStream;
    outStr: HCkString): wordbool; stdcall;
function CkStream__readString(objHandle: HCkStream): PWideChar; stdcall;
```

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.

See the notes about [PWideChar memory ownership and validity](https://www.chilkatsoft.com/delphi_pwidechar.asp).

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

### Stream.ReadToCRLF

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

```pascal
function CkStream_ReadToCRLF(objHandle: HCkStream;
    outStr: HCkString): wordbool; stdcall;
function CkStream__readToCRLF(objHandle: HCkStream): PWideChar; stdcall;
```

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.

See the notes about [PWideChar memory ownership and validity](https://www.chilkatsoft.com/delphi_pwidechar.asp).

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

### Stream.ReadUntilMatch

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

```pascal
function CkStream_ReadUntilMatch(objHandle: HCkStream;
    matchStr: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkStream__readUntilMatch(objHandle: HCkStream;
    matchStr: PWideChar): PWideChar; stdcall;
```

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.

See the notes about [PWideChar memory ownership and validity](https://www.chilkatsoft.com/delphi_pwidechar.asp).

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

### Stream.Reset

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

```pascal
procedure CkStream_Reset(objHandle: HCkStream) stdcall;
```

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

```pascal
function CkStream_SetSourceString(objHandle: HCkStream;
    srcStr: PWideChar;
    charset: PWideChar): wordbool; stdcall;
```

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 · delphidll · Stream · WriteBd · method · since 9.5.0.67`

```pascal
function CkStream_WriteBd(objHandle: HCkStream;
    binData: HCkBinData): wordbool; stdcall;
```

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 · delphidll · Stream · WriteByte · method · since 9.5.0.56`

```pascal
function CkStream_WriteByte(objHandle: HCkStream;
    byteVal: Integer): wordbool; stdcall;
```

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

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

```pascal
function CkStream_WriteBytesENC(objHandle: HCkStream;
    byteData: PWideChar;
    encoding: PWideChar): wordbool; stdcall;
```

**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 · delphidll · Stream · WriteClose · method · since 9.5.0.56`

```pascal
function CkStream_WriteClose(objHandle: HCkStream): wordbool; stdcall;
```

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

Returns True for success, False for failure.

### Stream.WriteSb

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

```pascal
function CkStream_WriteSb(objHandle: HCkStream;
    sb: HCkStringBuilder): wordbool; stdcall;
```

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 · delphidll · Stream · WriteString · method · since 9.5.0.56`

```pascal
function CkStream_WriteString(objHandle: HCkStream;
    str: PWideChar): wordbool; stdcall;
```

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 · delphidll · Stream · AbortCheck · event`

```pascal
function MyAbortCheck(): Integer; cdecl;
```

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. Return `True` to abort; return `False` to continue (not abort)

### Stream.PercentDone (event)

`Chilkat 11.7.0 · delphidll · Stream · PercentDone · event`

```pascal
function MyPercentDone(pctDone: Integer): Integer; cdecl;
```

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.

Return `True` to abort; return `False` to continue (not abort)

### Stream.ProgressInfo (event)

`Chilkat 11.7.0 · delphidll · Stream · ProgressInfo · event`

```pascal
procedure MyProgressInfo(name: PWideChar; value: PWideChar) cdecl;
```

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.

### Stream.TaskCompleted (event)

`Chilkat 11.7.0 · delphidll · Stream · TaskCompleted · event`

```pascal
procedure MyTaskCompleted(task: HCkTask) cdecl;
```

Called from the background thread when an asynchronous task completes.

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

```pascal
function CkStream_ReadBdAsync(objHandle: HCkStream;
    binData: HCkBinData): HCkTask; stdcall;
function CkStream_ReadBytesENCAsync(objHandle: HCkStream;
    encoding: PWideChar): HCkTask; stdcall;
function CkStream_ReadNBytesENCAsync(objHandle: HCkStream;
    numBytes: Integer;
    encoding: PWideChar): HCkTask; stdcall;
function CkStream_ReadSbAsync(objHandle: HCkStream;
    sb: HCkStringBuilder): HCkTask; stdcall;
function CkStream_ReadStringAsync(objHandle: HCkStream): HCkTask; stdcall;
function CkStream_ReadToCRLFAsync(objHandle: HCkStream): HCkTask; stdcall;
function CkStream_ReadUntilMatchAsync(objHandle: HCkStream;
    matchStr: PWideChar): HCkTask; stdcall;
function CkStream_WriteBdAsync(objHandle: HCkStream;
    binData: HCkBinData): HCkTask; stdcall;
function CkStream_WriteByteAsync(objHandle: HCkStream;
    byteVal: Integer): HCkTask; stdcall;
function CkStream_WriteBytesENCAsync(objHandle: HCkStream;
    byteData: PWideChar;
    encoding: PWideChar): HCkTask; stdcall;
function CkStream_WriteSbAsync(objHandle: HCkStream;
    sb: HCkStringBuilder): HCkTask; stdcall;
function CkStream_WriteStringAsync(objHandle: HCkStream;
    str: PWideChar): HCkTask; stdcall;
```

## 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/delphidll/classes/BinData.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/delphidll/classes/StringBuilder.md), [`Task`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/delphidll/classes/Task.md)

