SqlDataRecord.GetValues(Object[]) Method

Definition

Namespace:

Microsoft.Data.SqlClient.Server

Assembly:

Microsoft.Data.SqlClient.dll

Package:

Microsoft.Data.SqlClient v5.2.0

Returns the values for all the columns in the record, expressed as common language runtime (CLR) types, in an array.

public:
 virtual int GetValues(cli::array <System::Object ^> ^ values);

public virtual int GetValues (object[] values);

abstract member GetValues : obj[] -> int
override this.GetValues : obj[] -> int

Public Overridable Function GetValues (values As Object()) As Integer

Parameters

values

Object[]

The array into which to copy the values column values.

Returns

Int32

An Int32 that indicates the number of columns copied.

Implements

GetValues(Object[])

Exceptions

ArgumentNullException

values is null.

InvalidCastException

There is a type mismatch.

Remarks

The CLR type values of the column are copied into the values array that is passed as a parameter. For columns with null value, Value is returned.

The length of the values array does not need to match the number of columns in the record. If the array length is greater than the number of columns, all of the column values are copied into the array; if it is less, only the array length number of column values is copied into the array, starting at the column value with ordinal 0.