• Article

ReplicationServer.CopySubscriptionDatabase Method

Copies an existing pull subscription database.

Namespace:  Microsoft.SqlServer.Replication
Assembly:  Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)

Syntax

'Declaration
Public Sub CopySubscriptionDatabase ( _
    databaseName As String, _
    fileName As String, _
    overwriteExistingFile As Boolean _
)
'Usage
Dim instance As ReplicationServer
Dim databaseName As String
Dim fileName As String
Dim overwriteExistingFile As Boolean

instance.CopySubscriptionDatabase(databaseName, _
    fileName, overwriteExistingFile)

public void CopySubscriptionDatabase(
    string databaseName,
    string fileName,
    bool overwriteExistingFile
)

public:
void CopySubscriptionDatabase(
    String^ databaseName, 
    String^ fileName, 
    bool overwriteExistingFile
)

member CopySubscriptionDatabase : 
        databaseName:string * 
        fileName:string * 
        overwriteExistingFile:bool -> unit 

public function CopySubscriptionDatabase(
    databaseName : String, 
    fileName : String, 
    overwriteExistingFile : boolean
)

Parameters

  • databaseName
    Type: System.String
    A string value that specifies the name of a pull subscription database to copy.
  • fileName
    Type: System.String
    A string value that specifies the complete path, including file name, to which a copy of the data portion (.mdf) file is saved.
  • overwriteExistingFile
    Type: System.Boolean
    A Boolean value that specifies whether or not to overwrite an existing file of the same name specified in the fileName parameter, if there is one.

Exceptions

Exception Condition
ApplicationException

When the server is not running on Microsoft SQL Server 2000 or later.
ArgumentException

If a parameter is null, contains null characters, or exceeds 128 bytes.

Remarks

Note

This feature will be removed in a future version of Microsoft SQL Server. Do not use this feature in new development work, and modify applications that currently use this feature as soon as possible.

Only single file databases can be copied.

The CopySubscriptionDatabase method can be called by a member of the db_owner fixed database role of the database that is being copied.

The CopySubscriptionDatabase method is equivalent to the sp_copysubscription (Transact-SQL) stored procedure.

This method is only available with instances of SQL Server 2000 and SQL Server 2005.

This namespace, class, or member is supported only in version 2.0 of the .NET Framework.