IMAPIContainer::GetSearchCriteria
適用対象: Outlook 2013 | Outlook 2016
コンテナーの検索条件を取得します。
HRESULT GetSearchCriteria(
ULONG ulFlags,
LPSRestriction FAR * lppRestriction,
LPENTRYLIST FAR * lppContainerList,
ULONG FAR * lpulSearchState
);
パラメーター
ulFlags
[in]渡された文字列の型を制御するフラグのビットマスク。 次のフラグを設定できます。
MAPI_UNICODE
渡された文字列は Unicode 形式です。 MAPI_UNICODE フラグが設定されていない場合、文字列は ANSI 形式です。
lppRestriction
[out]検索条件を定義する SRestriction 構造体へのポインターへのポインター。 クライアント アプリケーションが lppRestriction パラメーターで NULL を渡した場合、 GetSearchCriteria は SRestriction 構造体を返しません。
lppContainerList
[out]検索に含めるコンテナーを表すエントリ識別子の配列へのポインターへのポインター。 クライアントが lppContainerList パラメーターで NULL を渡した場合、GetSearchCriteria はエントリ識別子の配列を返しません。
lpulSearchState
[out]検索の現在の状態を示すために使用されるフラグのビットマスクへのポインター。 クライアントが lpulSearchState パラメーターで NULL を渡した場合、 GetSearchCriteria はフラグを返しません。 次のフラグを設定できます。
SEARCH_FOREGROUND
検索は、他の検索に対して高い優先度で実行する必要があります。 このフラグが設定されていない場合、検索は他の検索に対して通常の優先順位で実行されます。
SEARCH_REBUILD
検索は、条件に一致するメッセージを検索しようとして、その操作の CPU 集中モードにあります。 このフラグが設定されていない場合、検索操作の CPU 負荷の高い部分は終了します。 このフラグは、検索がアクティブな場合 (つまり、SEARCH_RUNNING フラグが設定されている場合) にのみ意味があります。
SEARCH_RECURSIVE
検索では、指定されたコンテナーとそのすべての子コンテナーで、一致するエントリが検索されます。 このフラグが設定されていない場合は、 IMAPIContainer::SetSearchCriteria メソッドの最後の呼び出しに明示的に含まれるコンテナーのみが検索されます。
SEARCH_RUNNING
検索がアクティブであり、メッセージ ストアまたはアドレス帳の変更を反映するようにコンテナーのコンテンツ テーブルが更新されています。 このフラグが設定されていない場合、検索は非アクティブであり、コンテンツ テーブルは静的です。
戻り値
S_OK
検索条件が正常に取得されました。
MAPI_E_BAD_CHARWIDTH
MAPI_UNICODE フラグが設定され、実装で Unicode がサポートされていないか、MAPI_UNICODEが設定されておらず、実装で Unicode のみがサポートされています。
MAPI_E_NOT_INITIALIZED
コンテナーの検索条件が確立されませんでした。
注釈
IMAPIContainer::GetSearchCriteria メソッドは、検索をサポートするコンテナー (通常は検索結果フォルダー) の検索条件を取得します。 検索条件を作成する場合は、コンテナーの IMAPIContainer::SetSearchCriteria メソッドを呼び出します。
実装に関するメモ
アドレス帳コンテナーは、PR_SEARCH (PidTagSearch) プロパティに関連付けられている高度な検索機能を提供する場合にのみ、GetSearchCriteria をサポートする必要がある場合があります。 アドレス帳コンテナーの高度な検索機能を実装する方法の詳細については、「 高度な検索の実装」を参照してください。
呼び出し側への注意
lppRestriction パラメーターと lppContainerList パラメーターが指すデータ構造が完了したら、解放する構造体ごとに MAPIFreeBuffer を 1 回呼び出します。
MFCMAPI リファレンス
MFCMAPI のサンプル コードについては、次の表を参照してください。
| ファイル | 関数 | コメント |
|---|---|---|
| HierarchyTableDlg.cpp |
CHierarchyTableDlg::OnEditSearchCriteria |
MFCMAPI では、 IMAPIContainer::GetSearchCriteria メソッドを使用して、表示するフォルダーから検索条件を取得します。 |