このオブジェクトはフィルタを表します。フィルタは名前を付けられたパターンのコレクションで、各パターンはそのタイプと名前によってファイル システム項目に一致します。
プロパティ (IFilter インターフェイスによって実装されます )
Count
| IDL | [propget] HRESULT Count([out, retval] long* pValue) |
|---|---|
| .NET | Int32 Count[get] |
| VB6 | Count As Long |
コレクション内のパターンの数。
このプロパティは 取得のみです。
Item
| IDL | [propget] HRESULT Item([in] VARIANT index, [out, retval] IFilterPattern** pValue) |
|---|---|
| .NET | FilterPattern get_Item(Object index) |
| VB6 | Item(index As Variant) As FilterPattern |
フィルタのパターンの 1 つのコピーを取得するのに使用します。
このプロパティは 取得のみです。
引数
-
index
コレクションへの整数のインデックス。
Name
| IDL | [propget] HRESULT Name([out, retval] BSTR* pValue) |
|---|---|
| .NET | String Name[get, set] |
| VB6 | Name As String |
フィルタの名前。
このプロパティは 取得と設定が可能です。
メソッド
Add
| IDL | HRESULT Add([in] IFilterPattern* pattern, [out, retval] long* pValue) |
|---|---|
| .NET | Int32 Add(FilterPattern pattern) |
| VB6 | Add(pattern As FilterPattern) As Long |
指定されたパターンのコピーをコレクションに追加します。
引数
-
pattern
コレクションに追加するパターン。
InitializeFromExcludePattern
| IDL | HRESULT InitializeFromExcludePattern([in] BSTR pattern) |
|---|---|
| .NET | void InitializeFromExcludePattern(String pattern) |
| VB6 | InitializeFromExcludePattern(pattern As String) |
文字列引数からフィルタの除外パターンのリストを作成します。文字列は、任意の数のセミコロンで区切ったパターンで構成することができます。各パターンにはワイルドカードを使用することもできます。円記号で終了するパターンは、ファイルではなくフォルダに一致すると見なされます。
たとえば、*.obj;*.exe;Debug¥;Release¥ はフィルタに 5 つのパターンを追加します。最初のパターンでは、すべてのファイルとフォルダが包含され、2 番目と 3 番目では .obj と .exe で終わるファイルが除外されます。4 番目と 5 番目では Debug または Release というフォルダが除外されます。
引数
-
pattern
フィルタ内でパターンを作成するのに使用されるパターン文字列。
InitializeFromIncludePattern
| IDL | HRESULT InitializeFromIncludePattern([in] BSTR pattern) |
|---|---|
| .NET | void InitializeFromIncludePattern(String pattern) |
| VB6 | InitializeFromIncludePattern(pattern As String) |
文字列引数からフィルタの包含パターンのリストを作成します。文字列は、任意の数のセミコロンで区切ったパターンで構成することができます。各パターンにはワイルドカードを使用することもできます。円記号で終了するパターンは、ファイルではなくフォルダに一致すると見なされます。
たとえば、*.gif;*.wav;Images¥;Sounds¥ はフィルタに 4 つのパターンを追加します。1 番目と 2 番目のパターンでは .gif と .wav で終わるファイルが包含され、3 番目と 4 番目では Images と Sounds というフォルダが包含されます。
引数
-
pattern
フィルタ内でパターンを作成するのに使用されるパターン文字列。
Remove
| IDL | HRESULT Remove([in] long index) |
|---|---|
| .NET | void Remove(Int32 index) |
| VB6 | Remove(index As Long) |
コレクション内で指定されたインデックスのパターンを削除します。
引数
-
index
削除するパターンのインデックス。
RepositionPattern
| IDL | HRESULT RepositionPattern([in] long oldIndex, [in] long newIndex) |
|---|---|
| .NET | void RepositionPattern(Int32 oldIndex, Int32 newIndex) |
| VB6 | RepositionPattern(oldIndex As Long, newIndex As Long) |
コレクション内でパターンをあるインデックスから別のインデックスに移動します。
引数
-
oldIndex
移動するパターンのインデックス。
-
newIndex
パターンの移動先のインデックス。