ReplicationDatabase.Script Method

Returns a Transact-SQL script to enable or disable replication publishing and subscriptions on the database based on the properties of ReplicationDatabase.

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

Syntax

'Declaration
Public Function Script ( _
    scriptOption As ScriptOptions _
) As String
'Usage
Dim instance As ReplicationDatabase
Dim scriptOption As ScriptOptions
Dim returnValue As String

returnValue = instance.Script(scriptOption)
public string Script(
    ScriptOptions scriptOption
)
public:
String^ Script(
    ScriptOptions scriptOption
)
member Script : 
        scriptOption:ScriptOptions -> string 
public function Script(
    scriptOption : ScriptOptions
) : String

Parameters

Return Value

Type: System.String
A String value that contains the Transact-SQL script.

Remarks

The scriptOption parameter specifies what is to be included in the script. For example:

  • Use Creation to get the creation script.

  • Use Deletion to get the deletion script.

  • Use IncludePublications to include creation scripts for all publications that belong to the database.

  • Use IncludePullSubscriptions to include creation scripts for all pull subscriptions that belong to the database.

You must specify at least one of the following: Creation or Deletion.

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