• Article

FullTextIndexActive Property

This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.

The FullTextIndexActive property controls Microsoft Search service activity for a table.

Syntax

object
.FullTextIndexActive [= value]

Parts

  • object
    An expression that evaluates to an object in the Applies To list

  • value
    TRUE or FALSE

Data Type

Boolean

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetFullTextIndexActive(LPBOOL pRetVal);
HRESULT SetFullTextIndexActive(BOOL NewVal);

Remarks

If TRUE, the referenced table is configured for participation in Microsoft Search full-text indexing. The Microsoft Search service gathers index data from the designated columns and populate the index as directed.

If FALSE, Microsoft Search does not gather index data from the referenced table regardless of configuration for full-text indexing participation.

Full-text indexing must be properly configured for the referenced table before FullTextIndexActive is set. For more information about full-text index configuration, see FullTextCatalogName Property, FullTextIndex Property, and UniqueIndexForFullText Property.

Note

Setting FullTextIndexActive to TRUE does not populate the Microsoft Search full-text catalog, and the table is not available for full-text queries. For more information about populating the Microsoft Search full-text catalog, see Start Method (FullTextCatalog).

If FullTextIndexActive is TRUE, setting it to TRUE generates an error. An error is also generated on attempts to set FullTextIndexActive to TRUE if full-text indexing has not been properly configured.

If FullTextIndexActive is TRUE, setting it to FALSE simply removes the referenced table from participation in full-text index build and query. Setting the property does not affect the established configuration.

Applies To:

Table Object