SqlChars.Read(Int64, Char[], Int32, Int32) Method

Definition

Namespace:
System.Data.SqlTypes
Assemblies:
System.Data.SqlClient.dll, System.Data.dll, netstandard.dll, System.Data.Common.dll

Copies characters from this SqlChars instance to the passed-in buffer and returns the number of copied characters.

public:
 long Read(long offset, cli::array <char> ^ buffer, int offsetInBuffer, int count);
public long Read (long offset, char[] buffer, int offsetInBuffer, int count);
member this.Read : int64 * char[] * int * int -> int64
Public Function Read (offset As Long, buffer As Char(), offsetInBuffer As Integer, count As Integer) As Long

Parameters

offset
Int64

An Int64long value offset into the value that is contained in the SqlChars instance.

buffer
Char[]

The character array buffer to copy into.

offsetInBuffer
Int32

An Int32 integer offset into the buffer to start copying into.

count
Int32

An Int32 integer value representing the number of characters to copy.

Returns

Int64

An Int64long value representing the number of copied bytes.

Remarks

If an attempt is made to read beyond MaxLength, an exception is thrown.

If count specifies more characters to be copied than are available from the offsetInBuffer to the end of the value, only the available characters are copied.

An exception is thrown if the destination buffer is a null reference.

An exception is thrown if the destination buffer cannot receive as many characters as requested.

Applies to

See also