ISupportBinaryImageExtensionsParseBinaryImageFromStream Method
Parses a binary image from the specified
Stream into an object that implements
ISupportBinaryImage.
Namespace: Gemstone.IO.ParsingAssembly: Gemstone.Common (in Gemstone.Common.dll) Version: 1.0.141 -- Release Build+8fc1477299d57116e2a4f3cb8dfe059f814b239b
public static int ParseBinaryImageFromStream(
this ISupportBinaryImage imageSource,
Stream stream,
bool clearArray = false
)
<ExtensionAttribute>
Public Shared Function ParseBinaryImageFromStream (
imageSource As ISupportBinaryImage,
stream As Stream,
Optional clearArray As Boolean = false
) As Integer
public:
[ExtensionAttribute]
static int ParseBinaryImageFromStream(
ISupportBinaryImage^ imageSource,
Stream^ stream,
bool clearArray = false
)
Gemstone.IO.Parsing.ISupportBinaryImageExtensions.ParseBinaryImageFromStream = function(imageSource, stream, clearArray);
- 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.
- 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.
Int32The number of bytes successfully read and parsed from the stream.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).
This method reads a binary image from the provided
Stream and parses it into the specified
ISupportBinaryImage instance. It uses a shared buffer pool to minimize memory allocations.
ArgumentNullException | Thrown if imageSource or stream is null. |