TransArticle.FilterProcName Property

Gets or sets the stored procedure (created with FOR REPLICATION) used to filter the table horizontally.

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

Syntax

'Declaration
Public Property FilterProcName As String
    Get
    Set
'Usage
Dim instance As TransArticle
Dim value As String

value = instance.FilterProcName

instance.FilterProcName = value
public string FilterProcName { get; set; }
public:
property String^ FilterProcName {
    String^ get ();
    void set (String^ value);
}
member FilterProcName : string with get, set
function get FilterProcName () : String
function set FilterProcName (value : String)

Property Value

Type: System.String
A String that is a stored procedure name.

Remarks

Setting this property overrides the default article partitioning.

The FilterProcName property is ignored unless the value of Type is one of the following:

Changing the FilterProcName property of an existing article requires that subscriptions be reinitialized and that a new snapshot be generated.

The FilterProcName 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, and by users who are members of the publication access list (PAL).

The FilterProcName property can only be set by members of the sysadmin fixed server role at the Publisher. It can also be set by members of the db_owner fixed database role on the publication database.

Retrieving FilterProcName is equivalent to executing sp_helparticle.

Setting FilterProcName is equivalent to executing sp_addarticle or sp_changearticle.

The FilterProcName property is available with SQL Server 7.0, SQL Server 2000, and SQL Server 2005.

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