Class GetFileSystemEntries

Namespace

Bonsai.IO

Assembly

Bonsai.System.dll

Represents an operator that generates a sequence containing an array with the names of the files and directories matching the specified search pattern.

public class GetFileSystemEntries : Source<string[]>

Inheritance

object

Source<string[]>

GetFileSystemEntries

Inherited Members

Source<string[]>.Generate()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

Path

Gets or sets the relative or absolute path of the directory to search.

public string Path { get; set; }

Property Value

string

SearchOption

Gets or sets a value specifying whether the search should include only the current directory or all subdirectories.

public SearchOption SearchOption { get; set; }

Property Value

SearchOption

SearchPattern

Gets or sets the search string used to match against the names of file-system entries in the path. This parameter can contain a combination of valid literal path and wildcard characters (see GetFileSystemEntries(string, string, SearchOption)).

public string SearchPattern { get; set; }

Property Value

string

Methods

Generate()

Generates an observable sequence containing an array of file names and directory names that match the search pattern in a specified path, and optionally searches subdirectories.

public override IObservable<string[]> Generate()

Returns

IObservable<string[]>

An observable sequence containing an array with the full names (including paths) for the file-system entries in Path that match the specified SearchPattern and SearchOption.