SqlSyncDescriptionBuilder.GetDescriptionForTable Method (String, SqlConnection)

  • Article

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)

Syntax

'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)

public static DbSyncTableDescription GetDescriptionForTable (
    string tableName,
    SqlConnection connection
)

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

public static DbSyncTableDescription GetDescriptionForTable (
    String tableName, 
    SqlConnection connection
)

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

Parameters

  • tableName
    The name of the table for which to retrieve a description.
  • connection
    A SqlConnection object that contains a connection to the database.

Return Value

A DbSyncTableDescription object that contains schema information about the specified table.

See Also

Reference

SqlSyncDescriptionBuilder Class
SqlSyncDescriptionBuilder Members
Microsoft.Synchronization.Data.SqlServer Namespace