Gemstone Common Library
Show/Hide TOC

# BinaryImageBaseParseBinaryImage Method

Initializes object by parsing the specified buffer containing a binary image.

## Definition

Namespace: Gemstone.IO.Parsing
Assembly: Gemstone.Common (in Gemstone.Common.dll) Version: 1.0.143 -- Release Build+524337d392fd5616b12b50022b004322b9e7c330
C#
View Source Request Example

    public virtual int ParseBinaryImage(
    	byte[] buffer,
    	int startIndex,
    	int length
    )

VB
View Source Request Example

    Public Overridable Function ParseBinaryImage (
    	buffer As Byte(),
    	startIndex As Integer,
    	length As Integer
    ) As Integer

C++
View Source Request Example

    public:
    virtual int ParseBinaryImage(
    	array<unsigned char>^ buffer,
    	int startIndex,
    	int length
    )

JavaScript
View Source Request Example

    function ParseBinaryImage(buffer, startIndex, length);

#### Parameters

buffer Byte
  Buffer containing binary image to parse.
startIndex Int32
  0-based starting index in the buffer to start parsing.
length Int32
  Valid number of bytes within buffer from startIndex.

#### Return Value

Int32
The number of bytes used for initialization in the buffer (i.e., the number of bytes parsed).

#### Implements

ISupportBinaryImageParseBinaryImage(Byte, Int32, Int32)

## Remarks

This method is not typically overridden since it is parses the header, body and footer images in sequence.

## Exceptions

ArgumentNullException | buffer is null.
ArgumentOutOfRangeException | startIndex or length is less than 0 -or- startIndex and length will exceed buffer length.

## See Also

#### Reference

BinaryImageBase Class
Gemstone.IO.Parsing Namespace