Built-in File Enumerators

Built-in File Enumerators

• Built-in File Enumerators
  • FixedFileEnumerator

A file enumerator is responsible for enumerating file paths. How the file paths are gathered or retrieved depends on the specific file enumerator.

The CodeXCavator core engine provides the following built-in file enumerators:

FixedFileEnumerator

The fixed file enumerator is responsible for enumerating a fixed set of files. This set can be specified by providing a configuration containing a list of the files.

• Use the tag with the Type attribute set to FixedFileEnumerator in order to use it.
• Provide a <configuration> tag in order to specify the configuration of the enumerator.</configuration>
• In order to specify the fixed list of files put a <files></files> tag below the <configuration></configuration> tag and put as many <file></file> tags below the <files></files> tag as needed. The file path must be specified as the element text, i.e. it must be enclosed by a <file></file> / tag pair.
• The <file></file> tag is an alias for the FixedFileEnumerator. You can use it to specify a single input file. See also [CodeXCavator Indexer].

Example: Using and configuring the FixedFileEnumerator

<Index Path="D:\Temp\TestIndex">
  <FileSources>
    <Source Type="FixedFileEnumerator">
      <Configuration>
        <Files>
          <File>D:\Programming\Projects\C#\CodeXCavator\FixedFileEnumerator.cs</File>
          <File>D:\Programming\Projects\C#\CodeXCavator\DirectoryFileEnumerator.cs</File>
        </Files>
      </Configuration>
    </Source>
  </FileSource>
</Index>

[Home][CodeXCavator Indexer][Built-in File Catalogue Enumerators][Built-in File Filters]