BinaryImageBaseGenerateBinaryImage Method

Generates binary image of the object and copies it into the given buffer, for BinaryLength bytes.

Definition

Namespace: Gemstone.IO.Parsing
Assembly: Gemstone.Common (in Gemstone.Common.dll) Version: 1.0.185 -- Release Build+887b2e7e6f8689bd24b3b07ac2031d4989512fbc

C#View Source Request Example

public virtual int GenerateBinaryImage(
	byte[] buffer,
	int startIndex
)

VBView Source Request Example

Public Overridable Function GenerateBinaryImage ( 
	buffer As Byte(),
	startIndex As Integer
) As Integer

C++View Source Request Example

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

JavaScriptView Source Request Example

function GenerateBinaryImage(buffer, startIndex);

Parameters

buffer Byte: Buffer used to hold generated binary image of the source object.
startIndex Int32: 0-based starting index in the buffer to start writing.

Return Value

Int32
The number of bytes written to the buffer.

Implements

ISupportBinaryImageGenerateBinaryImage(Byte, Int32)

Remarks

This property is not typically overridden since it is the generates the combination of the header, body and footer images.

Exceptions

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