Filter オブジェクト

このオブジェクトはフィルターを表します。フィルターは名前を付けられたパターンのコレクションで、各パターンはそのタイプと名前によってファイル システム項目に一致します。

プロパティ

Count読み取り専用IFilter

コレクション内のパターンの数。

IDL [propget] HRESULT Count([out, retval] long* pValue)
.NET Int32 Count[get]

Item読み取り専用IFilter

フィルターのパターンの 1 つのコピーを取得するために使用します。

IDL [propget] HRESULT Item(
    [in] VARIANT index,
    [out, retval] IFilterPattern** pValue)
.NET FilterPattern get_Item(
    Object index)
  • index
    コレクションへの整数のインデックス。

Name読み取り/書き込みIFilter

フィルターの名前。

IDL [propget] HRESULT Name([out, retval] BSTR* pValue)
[propput] HRESULT Name([in] BSTR newValue)
.NET String Name[get, set]

メソッド

AddIFilter

指定されたパターンのコピーをコレクションに追加します。

IDL HRESULT Add(
    [in] IFilterPattern* pattern,
    [out, retval] long* pValue)
.NET Int32 Add(
    FilterPattern pattern)
  • pattern
    コレクションに追加するパターン。

InitializeFromExcludePatternIFilter

文字列引数を基にフィルターの除外パターンのリストを作成します。文字列は、任意の数のセミコロンで区切ったパターンで構成することができます。各パターンにはワイルドカードを使用することもできます。円記号で終了するパターンは、ファイルではなくフォルダーに一致すると見なされます。たとえば、*.obj;*.exe;Debug\;Release\ はフィルターに 5 つのパターンを追加します。最初のパターンでは、すべてのファイルとフォルダーが包含され、2 番目と 3 番目では .obj と .exe で終わるファイルが除外されます。4 番目と 5 番目では Debug または Release というフォルダーが除外されます。

IDL HRESULT InitializeFromExcludePattern(
    [in] BSTR pattern)
.NET void InitializeFromExcludePattern(
    String pattern)
  • pattern
    フィルター内でパターンを作成するために使用されるパターン文字列。

InitializeFromIncludePatternIFilter

文字列引数を基にフィルターの包含パターンのリストを作成します。文字列は、任意の数のセミコロンで区切ったパターンで構成することができます。各パターンにはワイルドカードを使用することもできます。円記号で終了するパターンは、ファイルではなくフォルダーに一致すると見なされます。たとえば、*.gif;*.wav;Images\;Sounds\ はフィルターに 4 つのパターンを追加します。1 番目と 2 番目のパターンでは .gif と .wav で終わるファイルが包含され、3 番目と 4 番目では Images と Sounds というフォルダーが包含されます。

IDL HRESULT InitializeFromIncludePattern(
    [in] BSTR pattern)
.NET void InitializeFromIncludePattern(
    String pattern)
  • pattern
    フィルター内でパターンを作成するために使用されるパターン文字列。

RemoveIFilter

コレクション内の指定インデックス位置にあるパターンを削除します。

IDL HRESULT Remove(
    [in] long index)
.NET void Remove(
    Int32 index)
  • index
    削除するパターンのインデックス。

RepositionPatternIFilter

コレクション内でパターンをあるインデックスから別のインデックスに移動します。

IDL HRESULT RepositionPattern(
    [in] long oldIndex,
    [in] long newIndex)
.NET void RepositionPattern(
    Int32 oldIndex,
    Int32 newIndex)
  • oldIndex
    移動するパターンのインデックス。
  • newIndex
    パターンの移動先のインデックス。