AgentProfile.Script(ScriptOptions) Method

Reference

Definition

Namespace:: Microsoft.SqlServer.Replication

Assembly:: Microsoft.SqlServer.Rmo.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Generates a Transact-SQL script that can be used to re-create the agent profile.

public:
 System::String ^ Script(Microsoft::SqlServer::Replication::ScriptOptions scriptOption);

public string Script (Microsoft.SqlServer.Replication.ScriptOptions scriptOption);

member this.Script : Microsoft.SqlServer.Replication.ScriptOptions -> string

Public Function Script (scriptOption As ScriptOptions) As String

Parameters

scriptOption: ScriptOptions

A ScriptOptions object value that specifies the scripting options.

Returns

String

A String value that contains a list of Transact-SQL statements in the script.

Remarks

The ScriptOptions parameter determines whether to return a creation script or a deletion script. This method can be used for an existing object or a new object.

For an existing profile on the server, the Script method can be called only by members of the sysadmin fixed server role at the Distributor and by members of the replmonitor fixed database role on a database at the Distributor.

For a new profile that does not exist on the server, the Script method can be called by any user.

Applies to