Show/Hide Toolbars

EmEditor ヘルプ

ナビゲーション: » No topics above this level «

EmEditor プラグイン リファレンス: Editor_GetFilter

Scroll 前へ 上へ 次へ その他
EmEditor ホーム - EmEditor ヘルプ - プラグイン リファレンス - インライン関数

Editor_GetFilter

現在の文書にかけられているフィルターの文字列と設定を取得します。このインライン関数を使うか、または EE_GET_FILTER メッセージを直接送ることができます。

Editor_GetFilter( HWND hwnd, int iFilter, LPWSTR pszFilter, UINT cchFilter, int* piColumn, UINT64* pnFlags, INT_PTR* pxBegin, INT_PTR* pxEnd );

パラメータ

hwnd

EmEditor ビューまたはフレームのウィンドウ ハンドルを指定します。

pszFilter

フィルター文字列を取得するバッファを指定します。

cchFilter

フィルター文字列を取得するバッファのサイズを文字単位で指定します。

piColumn

取得するテキストの列のインデックスを格納する整数へのポインタを指定します。行全体から検索する場合、このインデックスは -1 になります。

pnFlags

フラグを取得する 64-bit 整数へのポインタを指定します。取得されるフラグは次の値の組み合わせになります。

FLAG_FIND_CASE

大文字と小文字を区別して検索します。

FLAG_FIND_ESCAPE

文字列をエスケープ シーケンスで指定します。

FLAG_FIND_LOGICAL_OR

複数レベルのフィルターの場合、以前のレベルに論理和 (論理 OR) でフィルターを実行します。

FLAG_FIND_NEGATIVE

フィルター ツール バーを表示して指定する文字列に一致する行を除外します。

FLAG_FIND_ONLY_WORD

単語のみを検索します。

FLAG_FIND_REG_EXP

文字列を正規表現で指定します。

pxBegin

検索したいテキストの開始位置が論理文字単位で指定されるインデックスを取得する整数へのポインタを指定します。テキストの最後から数えて *pxEnd で指定する場合には -1 になります。

pxEnd

検索したいテキストの終了位置が論理文字単位で指定されるインデックスを取得する整数へのポインタを指定します。最後まで全部を検索する場合には -1 になります。

戻り値

iFilter が 0 以上でメッセージが成功すると、戻り値は TRUE になります。iFilter が -1 の場合、戻り値はフィルターの数になります。

Copyright © 2003-2016 by Emurasoft, Inc.