SnapshotGenerationAgent.DynamicFilterLogin Property

  • Article

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

public string DynamicFilterLogin { get; set; }

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

/** @property */
public final String get_DynamicFilterLogin ()

/** @property */
public final void set_DynamicFilterLogin (String value)

public final function get DynamicFilterLogin () : String

public final function set DynamicFilterLogin (value : String)

Property Value

A String value used for filtering.

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.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

SnapshotGenerationAgent Class
SnapshotGenerationAgent Members
Microsoft.SqlServer.Replication Namespace

Other Resources

How to: Create a Snapshot for a Merge Publication with Parameterized Filters (RMO Programming)
Parameterized Row Filters