Stream ActiveX Reference Documentation

Stream

Provides a generic class for streaming from a source to a sink. Streams can be connected together where the sink of one feeds to the source of another.

Note: This class was added in Chilkat v9.5.0.56. Initially it will seem somewhat useless, but over time, streaming functionality will be added to existing Chilkat classes and will be prevalent in new Chilkat classes.

Object Creation

(Visual Basic 6.0)
Dim obj As New ChilkatStream

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

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

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

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

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

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

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

Properties

AbortCurrent As Long

Introduced in version 9.5.0.58

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

CanRead As Long (read-only)

Introduced in version 9.5.0.56

1 if the stream supports reading. Otherwise 0.

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

CanWrite As Long (read-only)

Introduced in version 9.5.0.56

1 if the stream supports writing. Otherwise 0.

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

DataAvailable As Long (read-only)

Introduced in version 9.5.0.56

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

DebugLogFilePath As String

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

DefaultChunkSize As Long

Introduced in version 9.5.0.56

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.

EndOfStream As Long (read-only)

Introduced in version 9.5.0.56

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

IsWriteClosed As Long (read-only)

Introduced in version 9.5.0.56

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

LastBinaryResult As Variant (read-only)

Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

LastErrorHtml As String (read-only)

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

LastErrorText As String (read-only)

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Concept of LastErrorText

LastErrorText Standard Information

LastErrorXml As String (read-only)

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

LastMethodSuccess As Long

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = 1 and failure = 0.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

LastStringResult As String (read-only)

Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen As Long (read-only)

Introduced in version 9.5.0.53

The length, in characters, of the string contained in the LastStringResult property.

Length As Long

Introduced in version 9.5.0.56

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.

Length32 As Long

Introduced in version 9.5.0.58

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

NumReceived As Long (read-only)

Introduced in version 9.5.0.56

The number of bytes received by the stream.

NumSent As Long (read-only)

Introduced in version 9.5.0.56

The number of bytes sent by the stream.

ReadFailReason As Long (read-only)

Introduced in version 9.5.0.56

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

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

ReadTimeoutMs As Long

Introduced in version 9.5.0.56

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.

SinkFile As String

Introduced in version 9.5.0.56

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.

(Classic ASP) Copy a File using a Stream

(Visual FoxPro) Copy a File using a Stream

(PowerBuilder) Copy a File using a Stream

(SQL Server) Copy a File using a Stream

(Visual Basic 6.0) Copy a File using a Stream

(VBScript) Copy a File using a Stream

SourceFile As String

Introduced in version 9.5.0.56

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.

(Classic ASP) Copy a File using a Stream

(Visual FoxPro) Copy a File using a Stream

(PowerBuilder) Copy a File using a Stream

(SQL Server) Copy a File using a Stream

(Visual Basic 6.0) Copy a File using a Stream

(VBScript) Copy a File using a Stream

SourceFilePart As Long

Introduced in version 9.5.0.59

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.

(Classic ASP) S3 Upload the Parts for a Multipart Upload

(Visual FoxPro) S3 Upload the Parts for a Multipart Upload

(PowerBuilder) S3 Upload the Parts for a Multipart Upload

(SQL Server) S3 Upload the Parts for a Multipart Upload

(Visual Basic 6.0) S3 Upload the Parts for a Multipart Upload

(VBScript) S3 Upload the Parts for a Multipart Upload

SourceFilePartSize As Long

Introduced in version 9.5.0.59

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.

(Classic ASP) S3 Upload the Parts for a Multipart Upload

(Visual FoxPro) S3 Upload the Parts for a Multipart Upload

(PowerBuilder) S3 Upload the Parts for a Multipart Upload

(SQL Server) S3 Upload the Parts for a Multipart Upload

(Visual Basic 6.0) S3 Upload the Parts for a Multipart Upload

(VBScript) S3 Upload the Parts for a Multipart Upload

StringBom As Long

Introduced in version 9.5.0.56

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

StringCharset As String

Introduced in version 9.5.0.56

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

Charsets Supported by Chilkat

VerboseLogging As Long

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version As String (read-only)

Version of the component/library, such as "9.5.0.63"

WriteFailReason As Long (read-only)

Introduced in version 9.5.0.56

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

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

WriteTimeoutMs As Long

Introduced in version 9.5.0.56

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

ReadBd(binData As ChilkatBinData) As Long

Introduced in version 9.5.0.67

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

Returns 1 for success, 0 for failure.

(Classic ASP) Unzip Binary File to Stream

(Visual FoxPro) Unzip Binary File to Stream

(PowerBuilder) Unzip Binary File to Stream

(SQL Server) Unzip Binary File to Stream

(Visual Basic 6.0) Unzip Binary File to Stream

(VBScript) Unzip Binary File to Stream

ReadBdAsync(binData As ChilkatBinData) As ChilkatTask

Introduced in version 9.5.0.67

Creates an asynchronous task to call the ReadBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

