Share via

DbServerSyncProvider.GetSchema Method

  • Article

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

public override SyncSchema GetSchema (
    Collection<string> tableNames,
    SyncSession syncSession
)

public:
virtual SyncSchema^ GetSchema (
    Collection<String^>^ tableNames, 
    SyncSession^ syncSession
) override

public SyncSchema GetSchema (
    Collection<String> tableNames, 
    SyncSession syncSession
)

public override function GetSchema (
    tableNames : Collection<String>, 
    syncSession : SyncSession
) : SyncSchema

Parameters

  • tableNames
    A collection of table names for which the server provider should get the schema.
  • syncSession
    A SyncSession object that contains synchronization session variables, such as the ID of the client that is synchronizing.

Return Value

A SyncSchema object that contains the schema for each table that is specified.

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.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements (Synchronization Services).

Target Platforms

See Also

Reference

DbServerSyncProvider Class
DbServerSyncProvider Members
Microsoft.Synchronization.Data.Server Namespace