This documentation is archived and is not being maintained.

DataRow.GetColumnError Method (Int32)

Gets the error description for the column specified by index.

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

public string GetColumnError (
	int columnIndex
)
public String GetColumnError (
	int columnIndex
)
public function GetColumnError (
	columnIndex : int
) : String
Not applicable.

Parameters

columnIndex

The zero-based index of the column.

Return Value

The text of the error description.

Exception typeCondition

IndexOutOfRangeException

The columnIndex argument is out of range.

Use the SetColumnError method to set column errors.

To determine whether any errors exist for the columns collection, use the HasErrors method. Consequently, you can use the GetColumnsInError method to retrieve all the columns with errors.

To clear all errors for the columns collection, use the ClearErrors method.

The following example sets an error description for a specified DataRow.

private void SetColError(DataRow row, int columnIndex)
{
    string errorString = "Replace this text.";

    // Set the error for the specified column of the row.
    row.SetColumnError(columnIndex, errorString);
}
 
private void PrintColError(DataRow row, int columnIndex)
{
    // Print the error of a specified column.
    Console.WriteLine(row.GetColumnError(columnIndex));
}

Windows 98, Windows Server 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 Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0
Show: