DataReader.GetBytes Method

Article
10/03/2012

Retrieves a specified number of bytes of raw binary data.

Namespace: Microsoft.VisualStudio.Data
Assembly: Microsoft.VisualStudio.Data (in Microsoft.VisualStudio.Data.dll)

Syntax

'Declaration
Public MustOverride Function GetBytes ( _
    index As Integer, _
    buffer As Byte(), _
    bufferIndex As Integer, _
    length As Integer _
) As Integer

public abstract int GetBytes(
    int index,
    byte[] buffer,
    int bufferIndex,
    int length
)

public:
virtual int GetBytes(
    int index, 
    array<unsigned char>^ buffer, 
    int bufferIndex, 
    int length
) abstract

abstract GetBytes : 
        index:int * 
        buffer:byte[] * 
        bufferIndex:int * 
        length:int -> int

public abstract function GetBytes(
    index : int, 
    buffer : byte[], 
    bufferIndex : int, 
    length : int
) : int

Parameters

index
Type: System.Int32

Index into the current block of data for the item to retrieve.

buffer
Type: array<System.Byte[]

An array into which specified data, as byte array, should be placed. If nulla null reference (Nothing in Visual Basic), this method returns the size required of the array in order to fit all of the specified data.

bufferIndex
Type: System.Int32

Index of starting point in the byte array specified with the buffer parameter.

length
Type: System.Int32

The number of bytes to be read into the byte array specified with the buffer parameter.

Return Value

Type: System.Int32
Returns an integer value indicating the number of bytes read into the buffer.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The index, bufferIndex, and/or length parameters are invalid.

Remarks

When data is presented by the DDEX provider in the form of raw bytes, call this method to read only a specified number of bytes into an existing client-side buffer. This performs better than simply retrieving the whole value, which causes all the data to be read and allocated in memory.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via