• Article

SnapshotGenerationAgent.DynamicFilterLogin Property

Gets or sets the value supplied to the SUSER_SNAME function used in a parameterized row filter.

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

Syntax

'Declaration
Public Property DynamicFilterLogin As String
    Get
    Set
'Usage
Dim instance As SnapshotGenerationAgent
Dim value As String

value = instance.DynamicFilterLogin

instance.DynamicFilterLogin = value

public string DynamicFilterLogin { get; set; }

public:
virtual property String^ DynamicFilterLogin {
    String^ get () sealed;
    void set (String^ value) sealed;
}

abstract DynamicFilterLogin : string with get, set
override DynamicFilterLogin : string with get, set

final function get DynamicFilterLogin () : String
final function set DynamicFilterLogin (value : String)

Property Value

Type: System.String
A String value used for filtering.

Implements

ISnapshotGenerationAgent.DynamicFilterLogin

Remarks

The value specified for DynamicFilterLogin is used when generating the partitioned snapshot for a subscription defined based-on a parameterized row filter that uses the SUSER_SNAME function. For example, if the subset filter clause LoginID = SUSER_SNAME() is specified for an article, and you set the DynamicFilterLogin property to "adventure-works\garrett1" before calling the Merge Agent, only rows having "adventure-works\garrett1" in the login_id column will be replicated.

The DynamicFilterLogin property is only supported for merge publications.

You should not specify a value for DynamicFilterLogin when specifying a value for DynamicFilterHostName.