CPMGetQueryStatusIn - [ms-wsp]: Windows Search Protocol Intellectual Property Rights Notice for Open Specifications Documentation

|
[ms-wsp]: Windows Search Protocol Intellectual Property Rights Notice for Open Specifications Documentation
|
bet | 17/28 | Sana | 25.03.2020 | Hajmi | 349,46 Kb. | | #8793 |
CPMGetQueryStatusIn
The CPMGetQueryStatusIn message requests the status of a query. The format of the CPMGetQueryStatusIn 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
|
_hCursor
|
_hCursor (4 bytes): A 32-bit unsigned integer representing the handle from the CPMCreateQueryOut message identifying the query for which to retrieve status information.
CPMGetQueryStatusOut
The CPMGetQueryStatusOut message replies to a CPMGetQueryStatusIn message with the status of the query.
The format of the CPMGetQueryStatusOut 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
|
_QStatus
|
_QStatus (4 bytes): A 32-bit unsigned integer. A bitmask of values defined in the following tables that describe the query.
The following table lists STAT_* values obtained by performing a bitwise AND operation on _Status with 0x00000007. The result MUST be one of the following.
Constant
|
Meaning
|
STAT_BUSY
0x00000000
|
The asynchronous query is still running.
|
STAT_ERROR
0x00000001
|
The query is in an error state.
|
STAT_DONE
0x00000002
|
The query is complete and rows can be requested.
|
STAT_REFRESH
0x00000003
|
The query is complete, but updates are resulting in additional query computation.
|
The following table lists additional STAT_* bits that can be set independently.
Constant
|
Meaning
|
STAT_NOISE_WORDS
0x00000010
|
Noise words were replaced by wildcard characters in the content query.
|
STAT_CONTENT_OUT_OF_DATE
0x00000020
|
The results of the query might be incorrect because the query involved modified but unindexed files.
|
STAT_CONTENT_QUERY_INCOMPLETE
0x00000080
|
The content query was too complex to complete or required enumeration instead of use of the content index.
|
STAT_TIME_LIMIT_EXCEEDED
0x00000100
|
The results of the query might be incorrect because the query execution reached the maximum allowable time.
|
CPMGetQueryStatusExIn
The CPMGetQueryStatusExIn message requests the status of a query and additional information, such as the number of documents that have been indexed or the number of documents remaining to be indexed. The format of the CPMGetQueryStatusExIn 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
|
_hCursor
|
_bmk
|
_hCursor (4 bytes): A 32-bit value representing the handle from the CPMCreateQueryOut message identifying the query for which to retrieve status information.
_bmk (4 bytes): A 32-bit value indicating the handle of a bookmark whose position is to be retrieved.
CPMGetQueryStatusExOut
The CPMGetQueryStatusExOut message replies to a CPMGetQueryStatusExIn message with both the status of the query and other status information, as outlined in the following diagram.
The format of the CPMGetQueryStatusExOut 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
|
_QStatus
|
_cFilteredDocuments
|
_cDocumentsToFilter
|
_dwRatioFinishedDenominator
|
_dwRatioFinishedNumerator
|
_iRowBmk
|
_cRowsTotal
|
_maxRank
|
_cResultsFound
|
_whereID
|
_QStatus (4 bytes): One of the STAT_* values specified in section 2.2.3.7.
_cFilteredDocuments (4 bytes): A 32-bit unsigned integer indicating the number of documents that have been indexed.
_cDocumentsToFilter (4 bytes): A 32-bit unsigned integer indicating the number of documents that remain to be indexed.
_dwRatioFinishedDenominator (4 bytes): A 32-bit unsigned integer indicating the denominator of the ratio of documents that the query has finished processing.
_dwRatioFinishedNumerator (4 bytes): A 32-bit unsigned integer indicating the numerator of the ratio of documents that the query has finished processing.
_iRowBmk (4 bytes): A 32-bit unsigned integer indicating the approximate position of the bookmark in the rowset in terms of rows.
_cRowsTotal (4 bytes): A 32-bit unsigned integer specifying the total number of rows in the rowset.
_maxRank (4 bytes): A 32-bit unsigned integer specifying the maximum rank found in the rowset.
_cResultsFound (4 bytes): A 32-bit unsigned integer specifying the number of unique results returned in the rowset.
_whereID (4 bytes): A 32-bit unsigned integer that defines a unique WHEREID for referring to the CRestrictionArray used to construct the rowset. This restriction can be reused as a restriction in future queries as long as there is still a cursor returned by CPMCreateQueryOut that has not been freed using CPMFreeCursorIn. This provides the server the option of sharing the evaluation of the restriction across queries.
|
| |