• Article

Table.CheckIdentityValue Method

Verifies the integrity of all identity columns in the referenced table.

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
Public Function CheckIdentityValue As StringCollection
'Usage
Dim instance As Table
Dim returnValue As StringCollection

returnValue = instance.CheckIdentityValue()

public StringCollection CheckIdentityValue()

public:
StringCollection^ CheckIdentityValue()

member CheckIdentityValue : unit -> StringCollection 

public function CheckIdentityValue() : StringCollection

Return Value

Type: System.Collections.Specialized.StringCollection
A StringCollection system object value that contains the current identity value and the current column value.

Remarks

This method is functionally equivalent to the Transact-SQL CHECK IDENT statement. An error will be thrown if this method is called on a table with no Identifier columns.

Examples

The following code example shows how to check and display the identity value of a table.

C#

Server srv = new Server("(local)");
Database db = srv.Databases["AdventureWorks2008R2"];

Table tb = new Table(db, "Test Table");
Column col1 = new Column(tb, "TableIdentifier", DataType.Int);
col1.Identity = true;
tb.Columns.Add(col1); 

foreach (String s in tb.CheckIdentityValue())
{
   Console.WriteLine(s);
}

Powershell

$srv = new-Object Microsoft.SqlServer.Management.Smo.Server("(local)")
$db = New-Object Microsoft.SqlServer.Management.Smo.Database
$db = $srv.Databases.Item("AdventureWorks2008R2")

$tb = new-object Microsoft.SqlServer.Management.Smo.Table($db, "Test Table")
$col1 = new-object Microsoft.SqlServer.Management.Smo.Column($tb, "TableIdentifier", [Microsoft.SqlServer.Management.Smo.DataType]::Int)
$col1.Identity = $TRUE
$tb.Columns.Add($col1)

Write-Host $tb.CheckIdentityValue()