2.2.3.6 CPMGetRowsIn
The CPMGetRowsIn message requests rows from a search query. The format of the CPMGetRowsIn message that follows the header is shown in the following diagram.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
_hCursor |
|||||||||||||||||||||||||||||||
|
_cRowsToTransfer |
|||||||||||||||||||||||||||||||
|
_cbRowWidth |
|||||||||||||||||||||||||||||||
|
_cbSeek |
|||||||||||||||||||||||||||||||
|
_cbReserved |
|||||||||||||||||||||||||||||||
|
_cbReadBuffer |
|||||||||||||||||||||||||||||||
|
_ulClientBase |
|||||||||||||||||||||||||||||||
|
Reserved4 |
|||||||||||||||||||||||||||||||
|
Reserved1 |
|||||||||||||||||||||||||||||||
|
Reserved2 |
|||||||||||||||||||||||||||||||
|
Reserved3 |
|||||||||||||||||||||||||||||||
_hCursor (4 bytes): A 32-bit value representing the handle from the CPMCreateQueryOut message identifying the search query for which to retrieve rows.
_cRowsToTransfer (4 bytes): A 32-bit unsigned integer indicating the maximum number of rows the protocol client expects to receive in response to this message.
_cbRowWidth (4 bytes): A 32-bit unsigned integer indicating the length of a row in bytes.
_cbSeek (4 bytes): A 32-bit reserved field. MUST be set to 0x0000000C.
_cbReserved (4 bytes): A 32-bit unsigned integer indicating the offset, in bytes, of the Rows field in the CPMGetRowsOut response message. This offset begins from the first byte of the message header and MUST be set such that the Rows field follows the Reserved1 field.
_cbReadBuffer (4 bytes): A 32-bit unsigned integer. Note This field MUST be set to the maximum of the following two values rounded up to the nearest 512-byte multiple: the value of _cbRowWidth, or 1,000 times the value of _cRowsToTransfer. The value MUST NOT exceed 0x00004000.
_ulClientBase (4 bytes): A 32-bit unsigned integer indicating the base value to use for pointer calculations in the row buffer. If 64-bit offsets are being used, the _ulReserved2 field of the message header is used as the upper 32 bits, and _ulClientBase is used as the lower 32 bits of a 64-bit value. See section 2.2.3.7.
Reserved (4 bytes)4: A 32-bit reserved field. MUST be set to 0x00000000.
Reserved1 (4 bytes): A 32-bit reserved field. MUST be set to 0x00000001.
Reserved2 (4 bytes): A 32-bit reserved field. MUST be set to 0x00000000.
Reserved3 (4 bytes): A 32-bit reserved filed. MUST be set to 0x00000000.