2.2.1.5.2 RopGetSearchCriteria ROP Response Buffer

The following descriptions define valid fields for the RopGetSearchCriteria ROP response buffer ([MS-OXCROPS] section 2.2.4.5.2).

ReturnValue (4 bytes):  An integer that indicates the result of the operation. The server returns 0x00000000 to indicate success. For details about common error codes, see [MS-OXCDATA] section 2.4.

RestrictionDataSize (2 bytes):  An integer that specifies the size, in bytes, of the RestrictionData field. If the IncludeRestriction field of the request buffer was set to zero (FALSE), the value of RestrictionDataSize will be 0.

RestrictionData (variable):  A packet of structures that specify restrictions for the search folder. For details about the structures that are used to specify restrictions, see [MS-OXCDATA] section 2.12. The size of this field is specified by the RestrictionDataSize field. This field is present only if the value of the RestrictionDataSize field is nonzero (TRUE).

FolderIdCount (2 bytes):  An integer that specifies the number of structures contained in the FolderIds field. If the IncludeFolders field of the request buffer was set to zero (FALSE), the FolderIdCount field will be set to 0.

FolderIds (variable):  An array of FID structures ([MS-OXCDATA] section 2.2.1.1), each of which specifies a folder that is being searched. The number of structures contained in the array is specified by the value of the FolderIdCount field. This field is present only if the value of the FolderIdCount field is nonzero (TRUE).

SearchFlags (4 bytes):  A set of bits that indicate the state of the current search.

The valid bits for this field are listed in the following table. The client MUST ignore any other bits.

Bit name

Value

Meaning

SEARCH_RUNNING

0x00000001

The search is running, which means that the initial population of the search folder still being compiled.

SEARCH_REBUILD

0x00000002

The search is in the CPU-intensive part of the search. This bit is set only if the SEARCH_RUNNING bit is also set.

SEARCH_RECURSIVE

0x00000004

If this bit is set, the specified search folder containers and all their child search folder containers are searched for matching entries. If this bit is not set, only the search folder containers that are specified in the last RopSetSearchCriteria ROP request (section 2.2.1.4.1) are being searched.

SEARCH_COMPLETE

0x00001000

The search results are complete.

SEARCH_PARTIAL

0x00002000

Only some parts of messages were included.

SEARCH_STATIC

0x00010000

The search is static.

SEARCH_MAYBE_STATIC

0x00020000

The search is still being evaluated.

CI_TOTALLY

0x01000000

The search is done using content indexing.

TWIR_TOTALLY

0x08000000

The search is done without using content indexing.