2.2.1.15.1 Database Properties

This section details the properties that are used by the Content Indexing Services Protocol to control the behavior of the indexing service. These properties are grouped into three property sets identified in the guidPropertySet field of the CDbPropSet structure.

The following table lists the properties that are part of the DBPROPSET_FSCIFRMWRK_EXT property set.

 Value

 Meaning

DBPROP_CI_CATALOG_NAME

0x00000002

Specifies the name of the catalog or catalogs to query. Value MUST be a VT_LPWSTR or a VT_VECTOR | VT_LPWSTR.

DBPROP_CI_INCLUDE_SCOPES

0x00000003

Specifies one or more paths to be included in the query. Value MUST be a VT_LPWSTR or a VT_VECTOR | VT_LPWSTR.

DBPROP_CI_SCOPE_FLAGS

0x00000004

Specifies how the paths specified by the DBPROP_CI_INCLUDE_SCOPES property are to be treated. Value MUST be a VT_I4 or a VT_VECTOR | VT_I4.

DBPROP_CI_QUERY_TYPE

0x00000007

Specifies the type of query using a CDbColId structure. The structure MUST be set such that the eKind field contains 0x00000001 and the GUID and ulID fields are filled with zeros.

The following table lists the flags for the DBPROP_CI_SCOPE_FLAGS property.

 Value

 Meaning

QUERY_DEEP

0x01

If set, indicates that files in the scope directory and all subdirectories are included in the results. If clear, only files in the scope directory are included in the results. MUST NOT be combined with QUERY_DEEP.

QUERY_VIRTUAL_PATH

0x02

If set, indicates that the scope is a virtual path. If clear, indicates that the scope is a physical directory.

The following table lists the query types for the DBPROP_CI_QUERY_TYPE property.

 Value

 Meaning

CiNormal

0x00000000

A regular query.

CiVirtualRoots

0x00000001

The query is requesting a list of the virtual roots of the catalog. This value requires administrative privileges.

CiProperties

0x00000003

The query is requesting a list of all of the properties supported by the indexing service.

CiAdminOp

0x00000004

The query is an administrative operation. This value requires administrative privileges.

The following table lists the properties that are part of the DBPROPSET_QUERYEXT property set.

Value

Meaning

DBPROP_USECONTENTINDEX

0x00000002

Use the inverted index to optimize the speed of evaluating content restrictions at the cost of the index possibly being out of date. Value MUST be a VT_BOOL. If TRUE, the server is allowed to fail these queries.

DBPROP_DEFERNONINDEXEDTRIMMING 0x00000003

Some operations, such as filtering by scope or security, can be expensive. This flag indicates that it is acceptable to defer this filtering until the results are actually requested. Value MUST be a VT_BOOL.

DBPROP_USEEXTENDEDDBTYPES 0x00000004

Indicates whether the client supports VT_VECTOR data types. If TRUE, the client supports VT_VECTOR; if FALSE, the server is to convert VT_VECTOR data types to VT_ARRAY data types. The value MUST be a VT_BOOL.

DBPROP_FIRSTROWS

0x00000007

If TRUE, the indexing service returns the first rows that match. If FALSE, then rows by default are returned in order of descending rank. Value MUST be a VT_BOOL.

The following table lists the properties that are part of the DBPROPSET_CIFRMWRKCORE_EXT property set.

 Value

 Meaning

DBPROP_MACHINE

0x00000002

Specifies the names of the computers on which a query is to be processed. The value MUST be either VT_BSTR or VT_ARRAY | VT_BSTR.

DBPROP_CLIENT_CLSID

0x00000003

Specifies a connection constant for the indexing service. The value can be a VT_CLSID containing 0x2A4880706FD911D0A80800A0C906241A or VT_ARRAY of STRINGS with value {2A488070-6FD9-11D0-A808-00A0C906241A}.

The following table lists properties that are part of the DBPROPSET_MSIDXS_ROWSETEXT property set.

Value

Meaning

MSIDXSPROP_ROWSETQUERYSTATUS

0x00000002

Specifies that the client is interested in rowset status. Value MUST be set to 0.

MSIDXSPROP_COMMAND_LOCALE_STRING

0x00000003

Specifies locale ID string for the query.

MSIDXSPROP_QUERY_RESTRICTION

0x00000004

Ignored by the server. MUST be set to an empty BSTR.