ConstraintCollection.Add Method (String, DataColumn(), Boolean)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Constructs a new UniqueConstraint with the specified name, array of DataColumn objects, and value that indicates whether the column is a primary key, and adds it to the collection.

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

Public Function Add (
	name As String,
	columns As DataColumn(),
	primaryKey As Boolean
) As Constraint

Parameters

name
Type: System.String

The name of the UniqueConstraint.

columns
Type: System.Data.DataColumn()

An array of DataColumn objects to which the constraint applies.

primaryKey
Type: System.Boolean

Specifies whether the column should be the primary key. If true, the column will be a primary key column.

Return Value

Type: System.Data.Constraint

A new UniqueConstraint.

Exception Condition
ArgumentException

The constraint already belongs to this collection.

-Or-

The constraint belongs to another collection.

DuplicateNameException

The collection already has a constraint with the specified name. (The comparison is not case-sensitive.)

The CollectionChanged event occurs if the constraint is added successfully.

The following example creates an array of DataColumn objects that are used to create a new UniqueConstraint in a specific DataTable.

Private Sub AddUniqueConstraint(table As DataTable)
    Dim columns(1) As DataColumn
    columns(0) = table.Columns("ID")
    columns(1) = table.Columns("Name")
    table.Constraints.Add("idNameConstraint", columns, True)
End Sub

.NET Framework
Available since 1.1
Return to top
Show: