2.2.3.8 CPMFetchValueIn

  • Article

The CPMFetchValueIn message requests metadata about the most recent search query initiated with a CPMCreateQueryIn message.

The format of the CPMFetchValueIn 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

_wid

_cbSoFar

_cbPropSpec

_cbChunk

PropSpec (variable)

...

_padding (variable)

...

_wid (4 bytes): A 32-bit reserved field. MUST be set to 0xFFFFFFFF.

_cbSoFar (4 bytes): A 32-bit unsigned integer containing the number of bytes previously transferred for this property. Note This field MUST be set to 0x00000000 in the first message.

_cbPropSpec (4 bytes): A 32-bit unsigned integer containing the size of the PropSpec field in bytes. The value MUST NOT be 0x00000000 for the first message. It MUST be 0x00000000 for subsequent messages.

_cbChunk (4 bytes): A 32-bit unsigned integer containing the maximum number of bytes that the sender can accept in a CPMFetchValueOut message<9>. The value of this field MUST be greater than 0x0000001C.

PropSpec (variable): A CFullPropSpec structure specifying the property to retrieve. If _cbPropSpec is not 0 then the following field values MUST be set on this structure, otherwise this structure MUST be omitted:

Field

Value

_guidPropSet

E83758B4-0C6E-435B-BCC6-268021EFAD6C

ulKind

PRSPEC_PROPID (0x00000001)

PrSpec

0x00000000

_padding (variable): This field MUST be of the length necessary (0 to 3 bytes) to pad the message out to a multiple of 4 bytes in length. The value of the padding bytes can be any arbitrary value. This field MUST be ignored by the receiver.