Export (0) Print
Expand All

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)

'Declaration
Public Shared Function GetDescriptionForTable ( _
	tableName As String, _
	connection As SqlConnection _
) As DbSyncTableDescription
'Usage
Dim tableName As String
Dim connection As SqlConnection
Dim returnValue As DbSyncTableDescription

returnValue = SqlSyncDescriptionBuilder.GetDescriptionForTable(tableName, _
	connection)

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 Nothing.

ArgumentException

tableName is a Nothing or empty.

Show:
© 2014 Microsoft