ISupportBinaryImageExtensionsParseBinaryImageFromStreamAsync Method

public static Task<int> ParseBinaryImageFromStreamAsync(
	this ISupportBinaryImage imageSource,
	Stream stream,
	bool readExactly = false,
	bool clearArray = false,
	CancellationToken cancellationToken = default
)

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

public:
[ExtensionAttribute]
static Task<int>^ ParseBinaryImageFromStreamAsync(
	ISupportBinaryImage^ imageSource, 
	Stream^ stream, 
	bool readExactly = false, 
	bool clearArray = false, 
	CancellationToken cancellationToken = CancellationToken()
)

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

Parameters

imageSource  ISupportBinaryImage

The ISupportBinaryImage instance into which the binary image will be parsed.

stream  Stream

The Stream from which the binary image will be read.

readExactly  Boolean  (Optional)

Specifies whether the method should read exactly the number of bytes required to fill the binary image. If true, the method will ensure the exact number of bytes is read; otherwise, it reads as many bytes as are available.

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

Usage Note

Reference