2.2.3.2 CPMSetCatStateIn
The CPMSetCatStateIn message sets the state of a catalog. The format of the CPMSetCatStateIn message that follows the header is as follows.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
_partID |
|||||||||||||||||||||||||||||||
|
_dwNewState |
|||||||||||||||||||||||||||||||
|
_CatName (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
_partID (4 bytes): MUST be set to 0x00000001.
_dwNewState (4 bytes): MUST be set to exactly one of the following values (that is, they cannot be combined with an OR operator), indicating the new state of the catalog.
-
Value
Meaning
CICAT_STOPPED
0x00000001
The catalog is stopped. This state means that no new files are to be indexed, and no search queries are to be processed.
CICAT_READONLY
0x00000002
The catalog is read-only. No new files are to be indexed.
CICAT_WRITABLE
0x00000004
The catalog is writable. New files can be indexed, and search queries are to be processed.
CICAT_NO_QUERY
0x00000008
The catalog is not available for querying.
CICAT_GET_STATE
0x00000010
The state of the catalog is not to be changed, only retrieved.
CICAT_ALL_OPENED
0x00000020
A check to see if all of the catalogs have been started. If so, the _dwOldState field sent in the CPMSetCatStateOut reply to this message will be reported as nonzero.
_CatName (variable): The name of the catalog that is to have its state modified. The name MUST be a null-terminated Unicode string. This field MUST be omitted if _dwNewState is set to CICAT_ALL_OPENED.