ReplicationServer.ScriptInstallDistributor Method

Returns a Transact-SQL script that installs the Distributor.

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

Syntax

'Declaration
Public Function ScriptInstallDistributor ( _
    distributionServerName As String, _
    scriptOption As ScriptOptions _
) As String
'Usage
Dim instance As ReplicationServer
Dim distributionServerName As String
Dim scriptOption As ScriptOptions
Dim returnValue As String

returnValue = instance.ScriptInstallDistributor(distributionServerName, _
    scriptOption)
public string ScriptInstallDistributor(
    string distributionServerName,
    ScriptOptions scriptOption
)
public:
String^ ScriptInstallDistributor(
    String^ distributionServerName, 
    ScriptOptions scriptOption
)
member ScriptInstallDistributor : 
        distributionServerName:string * 
        scriptOption:ScriptOptions -> string 
public function ScriptInstallDistributor(
    distributionServerName : String, 
    scriptOption : ScriptOptions
) : String

Parameters

  • distributionServerName
    Type: System.String
    The name of the Distributor.

Return Value

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

Exceptions

Exception Condition
ArgumentException

When distributionServerName is null, contains null characters, or is longer than 128 bytes.

Remarks

The ScriptInstallDistributor method can be called before InstallDistributor.

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