(Classic ASP) FTP Download Binary File to a Stream

(Visual FoxPro) FTP Download Binary File to a Stream

(PowerBuilder) FTP Download Binary File to a Stream

(SQL Server) FTP Download Binary File to a Stream

(Visual Basic 6.0) FTP Download Binary File to a Stream

(VBScript) FTP Download Binary File to a Stream

ReadBytes() As Variant

Introduced in version 9.5.0.56

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

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

ReadBytesAsync() As ChilkatTask

Introduced in version 9.5.0.56

Creates an asynchronous task to call the ReadBytes method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

VB6 Programs MUST Call FinalizeThreadPool Just Before Exiting

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

ReadBytesENC(encoding As String) As String

Introduced in version 9.5.0.56

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

Returns Nothing on failure

Binary Encodings Supported by Chilkat

ReadBytesENCAsync(encoding As String) As ChilkatTask

Introduced in version 9.5.0.56

Creates an asynchronous task to call the ReadBytesENC method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

VB6 Programs MUST Call FinalizeThreadPool Just Before Exiting

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

ReadNBytes(ByVal numBytes As Long) As Variant

Introduced in version 9.5.0.56

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

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

ReadNBytesAsync(ByVal numBytes As Long) As ChilkatTask

Introduced in version 9.5.0.56

Creates an asynchronous task to call the ReadNBytes method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

VB6 Programs MUST Call FinalizeThreadPool Just Before Exiting

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

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

Introduced in version 9.5.0.56

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

Returns Nothing on failure

Binary Encodings Supported by Chilkat

ReadNBytesENCAsync(ByVal numBytes As Long, encoding As String) As ChilkatTask

Introduced in version 9.5.0.56

Creates an asynchronous task to call the ReadNBytesENC method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

VB6 Programs MUST Call FinalizeThreadPool Just Before Exiting

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

ReadSb(sb As ChilkatStringBuilder) As Long

Introduced in version 9.5.0.67

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

Returns 1 for success, 0 for failure.

ReadSbAsync(sb As ChilkatStringBuilder) As ChilkatTask

Introduced in version 9.5.0.67

Creates an asynchronous task to call the ReadSb method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

(Classic ASP) Unzip One File to a Stream

(Visual FoxPro) Unzip One File to a Stream

(PowerBuilder) Unzip One File to a Stream

(SQL Server) Unzip One File to a Stream

(Visual Basic 6.0) Unzip One File to a Stream

(VBScript) Unzip One File to a Stream

ReadString() As String

Introduced in version 9.5.0.56

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

Returns Nothing on failure

ReadStringAsync() As ChilkatTask

Introduced in version 9.5.0.56

Creates an asynchronous task to call the ReadString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

VB6 Programs MUST Call FinalizeThreadPool Just Before Exiting

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

ReadToCRLF() As String

Introduced in version 9.5.0.56

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

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

Returns Nothing on failure

ReadToCRLFAsync() As ChilkatTask

Introduced in version 9.5.0.56

Creates an asynchronous task to call the ReadToCRLF method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

VB6 Programs MUST Call FinalizeThreadPool Just Before Exiting

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

ReadUntilMatch(matchStr As String) As String

Introduced in version 9.5.0.56

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

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

Returns Nothing on failure

(Classic ASP) Firebase Receive Server-Sent Events (text/event-stream)

(Visual FoxPro) Firebase Receive Server-Sent Events (text/event-stream)

(PowerBuilder) Firebase Receive Server-Sent Events (text/event-stream)

(SQL Server) Firebase Receive Server-Sent Events (text/event-stream)

(Visual Basic 6.0) Firebase Receive Server-Sent Events (text/event-stream)

(VBScript) Firebase Receive Server-Sent Events (text/event-stream)

ReadUntilMatchAsync(matchStr As String) As ChilkatTask

Introduced in version 9.5.0.56

Creates an asynchronous task to call the ReadUntilMatch method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

VB6 Programs MUST Call FinalizeThreadPool Just Before Exiting

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Reset()

Introduced in version 9.5.0.56

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.

RunStream() As Long

Introduced in version 9.5.0.56

Runs the stream to completion. This method should only be called when the source of the string has been set by any of the following methods: SetSourceBytes, SetSourceString, or SetSourceStream, or when the SourceFile property has been set (giving the stream a file source).

This method will read the stream source and forward to the sink until the end-of-stream is reached, and all data has been written to the sink.

Returns 1 for success, 0 for failure.

(Classic ASP) Chaining Asynchronous Streams

(Visual FoxPro) Chaining Asynchronous Streams

(PowerBuilder) Chaining Asynchronous Streams

(SQL Server) Chaining Asynchronous Streams

(Visual Basic 6.0) Chaining Asynchronous Streams

(VBScript) Chaining Asynchronous Streams

RunStreamAsync() As ChilkatTask

Introduced in version 9.5.0.56

Creates an asynchronous task to call the RunStream method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

