Share via


PullSubscription.UseFtp Property

Gets or sets whether or not the snapshot files needed to initialize the pull subscription are accessed by the Synchronization Agent using File Transfer Protocol (FTP).

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

Syntax

'Declaration
Public Property UseFtp As Boolean 
    Get 
    Set
'Usage
Dim instance As PullSubscription 
Dim value As Boolean 

value = instance.UseFtp

instance.UseFtp = value
public bool UseFtp { get; set; }
public:
property bool UseFtp {
    bool get ();
    void set (bool value);
}
member UseFtp : bool with get, set
function get UseFtp () : boolean 
function set UseFtp (value : boolean)

Property Value

Type: System.Boolean
A Boolean value. If true, snapshot files are downloaded using FTP protocol. If false, snapshot files are not downloaded using FTP protocol.

Remarks

The AltSnapshotFolder property cannot be set to true when UseFtp is set to true.

The UseFtp property can only be retrieved by members of the sysadmin fixed server role at the Subscriber or by members of the db_owner fixed database role on the subscription database.

The UseFtp property can only be set by members of the sysadmin fixed server role at the Subscriber or by members of the db_owner fixed database role on the subscription database.

Retrieving the UseFtp property is equivalent to executing sp_helppullsubscription (Transact-SQL) or sp_helpmergepullsubscription (Transact-SQL).

Setting the UseFtp property is equivalent to executing sp_addpullsubscription_agent (Transact-SQL), sp_addmergepullsubscription_agent (Transact-SQL), sp_change_subscription_properties (Transact-SQL), or sp_changemergepullsubscription (Transact-SQL).

See Also

Reference

PullSubscription Class

Microsoft.SqlServer.Replication Namespace

Other Resources

Transfer Snapshots Through FTP