System.Data Namespace   IDataRecord Class

---

Returns the value of the specified column as a character array.

[ VB ]
NotOverridable Public Function GetChars ( _
   ByVal index As Integer, _
   ByVal dataIndex As Long, _
   ByVal buffer ( ) As Char, _
   ByVal bufferIndex As Integer, _
   ByVal length As Integer _
) As Long

[ C# ]
public long GetChars (
   int index,
   long dataIndex,
   char [ ] buffer,
   int bufferIndex,
   int length
);

[ C++ ]
public: __sealed int64 GetChars (
   int index,
   int64 dataIndex,
   unsigned char* buffer [ ],
   int bufferIndex,
   int length
);

[ JScript ]
public function GetChars (
   index : int,
   dataIndex : long,
   buffer : Char [ ],
   bufferIndex : int,
   length : int
) : long

index

The zero-based column ordinal.

dataIndex

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

buffer

The buffer into which to copy data.

bufferIndex

The index for buffer to begin the read operation.

length

The maximum number of characters to read.

The actual number of characters read.

GetChars returns the number of available characters 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 GetChars has already been used to obtain characters from the field. This may be the case, for example, if the IDataRecord is reading a large data structure into a buffer.

The actual number of characters read can be less than the requested length, if the end of the field is reached. If you pass a buffer that is a null reference ( Nothing in Visual Basic ), GetChars returns the length of the field in characters.

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

IDataRecord Members

Books and more ...

Custom Search

Suggested Reading

Need a break ?