This documentation is archived and is not being maintained.

DataTableReader.GetValues Method

Note: This method is new in the .NET Framework version 2.0.

Gets an array of Objects that contains the values from the current row in the DataTableReader.

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

public override int GetValues (
	Object[] values
)
public int GetValues (
	Object[] values
)
public override function GetValues (
	values : Object[]
) : int

Parameters

values

An array of Object into which to copy the column values from the DataTableReader.

Return Value

The number of column values copied into the array.

Exception typeCondition

ArgumentOutOfRangeException

The index passed was outside the range of 0 to FieldCount - 1.

DeletedRowInaccessibleException

An attempt was made to retrieve data from a deleted row.

InvalidOperationException

An attempt was made to read or access a column in a closed DataTableReader .

For most applications, this method provides an efficient means for retrieving all columns, instead of retrieving each column individually. If your intent is to retrieve all the column values from a row within the DataTableReader, the GetValues method provides the most efficient solution.

You can pass an Object array that contains fewer than the number of columns that are contained in the resulting row. Only the amount of data the Object array can hold is copied to the array. You can also pass an Object array whose length is more than the number of columns that are contained in the resulting row, in which case the additional array elements remains unchanged by the method call.

This method places DBNull in the output array for null columns.

The following example demonstrates using an array that is the correct size, to read all values from the current row in the supplied DataTableReader. In addition, the sample demonstrates using a fixed-sized array that could be either smaller or larger than the number of available columns.

private static void TestGetValues(DataTableReader reader)
{
    // Given a DataTableReader, use the GetValues
    // method to retrieve a full row of data.
    // Test the GetValues method, passing in an array large
    // enough for all the columns.
    Object[] values = new Object[reader.FieldCount];
    int fieldCount = reader.GetValues(values);
   
    Console.WriteLine("reader.GetValues retrieved {0 columns.", 
        fieldCount);
    for (int i = 0; i < fieldCount; i++)
        Console.WriteLine(values[i]);

    Console.WriteLine();

    // Now repeat, using an array that may contain a different 
    // number of columns than the original data. This should work correctly,
    // whether the size of the array is larger or smaller than 
    // the number of columns.
   
    // Attempt to retrieve three columns of data.
    values = new Object[3];
    fieldCount = reader.GetValues(values);
    Console.WriteLine("reader.GetValues retrieved {0 columns.", 
        fieldCount);
    for (int i = 0; i < fieldCount; i++)
        Console.WriteLine(values[i]);


Windows 98, Windows 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 .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0

.NET Compact Framework

Supported in: 2.0
Show: