ISupportBinaryImageExtensionsCopyBinaryImageToStreamAsync Method

Asynchronously copies the binary image of an object that implements ISupportBinaryImage to the specified Stream.

Definition

Namespace: Gemstone.IO.Parsing
Assembly: Gemstone.Common (in Gemstone.Common.dll) Version: 1.0.141 -- Release Build+8fc1477299d57116e2a4f3cb8dfe059f814b239b

C#View Source Request Example

public static Task CopyBinaryImageToStreamAsync(
	this ISupportBinaryImage imageSource,
	Stream stream,
	bool clearArray = false,
	CancellationToken cancellationToken = default
)

VBView Source Request Example

<ExtensionAttribute>
Public Shared Function CopyBinaryImageToStreamAsync ( 
	imageSource As ISupportBinaryImage,
	stream As Stream,
	Optional clearArray As Boolean = false,
	Optional cancellationToken As CancellationToken = Nothing
) As Task

C++View Source Request Example

public:
[ExtensionAttribute]
static Task^ CopyBinaryImageToStreamAsync(
	ISupportBinaryImage^ imageSource, 
	Stream^ stream, 
	bool clearArray = false, 
	CancellationToken cancellationToken = CancellationToken()
)

JavaScriptView Source Request Example

Gemstone.IO.Parsing.ISupportBinaryImageExtensions.CopyBinaryImageToStreamAsync = function(imageSource, stream, clearArray, cancellationToken);

Parameters

imageSource ISupportBinaryImage: The ISupportBinaryImage source whose binary image will be copied.
stream Stream: The Stream to which the binary image will be written.
clearArray Boolean (Optional): Clears any rented buffers of their contents so that a subsequent consumer will not see the previous consumer's content. If false, default, the array's contents are left unchanged.
cancellationToken CancellationToken (Optional): A token to monitor for cancellation requests.

Return Value

Task
A task that represents the asynchronous operation.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ISupportBinaryImage. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

This method uses a buffer rented from a shared ArrayPoolT to optimize memory usage. The buffer is returned to the pool after the operation completes.

Exceptions

ArgumentNullException

Thrown if imageSource or stream is null.