EnumGeneratedSubsetFilters Method

SQL-DMO

Syntax

object.EnumGeneratedSubsetFilters( Article,
SubsetFilterClause ) as QueryResults

Parts

object

Expression that evaluates to an object in the Applies To list.

Article

String that identifies an article in the publication by name.

SubsetFilterClause

String of 1,002 characters or less that specifies a filter clause to apply to the article. Use an empty string to enable test generation of default filter clauses.

Prototype (C/C++)

HRESULT EnumGeneratedSubsetFilters(
LPSQLDMOQUERYRESULTS* ppResults,
SQLDMO_LPCSTR szArticle,
SQLDMO_LPCSTR szSubsetFilterClause);

Returns

A QueryResults object that contains one result set defined by these columns.

Column	Data type	Description
article name	nvarchar(129)	Name of the article that contains the joined from table.
base table name	nvarchar(129)	Name of the table joined to in the filter clause.
base table owner	nvarchar(129)	Name of the owner of the table joined to in the filter clause.
filtername	nvarchar(129)	Name of the filter.
join article name	nvarchar(129)	Name of the article on which the filter is defined.
join_filterclause	nvarchar(1001)	Transact-SQL WHERE clause defining the filter.
join_filterid	integer	System-generated identifier.
join table name	nvarchar(129)	Name of the table joined from in the filter clause.
join table owner	nvarchar(129)	Name of the owner of the table joined from in the filter clause.
join_unique_key	integer	When 1, the filter depends on a unique or key value. When 0, the filter does not depend on a unique value.

Remarks

The EnumGeneratedSubsetFilters method explicitly begins a transaction prior to generating any filters, then explicitly rolls back the transaction when the result set is generated. No permanent change is made to publication or article definition by the method. For more information about adding filters to articles using SQL-DMO, see MergeSubsetFilter Object.