2.2.1.15 CRowsetProperties
The CRowsetProperties structure contains configuration information for a search query.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
_uBooleanOptions |
|||||||||||||||||||||||||||||||
|
_ulMaxOpenRows |
|||||||||||||||||||||||||||||||
|
_ulMemoryUsage |
|||||||||||||||||||||||||||||||
|
_cMaxResults |
|||||||||||||||||||||||||||||||
|
cCmdTimeout |
|||||||||||||||||||||||||||||||
|
_padding (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
_guidRankingModelId (16 bytes) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
_guidUserid (16 bytes) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
_guidCorrelationId (16 bytes) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
_uBooleanOptions (4 bytes): This field specifies various query Boolean options.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
A |
B |
C |
D |
E |
F |
G |
H |
I |
J |
K |
L |
M |
N |
O |
P |
Q |
R |
S |
T |
U |
V |
W |
X |
Y |
Z |
AA |
AB |
AC |
AD |
AE |
AF |
-
A - U0 (1 bit): MUST be set to "1" and MUST be ignored.
B through C - U1, U2 (1 bit each): MUST be set to "0" and MUST be ignored.
-
D - A1 (1 bit): Indicates whether the query is executed in an asynchronous way. Its value MUST be "0" if the query is executed in a synchronous way and "1" otherwise. If the value is "1", the protocol client MUST receive the CPMSendNotify response from the protocol server before sending CPMFetchValueIn and CPMGetRowsIn messages, as specified in section 3.1.5.
-
E - A2 (1 bit): MUST be equal to A1.
F through O - U3, U4, U5, U6, U7, U8, U9, U10, U11, U12 (1 bit each): MUST be set to "0" and MUST be ignored.
-
P - IN (1 bit): Specifies the desired noise word behavior. Its value MUST be "1" if the noise words are ignored and "0" otherwise.
Q through U - U13, U14, U15, U16, U17 (1 bit each): MUST be set to "0" and MUST be ignored.
-
V - AT (1 bit): Specifies the desired token inclusion behavior that MUST be used by the server unless the inclusion behavior is specified explicitly by keyword syntax, as specified in [MS-SEARCH] section 2.2.11.8. If the value is "0", the server MUST return only the search results containing all of the tokens in the query. Otherwise, the server MUST return search results that contain any of the tokens.
-
W - ES (1 bit): Specifies the desired stemming query expansion behavior. If the value is "1", the server MUST use stemming query expansion. If the value is "0", the server MUST NOT use stemming query expansion.
-
X - EP (1 bit): Specifies the desired phonetics query expansion behavior. If the value is "1", the server MUST use phonetic query expansion, which means that phonetically similar tokens MUST be used for query expansion. If the value is "0", the server MUST NOT use phonetic query expansion. The logic used to identify phonetic similarity of tokens depends on server implementation.
-
Y - EN (1 bit): Specifies the desired nicknames query expansion behavior. If the value is "1", the server MUST use nicknames query expansion. If the value is "0", the server MUST NOT use nicknames query expansion.
-
Z - IT (1 bit): Indicates whether all server-side query execution time limits are ignored. The value MUST be "1" if the query is allowed to be executed indefinitely and "0" otherwise.
AA through AF - U18, U19, U20, U21, U22, U23 (1 bit each): MUST be set to "0" and MUST be ignored.
_ulMaxOpenRows (4 bytes): A 32-bit unsigned integer. MUST be set to "0x00000000". Not used, and MUST be ignored.
_ulMemoryUsage (4 bytes): A 32-bit unsigned integer. MUST be set to "0x00000000". Not used, and MUST be ignored.
_cMaxResults (4 bytes): A 32-bit unsigned integer, specifying the maximum number of rows that are to be returned for the query. If _cMaxResults is set to "0x00000000", the server assumes all rows are requested and behaves as if "0xFFFFFFFF" was specified in _cMaxResults.
_cCmdTimeout (4 bytes): A 32-bit unsigned integer, specifying the number of seconds at which a query is to time out, counting from the time the query starts executing on the server. On a timeout, the query is interrupted and terminated, and the server continues to communicate with the client using the regular sequence of messages. A value of "0x00000000" means that the query will not time out.
_padding (variable): This field MUST be zero to 7 bytes in length. The length of this field MUST be such that the following field begins at an offset that is a multiple of 8 bytes from the beginning of the message that contains this structure. If the length of this field is nonzero, the value it contains is arbitrary. The contents of this field MUST be ignored by the receiver.
_guidRankingModelId (16 bytes): A 16-byte GUID value, specifying the identifier of the ranking model to be used for query execution. The GUID value "00000000-0000-0000-0000-000000000000" specifies the default ranking model.
_guidUserId (16 bytes): A 16-byte GUID value, specifying the user profile identifier of the user to be used for personalized ranking features.
_guidCorrelationId (16 bytes): A 16-byte GUID value that identifies the query for debugging purposes. There are no constraints on this value.