2.2.3.4 CPMCreateQueryOut

The CPMCreateQueryOut message contains a response to a CPMCreateQueryIn message.

The format of the CPMCreateQueryOut message that follows the header is shown in the following diagram.


0


1


2


3


4


5


6


7


8


9

1
0


1


2


3


4


5


6


7


8


9

2
0


1


2


3


4


5


6


7


8


9

3
0


1

_fTrueSequential

_fWorkIdUnique

Cursor

_fTrueSequential (4 bytes): A 32-bit unsigned integer that indicates whether the protocol server can use the search catalog in such a way that query results will likely be delivered faster. This field MUST be set to one of the values in the following table.

Value

Meaning

0x00000000

For the search query provided in CPMCreateQueryIn, there would be a bigger latency in delivering query results.

0x00000001

For the search query provided in CPMCreateQueryIn, the protocol server can use the search catalog in such a way that query results will likely be delivered faster.

_fWorkIdUnique (4 bytes): A Boolean value indicating if the document identifiers pointed to by the cursors are unique throughout query results. MUST be set to one of the following values.

Value

Meaning

0x00000000

The document identifiers are unique only throughout the rowset.

0x00000001

The document identifiers are unique across multiple query results.

Cursor (4 bytes): A 32-bit unsigned integer representing the handle to the cursor that identifies the query being executed.