ReplicationDatabase.ScriptReplicationDBOption Method

Article
12/03/2008

Returns a Transact-SQL script to enable or disable replication options 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 ScriptReplicationDBOption ( _
    scriptOption As ScriptOptions _
) As String

public string ScriptReplicationDBOption (
    ScriptOptions scriptOption
)

public:
String^ ScriptReplicationDBOption (
    ScriptOptions scriptOption
)

public String ScriptReplicationDBOption (
    ScriptOptions scriptOption
)

public function ScriptReplicationDBOption (
    scriptOption : ScriptOptions
) : String

Parameters

scriptOption
A ScriptOptions object value that specifies the replication options to script.

Return Value

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 IncludeEnableReplicationDB to include creation scripts to enable the database for replication.

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.

Thread Safety

Any public static (Shared in Microsoft 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 for Installing SQL Server 2005.

Target Platforms