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
)

Parameters

columnIndex
Type: System.Int32

The zero-based index of the column.

Return Value

Type: System.String

The text of the error description.

Exception Condition
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));
}

.NET Framework
Available since 1.1
Return to top
Show: