AgentProfile.Script Method
Generates a Transact-SQL script that can be used to re-create the agent profile.
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 AgentProfile
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
- scriptOption
Type: Microsoft.SqlServer.Replication.ScriptOptions
A ScriptOptions object value that specifies the scripting options.
Return Value
Type: System.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.