Stream C# Reference Documentation

Stream

Current Version: 9.5.0.73

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

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

Properties

AbortCurrent
public bool AbortCurrent {get; set; }
Introduced in version 9.5.0.58

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

top
CanRead
public bool CanRead {get; }
Introduced in version 9.5.0.56

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.

top
CanWrite
public bool CanWrite {get; }
Introduced in version 9.5.0.56

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.

top
DataAvailable
public bool DataAvailable {get; }
Introduced in version 9.5.0.56

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

top
DebugLogFilePath
public string DebugLogFilePath {get; set; }

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.

top
DefaultChunkSize
public int DefaultChunkSize {get; set; }
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.

top
EndOfStream
public bool EndOfStream {get; }
Introduced in version 9.5.0.56

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

top
IsWriteClosed
public bool IsWriteClosed {get; }
Introduced in version 9.5.0.56

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

top
LastErrorHtml
public string LastErrorHtml {get; }

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.

top
LastErrorText
public string LastErrorText {get; }

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.

top
LastErrorXml
public string LastErrorXml {get; }

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.

top
LastMethodSuccess
public bool LastMethodSuccess {get; set; }
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false 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 = true and failure = false.
  • 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 true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
Length
public long Length {get; set; }
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.

top
Length32
public int Length32 {get; set; }
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).

top
NumReceived
public long NumReceived {get; }
Introduced in version 9.5.0.56

The number of bytes received by the stream.

top
NumSent
public long NumSent {get; }
Introduced in version 9.5.0.56

The number of bytes sent by the stream.

top
ReadFailReason
public int ReadFailReason {get; }
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).

top
ReadTimeoutMs
public int ReadTimeoutMs {get; set; }
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.

top
SinkFile
public string SinkFile {get; set; }
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.

top
SourceFile
public string SourceFile {get; set; }
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.

top
SourceFilePart
public int SourceFilePart {get; set; }
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.

top
SourceFilePartSize
public int SourceFilePartSize {get; set; }
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.

top
StringBom
public bool StringBom {get; set; }
Introduced in version 9.5.0.56

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.

top
StringCharset
public string StringCharset {get; set; }
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".

More Information and Examples
top
VerboseLogging
public bool VerboseLogging {get; set; }

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

top
Version
public string Version {get; }

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

top
WriteFailReason
public int WriteFailReason {get; }
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).

top
WriteTimeoutMs
public int WriteTimeoutMs {get; set; }
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.

top

Methods

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

top
ReadBdAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task ReadBdAsync(BinData binData);
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 null on failure

top
ReadBytes
public byte[] ReadBytes();
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 an empty byte array on failure

top
ReadBytesAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task ReadBytesAsync();
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 null on failure

top
ReadBytesENC
public string ReadBytesENC(string encoding);
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 null on failure

More Information and Examples
top
ReadBytesENCAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task ReadBytesENCAsync(string encoding);
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 null on failure

top
ReadNBytes
public byte[] ReadNBytes(int numBytes);
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 an empty byte array on failure

top
ReadNBytesAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task ReadNBytesAsync(int numBytes);
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 null on failure

top
ReadNBytesENC
public string ReadNBytesENC(int numBytes, string encoding);
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 null on failure

More Information and Examples
top
ReadNBytesENCAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task ReadNBytesENCAsync(int numBytes, string encoding);
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 null on failure

top
ReadSb
public bool ReadSb(StringBuilder sb);
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 true for success, false for failure.

top
ReadSbAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task ReadSbAsync(StringBuilder sb);
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 null on failure

top
ReadString
public string ReadString();
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 null on failure

top
ReadStringAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task ReadStringAsync();
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 null on failure

top
ReadToCRLF
public string ReadToCRLF();
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 null on failure

top
ReadToCRLFAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task ReadToCRLFAsync();
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 null on failure

top
ReadUntilMatch
public string ReadUntilMatch(string matchStr);
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 null on failure

top
ReadUntilMatchAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task ReadUntilMatchAsync(string matchStr);
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 null on failure

top
Reset
public void 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.

top
RunStream
public bool RunStream();
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 true for success, false for failure.

top
RunStreamAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task RunStreamAsync();
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 null on failure

