SqlCeSyncDescriptionBuilder.GetDescriptionForScope Method (String, String, SqlCeConnection)

  • Article

Returns a DbSyncScopeDescription object that contains information about the specified scope that is defined for a SQL Server Compact database.

Namespace: Microsoft.Synchronization.Data.SqlServerCe
Assembly: Microsoft.Synchronization.Data.SqlServerCe (in microsoft.synchronization.data.sqlserverce.dll)

Syntax

'Declaration
Public Shared Function GetDescriptionForScope ( _
    scopeName As String, _
    objectPrefix As String, _
    connection As SqlCeConnection _
) As DbSyncScopeDescription
'Usage
Dim scopeName As String
Dim objectPrefix As String
Dim connection As SqlCeConnection
Dim returnValue As DbSyncScopeDescription

returnValue = SqlCeSyncDescriptionBuilder.GetDescriptionForScope(scopeName, objectPrefix, connection)

public static DbSyncScopeDescription GetDescriptionForScope (
    string scopeName,
    string objectPrefix,
    SqlCeConnection connection
)

public:
static DbSyncScopeDescription^ GetDescriptionForScope (
    String^ scopeName, 
    String^ objectPrefix, 
    SqlCeConnection^ connection
)

public static DbSyncScopeDescription GetDescriptionForScope (
    String scopeName, 
    String objectPrefix, 
    SqlCeConnection connection
)

public static function GetDescriptionForScope (
    scopeName : String, 
    objectPrefix : String, 
    connection : SqlCeConnection
) : DbSyncScopeDescription

Parameters

  • scopeName
    The name of the scope for which to retrieve a description.
  • objectPrefix
    The optional prefix that is used to identify objects that Sync Framework creates.
  • connection
    A SqlCeConnection object that contains a connection to the database.

Return Value

A DbSyncScopeDescription object that contains information about the specified scope.

See Also

Reference

SqlCeSyncDescriptionBuilder Class
SqlCeSyncDescriptionBuilder Members
Microsoft.Synchronization.Data.SqlServerCe Namespace