SqlSyncDescriptionBuilder.GetDescriptionForTable Method (String, SqlConnection)

Returns a DbSyncTableDescription object that contains schema information about the specified table in a SQL Server database.

Namespace:  Microsoft.Synchronization.Data.SqlServer
Assembly:  Microsoft.Synchronization.Data.SqlServer (in Microsoft.Synchronization.Data.SqlServer.dll)

public static function GetDescriptionForTable(
	tableName : String, 
	connection : SqlConnection
) : DbSyncTableDescription

Parameters

tableName
Type: System.String
The name of the table for which to retrieve a description.
connection
Type: System.Data.SqlClient.SqlConnection
A SqlConnection object that contains a connection to the database.

Return Value

Type: Microsoft.Synchronization.Data.DbSyncTableDescription
A DbSyncTableDescription object that contains schema information about the specified table.

ExceptionCondition
ArgumentNullException

connection is a null reference (Nothing in Visual Basic).

ArgumentException

tableName is a a null reference (Nothing in Visual Basic) or empty.

Show: