dotConnect for MySQL Documentation
Devart.Data.MySql.Synchronization Namespace / MySqlSyncDescriptionBuilder Class / GetDescriptionForScope Method / GetDescriptionForScope(String,String,MySqlConnection) Method
The synchronization scope to get description for.
The preffix for names of Sync Framework metadata objects. Must match to the preffix, specified in the Devart.Data.Synchronization.SyncScopeProvisioning.ObjectPrefix property of the Devart.Data.Synchronization.SyncScopeProvisioning class descendant, that was used to provision the scope.
A Devart.Data.MySql.MySqlConnection object that contains a connection to the database with the provisioned synchronization scope to get description for.

In This Topic
    GetDescriptionForScope(String,String,MySqlConnection) Method
    In This Topic
    Returns a Microsoft.Synchronization.Data.DbSyncScopeDescription object that contains information about the specified synchronization scope that is defined for a MySQL database.
    Syntax
    'Declaration
     
    Public Overloads Shared Function GetDescriptionForScope( _
       ByVal scopeName As String, _
       ByVal objectPrefix As String, _
       ByVal connection As MySqlConnection _
    ) As DbSyncScopeDescription
    public static DbSyncScopeDescription GetDescriptionForScope( 
       string scopeName,
       string objectPrefix,
       MySqlConnection connection
    )

    Parameters

    scopeName
    The synchronization scope to get description for.
    objectPrefix
    The preffix for names of Sync Framework metadata objects. Must match to the preffix, specified in the Devart.Data.Synchronization.SyncScopeProvisioning.ObjectPrefix property of the Devart.Data.Synchronization.SyncScopeProvisioning class descendant, that was used to provision the scope.
    connection
    A Devart.Data.MySql.MySqlConnection object that contains a connection to the database with the provisioned synchronization scope to get description for.

    Return Value

    A Microsoft.Synchronization.Data.DbSyncScopeDescription object that contains information about the specified synchronization scope that is defined for a MySQL database.
    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also