The EnumGeneratedSubsetFilters method applies the filter clause specified to the article indicated, performs temporary filter generation, then returns a QueryResults object enumerating default filters generated by the test case specified.
object.EnumGeneratedSubsetFilters( Article,
SubsetFilterClause ) as QueryResults
| Part | Description |
|---|---|
| object | Expression that evaluates to an object in the Applies To list. |
| Article | String identifying an article in the publication by name. |
| SubsetFilterClause | String specifying a filter clause to apply to the article. Use an empty string to enable test generation of default filter clauses. |
A QueryResults object containing one result set defined by these columns.
| Column | Data type | Description |
|---|---|---|
| join_filterid | integer | System-generated identifier. |
| 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_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. |
| base table owner | nvarchar(129) | Name of the owner of the table joined to in the filter clause. |
| base table name | nvarchar(129) | Name of the table joined to in the filter clause. |
| join table owner | nvarchar(129) | Name of the owner of the table joined from in the filter clause. |
| join table name | nvarchar(129) | Name of the table joined from in the filter clause. |
| article name | nvarchar(129) | Name of the article containing the joined from table. |
The EnumGeneratedSubsetFilters method explicitly begins a transaction prior to generating any filters, then explicitly rolls back the transaction when the result set has been generated. No permanent change is made to publication or article definition by the method. For more information about adding filters to articles by using SQL-DMO, see MergeSubsetFilter Object.
HRESULT EnumGeneratedSubsetFilters(
LPSQLDMOQUERYRESULTS* ppResults,
SQLDMO_LPCSTR szArticle,
SQLDMO_LPCSTR szSubsetFilterClause);