DbServerSyncProvider.GetSchema Method
Returns a SyncSchema object that contains the schema for each table specified.
Namespace: Microsoft.Synchronization.Data.Server
Assembly: Microsoft.Synchronization.Data.Server (in Microsoft.Synchronization.Data.Server.dll)
Syntax
'Declaration
Public Overrides Function GetSchema ( _
tableNames As Collection(Of String), _
syncSession As SyncSession _
) As SyncSchema
'Usage
Dim instance As DbServerSyncProvider
Dim tableNames As Collection(Of String)
Dim syncSession As SyncSession
Dim returnValue As SyncSchema
returnValue = instance.GetSchema(tableNames, _
syncSession)
public override SyncSchema GetSchema(
Collection<string> tableNames,
SyncSession syncSession
)
public:
virtual SyncSchema^ GetSchema(
Collection<String^>^ tableNames,
SyncSession^ syncSession
) override
abstract GetSchema :
tableNames:Collection<string> *
syncSession:SyncSession -> SyncSchema
override GetSchema :
tableNames:Collection<string> *
syncSession:SyncSession -> SyncSchema
public override function GetSchema(
tableNames : Collection<String>,
syncSession : SyncSession
) : SyncSchema
Parameters
- tableNames
Type: System.Collections.ObjectModel.Collection<String>
A collection of table names for which the server provider should get the schema.
- syncSession
Type: Microsoft.Synchronization.Data.SyncSession
A SyncSession object that contains synchronization session variables, such as the ID of the client that is synchronizing.
Return Value
Type: Microsoft.Synchronization.Data.SyncSchema
A SyncSchema object that contains the schema for each table that is specified.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | tableNames is a null reference (Nothing in Visual Basic). |
| SchemaException | The schema could not be read. |
Remarks
This method will try to obtain schemas from the Schema property. If the schema cannot be found and the server database is SQL Server, this method will try to obtain the schema directly from the underlying database.