DataRow.GetColumnError Method (DataColumn)

 

Gets the error description of the specified DataColumn.

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

Public Function GetColumnError (
	column As DataColumn
) As String

Parameters

column
Type: System.Data.DataColumn

A DataColumn.

Return Value

Type: System.String

The text of the error description.

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. Alternatively, the GetErrors method of the DataTable returns all rows 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 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: