Share via


IVsDataReader.GetBytes Method (String, array<Byte , Int32, Int32)

When implemented by a class, retrieves a specified number of bytes of raw binary data.

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

Syntax

'Declaration
Function GetBytes ( _
    name As String, _
    buffer As Byte(), _
    bufferIndex As Integer, _
    length As Integer _
) As Integer
int GetBytes(
    string name,
    byte[] buffer,
    int bufferIndex,
    int length
)
int GetBytes(
    String^ name, 
    array<unsigned char>^ buffer, 
    int bufferIndex, 
    int length
)
abstract GetBytes : 
        name:string * 
        buffer:byte[] * 
        bufferIndex:int * 
        length:int -> int
function GetBytes(
    name : String, 
    buffer : byte[], 
    bufferIndex : int, 
    length : int
) : int

Parameters

  • name
    Type: System.String

    The name of the item for which to retrieve raw binary data.

  • 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 the 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
An integer value indicating the number of bytes read into the buffer.

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

See Also

Reference

IVsDataReader Interface

GetBytes Overload

Microsoft.VisualStudio.Data.Services.SupportEntities Namespace