Skip to content

Commit 53a8577

Browse files
authored
Merge pull request #789 from jengelh/search
mapi: document more flags returned by IMAPIContainer::GetSearchCriteria
2 parents a0b471a + 82fa183 commit 53a8577

1 file changed

Lines changed: 33 additions & 5 deletions

File tree

docs/outlook/mapi/imapicontainer-getsearchcriteria.md

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,22 +53,50 @@ MAPI_UNICODE
5353

5454
> [out] A pointer to a bitmask of flags used to indicate the current state of the search. If a client passes NULL in the _lpulSearchState_ parameter, **GetSearchCriteria** returns no flags. The following flags can be set:
5555
56-
SEARCH_FOREGROUND
56+
SEARCH_FOREGROUND (0x1)
5757

5858
> The search should run at high priority relative to other searches. If this flag is not set, the search runs at normal priority relative to other searches.
5959
60-
SEARCH_REBUILD
60+
SEARCH_REBUILD (0x2)
6161

6262
> The search is in the CPU-intensive mode of its operation, trying to locate messages that match the criteria. If this flag is not set, the CPU-intensive part of the search's operation is over. This flag has meaning only if the search is active (that is, if the SEARCH_RUNNING flag is set).
6363
64-
SEARCH_RECURSIVE
64+
SEARCH_RECURSIVE (0x4)
6565

6666
> The search is looking in specified containers and all their child containers for matching entries. If this flag is not set, only the containers explicitly included in the last call to the [IMAPIContainer::SetSearchCriteria](imapicontainer-setsearchcriteria.md) method are being searched.
6767
68-
SEARCH_RUNNING
68+
SEARCH_RUNNING (0x8)
6969

7070
> The search is active and the container's contents table is being updated to reflect changes in the message store or address book. If this flag is not set, the search is inactive and the contents table is static.
71-
71+
72+
SEARCH_COMPLETE (0x1000)
73+
74+
> The search results are complete.
75+
76+
SEARCH_PARTIAL (0x2000)
77+
78+
> Only some parts of messages were included.
79+
80+
SEARCH_STATIC (0x10000)
81+
82+
> The search is static.
83+
84+
SEARCH_MAYBE_STATIC (0x20000)
85+
86+
> The search is still being evaluated.
87+
88+
CI_TOTALLY (0x1000000)
89+
90+
> The search is done using content indexing exclusively.
91+
92+
CI_WITH_TWIR_RESIDUAL (0x2000000)
93+
94+
TWIR_MOSTLY (0x4000000)
95+
96+
TWIR_TOTALLY (0x8000000)
97+
98+
> The search is done without using content indexing, and using tables with restrictions exclusively.
99+
72100
## Return value
73101

74102
S_OK

0 commit comments

Comments
 (0)