Share via

2.2.1.4.1 RopSetSearchCriteria ROP Request Buffer

  • Article

The following descriptions define valid fields for the RopSetSearchCriteria ROP request buffer ([MS-OXCROPS] section 2.2.4.4.1).

InputHandleIndex (1 byte):  An integer that specifies the location in the Server object handle table where the handle for the input Server object is stored. The input Server object for this operation is a Folder object that represents the search folder.

RestrictionDataSize (2 bytes):  An integer that specifies the size of the RestrictionData field. If the value of the RestrictionDataSize field is zero, the search criteria that were used most recently for the search folder container are used again. The RestrictionDataSize field MUST NOT be set to zero for the first search.

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

FolderIdCount (2 bytes):  An integer that specifies the number of structures contained in the FolderIds field. If the FolderIdCount field is set to zero, the folders that were used in the most recent search are used again. The FolderIdCount field MUST NOT be set to zero for the first search within a search folder container.

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

SearchFlags (4 bytes):  A set of bits that control the search for a search folder. For more details about how these bits affect the search, see section 3.2.5.4.

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

Bit name

Value

Meaning

STOP_SEARCH

0x00000001

The search is aborted. This bit MUST NOT be set at the same time as the RESTART_SEARCH bit. If neither bit is set, the default is RESTART_SEARCH.

RESTART_SEARCH

0x00000002

The search is initiated, if this is the first RopSetSearchCriteria ROP request, or restarted, if the search is inactive. This bit MUST NOT be set at the same time as the STOP_SEARCH bit. If neither bit is set, the default is RESTART_SEARCH.

RECURSIVE_SEARCH

0x00000004

The search includes the search folder containers and all of their child folders. This bit MUST NOT be set at the same time as the SHALLOW_SEARCH bit. If neither bit is set, the default is SHALLOW_SEARCH.

SHALLOW_SEARCH

0x00000008

The search includes only the search folder containers that are specified in the FolderIds field. This bit MUST NOT be set at the same time as the RECURSIVE_SEARCH bit. If neither bit is set, the default is SHALLOW_SEARCH.

CONTENT_INDEXED_SEARCH

0x00010000

The search uses a content-indexed search. This bit MUST NOT be set at the same time as the NON_CONTENT_INDEXED_SEARCH bit. If neither bit is set, the default is at the discretion of the server. For more details, see section 3.2.5.4.

NON_CONTENT_INDEXED_SEARCH

0x00020000

The search does not use a content-indexed search. This bit MUST NOT be set at the same time as the CONTENT_INDEXED_SEARCH bit. If neither bit is set, the default is at the discretion of the server. For more details, see section 3.2.5.4.

STATIC_SEARCH

0x00040000

If set, the search is static. If not set, the search is dynamic.