Export (0) Print
Expand All

SqlDataReader.GetBytes Method

Reads a stream of bytes from the specified column offset into the buffer an array starting at the given buffer offset.

Namespace: System.Data.SqlClient
Assembly: System.Data (in system.data.dll)

public override long GetBytes (
	int i,
	long dataIndex,
	byte[] buffer,
	int bufferIndex,
	int length
)
public long GetBytes (
	int i, 
	long dataIndex, 
	byte[] buffer, 
	int bufferIndex, 
	int length
)
public override function GetBytes (
	i : int, 
	dataIndex : long, 
	buffer : byte[], 
	bufferIndex : int, 
	length : int
) : long
Not applicable.

Parameters

i

The zero-based column ordinal.

dataIndex

The index within the field from which to begin the read operation.

buffer

The buffer into which to read the stream of bytes.

bufferIndex

The index within the buffer where the write operation is to start.

length

The maximum length to copy into the buffer.

Return Value

The actual number of bytes read.

GetBytes returns the number of available bytes in the field. Most of the time this is the exact length of the field. However, the number returned may be less than the true length of the field if GetBytes has already been used to obtain bytes from the field. This may be the case, for example, if the SqlDataReader is reading a large data structure into a buffer. For more information, see the SequentialAccess setting for CommandBehavior.

If you pass a buffer that is a null reference (Nothing in Visual Basic), GetBytes returns the length of the entire field in bytes, not the remaining size based on the buffer offset parameter.

No conversions are performed; therefore, the data retrieved must already be a byte array.

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft