• Article

Publication.PreSnapshotScript Property

Gets or sets the name and full path of a Transact-SQL script file that is executed before the initial snapshot is applied to the Subscriber.

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

Syntax

'Declaration
Public Property PreSnapshotScript As String
    Get
    Set
'Usage
Dim instance As Publication
Dim value As String

value = instance.PreSnapshotScript

instance.PreSnapshotScript = value

public string PreSnapshotScript { get; set; }

public:
property String^ PreSnapshotScript {
    String^ get ();
    void set (String^ value);
}

member PreSnapshotScript : string with get, set

function get PreSnapshotScript () : String
function set PreSnapshotScript (value : String)

Property Value

Type: System.String
A String value that specifies the path and the file name of the Transact-SQL script.

Remarks

The PreSnapshotScript property can only be retrieved by members of the sysadmin fixed server role at the Publisher, by members of the db_owner fixed database role on the publication database, or by users in the publication access list (PAL).

The PreSnapshotScript property can only be set by members of the sysadmin fixed server role at the Publisher or by members of the db_owner fixed database role on the publication database. Users in the PAL can set the PreSnapshotScript property of an existing publication.

Retrieving the PreSnapshotScript property is equivalent to executing sp_helppublication (Transact-SQL) or sp_helpmergepublication (Transact-SQL).

Setting the PreSnapshotScript property is equivalent to executing sp_addpublication (Transact-SQL) and sp_changepublication (Transact-SQL) or sp_addmergepublication (Transact-SQL) and sp_changemergepublication (Transact-SQL).

The PreSnapshotScript property is available with SQL Server 2000 and SQL Server 2005.

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