Stream C Reference Documentation

Stream

Current Version: 9.5.0.75

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.

Create/Dispose

HCkStream instance = CkStream_Create();
// ...
CkStream_Dispose(instance);
HCkStream CkStream_Create(void);

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

void CkStream_Dispose(HCkStream handle);

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

Callback Functions

Callback Functions introduced in Chilkat v9.5.0.56
void CkStream_setAbortCheck(HCkStream cHandle, BOOL (*fnAbortCheck)(void));

Provides the opportunity for a method call to be aborted. If TRUE is returned, the operation in progress is aborted. Return FALSE to allow the current method call to continue. This callback function is called periodically based on the value of the HeartbeatMs property. (If HeartbeatMs is 0, then no callbacks are made.) As an example, to make 5 AbortCheck callbacks per second, set the HeartbeatMs property equal to 200.

void CkStream_setPercentDone(HCkStream cHandle, BOOL (*fnPercentDone)(int pctDone));

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 callback is only called 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 methods 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).

This callback counts as an AbortCheck callback, and takes the place of the AbortCheck event when it fires.

The return value indicates whether the method call should be aborted, or whether it should proceed. Return TRUE to abort, and FALSE to proceed.

void CkStream_setProgressInfo(HCkStream cHandle, void (*fnProgressInfo)(const char *name, const char *value));

This is a general callback that provides name/value information about what is happening at certain points during a method call. To see the information provided in ProgressInfo callbacks, if any, write code to handle this event and log the name/value pairs. Most are self-explanatory.

void CkStream_setTaskCompleted(HCkStream cHandle, void (*fnTaskCompleted)(HCkTask hTask));

Called in the background thread when an asynchronous task completes. (Note: When an async method is running, all callbacks are in the background thread.)

Properties

AbortCurrent
BOOL CkStream_getAbortCurrent(HCkStream cHandle);
void CkStream_putAbortCurrent(HCkStream cHandle, BOOL newVal);
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
BOOL CkStream_getCanRead(HCkStream cHandle);
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
BOOL CkStream_getCanWrite(HCkStream cHandle);
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
BOOL CkStream_getDataAvailable(HCkStream cHandle);
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
void CkStream_getDebugLogFilePath(HCkStream cHandle, HCkString retval);
void CkStream_putDebugLogFilePath(HCkStream cHandle, const char *newVal);
const char *CkStream_debugLogFilePath(HCkStream cHandle);

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
int CkStream_getDefaultChunkSize(HCkStream cHandle);
void CkStream_putDefaultChunkSize(HCkStream cHandle, int newVal);
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
BOOL CkStream_getEndOfStream(HCkStream cHandle);
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
BOOL CkStream_getIsWriteClosed(HCkStream cHandle);
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
void CkStream_getLastErrorHtml(HCkStream cHandle, HCkString retval);
const char *CkStream_lastErrorHtml(HCkStream cHandle);

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
void CkStream_getLastErrorText(HCkStream cHandle, HCkString retval);
const char *CkStream_lastErrorText(HCkStream cHandle);

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
void CkStream_getLastErrorXml(HCkStream cHandle, HCkString retval);
const char *CkStream_lastErrorXml(HCkStream cHandle);

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
BOOL CkStream_getLastMethodSuccess(HCkStream cHandle);
void CkStream_putLastMethodSuccess(HCkStream cHandle, BOOL newVal);
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
__int64 CkStream_getLength(HCkStream cHandle);
void CkStream_putLength(HCkStream cHandle, __int64 newVal);
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
int CkStream_getLength32(HCkStream cHandle);
void CkStream_putLength32(HCkStream cHandle, int newVal);
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
__int64 CkStream_getNumReceived(HCkStream cHandle);
Introduced in version 9.5.0.56

The number of bytes received by the stream.

top
NumSent
__int64 CkStream_getNumSent(HCkStream cHandle);
Introduced in version 9.5.0.56

The number of bytes sent by the stream.

top
ReadFailReason
int CkStream_getReadFailReason(HCkStream cHandle);
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
int CkStream_getReadTimeoutMs(HCkStream cHandle);
void CkStream_putReadTimeoutMs(HCkStream cHandle, int newVal);
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
void CkStream_getSinkFile(HCkStream cHandle, HCkString retval);
void CkStream_putSinkFile(HCkStream cHandle, const char *newVal);
const char *CkStream_sinkFile(HCkStream cHandle);
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.

More Information and Examples
top
SourceFile
void CkStream_getSourceFile(HCkStream cHandle, HCkString retval);
void CkStream_putSourceFile(HCkStream cHandle, const char *newVal);
const char *CkStream_sourceFile(HCkStream cHandle);
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.

More Information and Examples
top
SourceFilePart
int CkStream_getSourceFilePart(HCkStream cHandle);
void CkStream_putSourceFilePart(HCkStream cHandle, int newVal);
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.

More Information and Examples
top
SourceFilePartSize
int CkStream_getSourceFilePartSize(HCkStream cHandle);
void CkStream_putSourceFilePartSize(HCkStream cHandle, int newVal);
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.

More Information and Examples
top
StringBom
BOOL CkStream_getStringBom(HCkStream cHandle);
void CkStream_putStringBom(HCkStream cHandle, BOOL newVal);
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
void CkStream_getStringCharset(HCkStream cHandle, HCkString retval);
void CkStream_putStringCharset(HCkStream cHandle, const char *newVal);
const char *CkStream_stringCharset(HCkStream cHandle);
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
Utf8
BOOL CkStream_getUtf8(HCkStream cHandle);
void CkStream_putUtf8(HCkStream cHandle, BOOL newVal);

