WstDataReader.GetBytes Method

[This is internal Microsoft documentation - Do not distribute.]

Inherited from IDataRecord. Pass through to the current SqlDataReader

Namespace: Microsoft.Webstore.WstClient
Assembly: ICL (in icl.dll)

Syntax

'Declaration

  Public Function GetBytes ( _
    i As Integer, _
    dataIndex As Long, _
    buffer As Byte(), _
    bufferIndex As Integer, _
    length As Integer _
) As Long

  public long GetBytes (
    int i,
    long dataIndex,
    byte[] buffer,
    int bufferIndex,
    int length
)

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 for buffer to begin the read operation

• length
  The maximum length to copy into the buffer

Return Value

The actual number of bytes read

Remarks

GetBytes returns the number of available bytes in the field. In most cases 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 field in bytes. No conversions are performed, therefore the data retrieved must already be a byte array

Thread Safety

All public static (Shared in Visual Basic) members of this type are thread-safe. Instance members are not guaranteed to be thread-safe.

Platforms

Development Platforms

Windows XP Professional with Service Pack 2 (SP2), Windows Server 2003, Windows Vista Ultimate Edition, Windows Vista Business Edition, Windows Vista Enterprise Edition

Target Platforms

See Also

Reference

WstDataReader Class
WstDataReader Members
Microsoft.Webstore.WstClient Namespace