2.2.3.4 CPMUpdateDocumentsIn

The CPMUpdateDocumentsIn message directs the server to index the specified path.

The server will reply with the message header of the CPMUpdateDocumentsIn message with the results of the request contained in the _status field of the message header.

The format of the CPMUpdateDocumentsIn 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
_flag (optional)
_fRootPath (optional)
RootPath (variable)
...

_flag (4 bytes): A 32-bit unsigned integer indicating the type of update to be performed. This field MUST be present when the message is sent by the client and MUST be absent when the message is sent by the server. This field SHOULD<7> be set to one of the following values.

Value	Meaning
UPD_INCREM 0x00000000	An incremental update is to be performed.
UPD_FULL 0x00000001	A full update is to be performed.
UPD_INIT 0x00000002	A new initialization is to be performed.

_fRootPath (4 bytes): A Boolean value indicating whether the RootPath field specifies a path on which to perform the update.

Note This field MUST be present when the message is sent by the client and MUST be absent when the message is sent by the server. This field MUST be set to 0x00000001 or 0x00000000. If set to 0x00000001, a path on which to perform the update is included in RootPath. If set to 0x00000000, the update is to be performed on all indexed paths.

RootPath (variable): The name of the path to be updated.

Note This field MUST be present when the message is sent by the client and _fRootPath is not set to 0x00000000. This field MUST be absent when the message is sent by the server. When present, the name MUST be a null-terminated Unicode string.