AgentProfile.Script Method

Article
12/03/2008

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

public string Script (
    ScriptOptions scriptOption
)

public:
String^ Script (
    ScriptOptions scriptOption
)

public String Script (
    ScriptOptions scriptOption
)

public function Script (
    scriptOption : ScriptOptions
) : String

Parameters

scriptOption
A ScriptOptions object value that specifies the scripting options.

Return Value

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.

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

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