VB6 Programs MUST Call FinalizeThreadPool Just Before Exiting

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

SetSinkStream(strm As ChilkatStream) As Long

Introduced in version 9.5.0.56

Sets the stream's sink to strm. Any data written to this stream's sink will become available to strm on its source.

Returns 1 for success, 0 for failure.

SetSourceBytes(sourceData As Variant) As Long

Introduced in version 9.5.0.56

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

Returns 1 for success, 0 for failure.

SetSourceStream(strm As ChilkatStream) As Long

Introduced in version 9.5.0.56

Sets the stream's source to be the sink of strm. Any data written to strm's sink will become available on this stream's source.

Returns 1 for success, 0 for failure.

(Classic ASP) Chaining Asynchronous Streams

(Visual FoxPro) Chaining Asynchronous Streams

(PowerBuilder) Chaining Asynchronous Streams

(SQL Server) Chaining Asynchronous Streams

(Visual Basic 6.0) Chaining Asynchronous Streams

(VBScript) Chaining Asynchronous Streams

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

Introduced in version 9.5.0.56

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

Returns 1 for success, 0 for failure.

ToDecimalStr(propertyName As String) As String

Introduced in version 9.5.0.56

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

Returns Nothing on failure

WriteBd(binData As ChilkatBinData) As Long

Introduced in version 9.5.0.67

Writes the contents of binData to the stream.

Returns 1 for success, 0 for failure.

WriteBdAsync(binData As ChilkatBinData) As ChilkatTask

Introduced in version 9.5.0.67

Creates an asynchronous task to call the WriteBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

VB6 Programs MUST Call FinalizeThreadPool Just Before Exiting

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

WriteByte(ByVal byteVal As Long) As Long

Introduced in version 9.5.0.56

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

Returns 1 for success, 0 for failure.

WriteByteAsync(ByVal byteVal As Long) As ChilkatTask

Introduced in version 9.5.0.56

Creates an asynchronous task to call the WriteByte method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

VB6 Programs MUST Call FinalizeThreadPool Just Before Exiting

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

WriteBytes(byteData As Variant) As Long

Introduced in version 9.5.0.56

Writes binary bytes to a stream.

Returns 1 for success, 0 for failure.

WriteBytesAsync(byteData As Variant) As ChilkatTask

Introduced in version 9.5.0.56

Creates an asynchronous task to call the WriteBytes method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

VB6 Programs MUST Call FinalizeThreadPool Just Before Exiting

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

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

Introduced in version 9.5.0.56

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

Returns 1 for success, 0 for failure.

Binary Encodings Supported by Chilkat

WriteBytesENCAsync(byteData As String, encoding As String) As ChilkatTask

Introduced in version 9.5.0.56

Creates an asynchronous task to call the WriteBytesENC method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

VB6 Programs MUST Call FinalizeThreadPool Just Before Exiting

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

WriteClose() As Long

Introduced in version 9.5.0.56

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

Returns 1 for success, 0 for failure.

WriteSb(sb As ChilkatStringBuilder) As Long

Introduced in version 9.5.0.67

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

Returns 1 for success, 0 for failure.

WriteSbAsync(sb As ChilkatStringBuilder) As ChilkatTask

Introduced in version 9.5.0.67

Creates an asynchronous task to call the WriteSb method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

VB6 Programs MUST Call FinalizeThreadPool Just Before Exiting

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

WriteString(str As String) As Long

Introduced in version 9.5.0.56

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

Returns 1 for success, 0 for failure.

WriteStringAsync(str As String) As ChilkatTask

Introduced in version 9.5.0.56

Creates an asynchronous task to call the WriteString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

VB6 Programs MUST Call FinalizeThreadPool Just Before Exiting

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Events

AbortCheck(abort As Long)

Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200.

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Async Callbacks

Dim WithEvents myStream As ChilkatStream

Private Sub myStream_AbortCheck(abort As Long)

	'Insert application code here.

End Sub

BinaryData(data As Variant)

Binary data provided by certain methods.

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Async Callbacks

Dim WithEvents myStream As ChilkatStream

Private Sub myStream_BinaryData(data As Variant)

	'Insert application code here.

End Sub

PercentDone(ByVal pctDone As Long, abort As Long)

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This event is only fired when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For operations (Chilkat method calls) that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.

The abort output argument provides a means for aborting the operation. Setting it to 1 will cause the method to abort and return a failed status (or whatever return value indicates failure).

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Async Callbacks

Dim WithEvents myStream As ChilkatStream

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

	'Insert application code here.

End Sub

ProgressInfo(name As String, value As String)

A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Async Callbacks

Dim WithEvents myStream As ChilkatStream

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

	'Insert application code here.

End Sub

TextData(data As String)

Text data provided by certain methods.

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Async Callbacks

Dim WithEvents myStream As ChilkatStream

Private Sub myStream_TextData(data As String)

	'Insert application code here.

End Sub