top
SaveLastError
public bool SaveLastError(string path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

top
SetSinkStream
public bool SetSinkStream(Stream strm);
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 true for success, false for failure.

top
SetSourceBytes
public bool SetSourceBytes(byte[] sourceData);
Introduced in version 9.5.0.56

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

Returns true for success, false for failure.

top
SetSourceStream
public bool SetSourceStream(Stream strm);
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 true for success, false for failure.

top
SetSourceString
public bool SetSourceString(string srcStr, string charset);
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 true for success, false for failure.

top
WriteBd
public bool WriteBd(BinData binData);
Introduced in version 9.5.0.67

Writes the contents of binData to the stream.

Returns true for success, false for failure.

top
WriteBdAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task WriteBdAsync(BinData binData);
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 null on failure

top
WriteByte
public bool WriteByte(int byteVal);
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 true for success, false for failure.

top
WriteByteAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task WriteByteAsync(int byteVal);
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 null on failure

top
WriteBytes
public bool WriteBytes(byte[] byteData);
Introduced in version 9.5.0.56

Writes binary bytes to a stream.

Returns true for success, false for failure.

top
WriteBytesAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task WriteBytesAsync(byte[] byteData);
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 null on failure

top
WriteBytesENC
public bool WriteBytesENC(string byteData, string encoding);
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 true for success, false for failure.

More Information and Examples
top
WriteBytesENCAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task WriteBytesENCAsync(string byteData, string encoding);
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 null on failure

top
WriteClose
public bool WriteClose();
Introduced in version 9.5.0.56

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

Returns true for success, false for failure.

top
WriteSb
public bool WriteSb(StringBuilder sb);
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 true for success, false for failure.

top
WriteSbAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task WriteSbAsync(StringBuilder sb);
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 null on failure

top
WriteString
public bool WriteString(string str);
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 true for success, false for failure.

top
WriteStringAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task WriteStringAsync(string str);
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 null on failure

top

Events

AbortCheck
public event AbortCheckEventHandler OnAbortCheck;

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.

Chilkat .NET Event Implementation

Args are passed using Chilkat.AbortCheckEventArgs

Event callback implementation:

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

To add an event handler:

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

Chilkat Mono/.NET Core Event Implementation

Event callback implementation:

private void ENTRY_NAMEEventHandler OnENTRY_NAME
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Stream stream = new Chilkat.Stream();
// ...
Chilkat.Stream.AbortCheck abortCheck = new Chilkat.Stream.AbortCheck(handleAbortCheck);
stream.setAbortCheckCb(abortCheck);
top
PercentDone
public event PercentDoneEventHandler OnPercentDone;

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 true will cause the method to abort and return a failed status (or whatever return value indicates failure).

Chilkat .NET Event Implementation

Args are passed using Chilkat.PercentDoneEventArgs

Event callback implementation:

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

To add an event handler:

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

Chilkat Mono/.NET Core Event Implementation

Event callback implementation:

private void ENTRY_NAMEEventHandler OnENTRY_NAME
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Stream stream = new Chilkat.Stream();
// ...
Chilkat.Stream.PercentDone percentDone = new Chilkat.Stream.PercentDone(handlePercentDone);
stream.setPercentDoneCb(percentDone);
top
ProgressInfo
public event ProgressInfoEventHandler OnProgressInfo;

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.

Chilkat .NET Event Implementation

Args are passed using Chilkat.ProgressInfoEventArgs

Event callback implementation:

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

To add an event handler:

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

Chilkat Mono/.NET Core Event Implementation

Event callback implementation:

private void ENTRY_NAMEEventHandler OnENTRY_NAME
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Stream stream = new Chilkat.Stream();
// ...
Chilkat.Stream.ProgressInfo progressInfo = new Chilkat.Stream.ProgressInfo(handleProgressInfo);
stream.setProgressInfoCb(progressInfo);
top
TaskCompleted
public event TaskCompletedEventHandler OnTaskCompleted;

Called in the background thread when an asynchronous task completes.

More Information and Examples

Chilkat .NET Event Implementation

Args are passed using Chilkat.TaskCompletedEventArgs

Event callback implementation:

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

To add an event handler:

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

Chilkat Mono/.NET Core Event Implementation

Event callback implementation:

private void ENTRY_NAMEEventHandler OnENTRY_NAME
	{
	    // application code goes here.
	}

To add an event handler:

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