FullTextIndexActive Property (SQL-DMO)

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

Applies To

Table Object

Syntax

object.FullTextIndexActive [ = value ]

Remarks

If True, the referenced table has been configured for participation in Microsoft Search full-text indexing. The Microsoft Search service will gather index data from the designated columns and populate the index as directed.

If False, Microsoft Search will 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 prior to setting FullTextIndexActive. 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 will not be available for full-text queries. For more full-text on 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 when 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 configuration already established.

Data Type

Boolean

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetFullTextIndexActive(LPBOOL pRetVal);

HRESULT SetFullTextIndexActive(BOOL NewVal);