When set to TRUE, all "const char *" arguments are interpreted as utf-8 strings. If set to FALSE (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to TRUE, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to FALSE, all "const char *" return values are ANSI strings.

top
VerboseLogging
BOOL CkStream_getVerboseLogging(HCkStream cHandle);
void CkStream_putVerboseLogging(HCkStream cHandle, BOOL newVal);

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
void CkStream_getVersion(HCkStream cHandle, HCkString retval);
const char *CkStream_version(HCkStream cHandle);

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

top
WriteFailReason
int CkStream_getWriteFailReason(HCkStream cHandle);
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
int CkStream_getWriteTimeoutMs(HCkStream cHandle);
void CkStream_putWriteTimeoutMs(HCkStream cHandle, int newVal);
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
BOOL CkStream_ReadBd(HCkStream cHandle, HCkBinData 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.

More Information and Examples
top
ReadBdAsync (1)
HCkTask CkStream_ReadBdAsync(HCkStream cHandle, HCkBinData 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.)

Returns NULL on failure

More Information and Examples
top
ReadBytes
BOOL CkStream_ReadBytes(HCkStream cHandle, HCkByteData outBytes);
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 TRUE for success, FALSE for failure.

top
ReadBytesAsync (1)
HCkTask CkStream_ReadBytesAsync(HCkStream cHandle);
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.)

Returns NULL on failure

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

More Information and Examples
top
ReadBytesENCAsync (1)
HCkTask CkStream_ReadBytesENCAsync(HCkStream cHandle, const char *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.)

Returns NULL on failure

top
ReadNBytes
BOOL CkStream_ReadNBytes(HCkStream cHandle, int numBytes, HCkByteData outBytes);
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 TRUE for success, FALSE for failure.

top
ReadNBytesAsync (1)
HCkTask CkStream_ReadNBytesAsync(HCkStream cHandle, 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.)

Returns NULL on failure

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

More Information and Examples
top
ReadNBytesENCAsync (1)
HCkTask CkStream_ReadNBytesENCAsync(HCkStream cHandle, int numBytes, const char *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.)

Returns NULL on failure

top
ReadSb
BOOL CkStream_ReadSb(HCkStream cHandle, HCkStringBuilder 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 (1)
HCkTask CkStream_ReadSbAsync(HCkStream cHandle, HCkStringBuilder 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.)

Returns NULL on failure

More Information and Examples
top
ReadString
BOOL CkStream_ReadString(HCkStream cHandle, HCkString outStr);
const char *CkStream_readString(HCkStream cHandle);
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 TRUE for success, FALSE for failure.

top
ReadStringAsync (1)
HCkTask CkStream_ReadStringAsync(HCkStream cHandle);
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.)

Returns NULL on failure

top
ReadToCRLF
BOOL CkStream_ReadToCRLF(HCkStream cHandle, HCkString outStr);
const char *CkStream_readToCRLF(HCkStream cHandle);
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 TRUE for success, FALSE for failure.

top
ReadToCRLFAsync (1)
HCkTask CkStream_ReadToCRLFAsync(HCkStream cHandle);
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.)

Returns NULL on failure

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

top
ReadUntilMatchAsync (1)
HCkTask CkStream_ReadUntilMatchAsync(HCkStream cHandle, const char *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.)

Returns NULL on failure

top
Reset
void CkStream_Reset(HCkStream cHandle);
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
BOOL CkStream_RunStream(HCkStream cHandle);
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.

More Information and Examples
top
RunStreamAsync (1)
HCkTask CkStream_RunStreamAsync(HCkStream cHandle);
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.)

Returns NULL on failure

top
SaveLastError
BOOL CkStream_SaveLastError(HCkStream cHandle, const char *path);

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

Returns TRUE for success, FALSE for failure.

top
SetSinkStream
BOOL CkStream_SetSinkStream(HCkStream cHandle, HCkStream 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
BOOL CkStream_SetSourceBytes(HCkStream cHandle, HCkByteData 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
BOOL CkStream_SetSourceStream(HCkStream cHandle, HCkStream 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.

More Information and Examples
top
SetSourceString
BOOL CkStream_SetSourceString(HCkStream cHandle, const char *srcStr, const char *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
BOOL CkStream_WriteBd(HCkStream cHandle, HCkBinData 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 (1)
HCkTask CkStream_WriteBdAsync(HCkStream cHandle, HCkBinData 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.)

Returns NULL on failure

top
WriteByte
BOOL CkStream_WriteByte(HCkStream cHandle, 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 (1)
HCkTask CkStream_WriteByteAsync(HCkStream cHandle, 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.)

Returns NULL on failure

top
WriteBytes
BOOL CkStream_WriteBytes(HCkStream cHandle, HCkByteData byteData);
Introduced in version 9.5.0.56

Writes binary bytes to a stream.

Returns TRUE for success, FALSE for failure.

top
WriteBytesAsync (1)
HCkTask CkStream_WriteBytesAsync(HCkStream cHandle, HCkByteData 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.)

Returns NULL on failure

top
WriteBytesENC
BOOL CkStream_WriteBytesENC(HCkStream cHandle, const char *byteData, const char *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 (1)
HCkTask CkStream_WriteBytesENCAsync(HCkStream cHandle, const char *byteData, const char *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.)

Returns NULL on failure

top
WriteClose
BOOL CkStream_WriteClose(HCkStream cHandle);
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
BOOL CkStream_WriteSb(HCkStream cHandle, HCkStringBuilder 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 (1)
HCkTask CkStream_WriteSbAsync(HCkStream cHandle, HCkStringBuilder 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.)

Returns NULL on failure

top
WriteString
BOOL CkStream_WriteString(HCkStream cHandle, const char *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 (1)
HCkTask CkStream_WriteStringAsync(HCkStream cHandle, const char *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.)

Returns NULL on failure

top