DataRow.SetColumnError Method (DataColumn, String)

 

Sets the error description for a column specified as a DataColumn.

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

Public Sub SetColumnError (
	column As DataColumn,
	error As String
)

Parameters

column
Type: System.Data.DataColumn

The DataColumn to set the error description for.

error
Type: System.String

The error description.

To examine error descriptions, use the GetColumnError method.

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

If null or an empty string is passed in as the error parameter, the DataRow behaves as if no error was set and the HasErrors property will return false.

To set a custom error description on the whole row, use the RowError property.

To determine whether any errors exist for the columns collection, use the HasErrors method.

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

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

Private Sub SetColError(ByVal row As DataRow, _
    byVal columnIndex As Integer)
    Dim errorString As String = "Replace this text."

    ' Set the error for the specified column of the row.
    row.SetColumnError(columnIndex, errorString)
End Sub

Private Sub PrintColError( _
    ByVal row As DataRow, byVal columnIndex As Integer)

    ' Print the error of a specified column.
    Console.WriteLine(row.GetColumnError(columnIndex))
End Sub

.NET Framework
Available since 1.1
Return to top
Show: