Share via


Article.Script(ScriptOptions) Method

Definition

Generates a Transact-SQL script that can be executed to create or delete the TransArticle object or the MergeArticle object on the server.

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

The Transact-SQL script.

Remarks

The scriptOption parameter determines whether to return a creation script or a deletion script. The Script method can be used for an existing article on the server or it can be used before you create a new article on the server. For an existing article, call Load or LoadProperties to retrieve article properties from the server before calling Script.

You must specify a value of Creation or Deletion for ScriptOptions.

Any user can call the Script method. However, a script for an existing object on the server is returned only for members of the sysadmin fixed server role at the Publisher and at the Subscriber (for republishing Subscribers). A script also is returned for members of the db_owner fixed database role on the publication database and by users who are members of the PAL. For a MergeArticle object, a script will be returned for members of the replmonitor fixed database role on the Distributor.

Applies to