/* Copyright (C) 2008-2016 Peter Palotas, Jeffrey Jangli, Alexandr Normuradov
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.IO;
using System.Security;
namespace Alphaleonis.Win32.Filesystem
{
partial class Directory
{
/// [AlphaFS] Returns an enumerable collection of file system entries in a specified path.
/// The matching file system entries. The type of the items is determined by the type .
///
///
///
///
///
///
/// The type to return. This may be one of the following types:
///
/// -
///
/// This method will return instances of instances.
///
/// -
///
/// This method will return instances of and instances.
///
/// -
///
/// This method will return the full path of each item.
///
///
///
/// The directory to search.
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Infos")]
[SecurityCritical]
public static IEnumerable EnumerateFileSystemEntryInfos(string path)
{
return EnumerateFileSystemEntryInfosCore(null, path, Path.WildcardStarMatchAll, DirectoryEnumerationOptions.FilesAndFolders, PathFormat.RelativePath);
}
/// [AlphaFS] Returns an enumerable collection of file system entries in a specified path.
/// The matching file system entries. The type of the items is determined by the type .
///
///
///
///
///
///
/// The type to return. This may be one of the following types:
///
/// -
///
/// This method will return instances of instances.
///
/// -
///
/// This method will return instances of and instances.
///
/// -
///
/// This method will return the full path of each item.
///
///
///
/// The directory to search.
/// Indicates the format of the path parameter(s).
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Infos")]
[SecurityCritical]
public static IEnumerable EnumerateFileSystemEntryInfos(string path, PathFormat pathFormat)
{
return EnumerateFileSystemEntryInfosCore(null, path, Path.WildcardStarMatchAll, DirectoryEnumerationOptions.FilesAndFolders, pathFormat);
}
/// [AlphaFS] Returns an enumerable collection of file system entries in a specified path.
/// The matching file system entries. The type of the items is determined by the type .
///
///
///
///
///
///
/// The type to return. This may be one of the following types:
///
/// -
///
/// This method will return instances of instances.
///
/// -
///
/// This method will return instances of and instances.
///
/// -
///
/// This method will return the full path of each item.
///
///
///
/// The directory to search.
/// flags that specify how the directory is to be enumerated.
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Infos")]
[SecurityCritical]
public static IEnumerable EnumerateFileSystemEntryInfos(string path, DirectoryEnumerationOptions options)
{
return EnumerateFileSystemEntryInfosCore(null, path, Path.WildcardStarMatchAll, options, PathFormat.RelativePath);
}
/// [AlphaFS] Returns an enumerable collection of file system entries in a specified path.
/// The matching file system entries. The type of the items is determined by the type .
///
///
///
///
///
///
/// The type to return. This may be one of the following types:
///
/// -
///
/// This method will return instances of instances.
///
/// -
///
/// This method will return instances of and instances.
///
/// -
///
/// This method will return the full path of each item.
///
///
///
/// The directory to search.
/// flags that specify how the directory is to be enumerated.
/// Indicates the format of the path parameter(s).
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Infos")]
[SecurityCritical]
public static IEnumerable EnumerateFileSystemEntryInfos(string path, DirectoryEnumerationOptions options, PathFormat pathFormat)
{
return EnumerateFileSystemEntryInfosCore(null, path, Path.WildcardStarMatchAll, options, pathFormat);
}
/// [AlphaFS] Returns an enumerable collection of file system entries that match a in a specified path.
/// The matching file system entries. The type of the items is determined by the type .
///
///
///
///
///
///
/// The type to return. This may be one of the following types:
///
/// -
///
/// This method will return instances of instances.
///
/// -
///
/// This method will return instances of and instances.
///
/// -
///
/// This method will return the full path of each item.
///
///
///
/// The directory to search.
///
/// The search string to match against the names of directories in .
/// This parameter can contain a combination of valid literal path and wildcard
/// ( and ) characters, but does not support regular expressions.
///
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Infos")]
[SecurityCritical]
public static IEnumerable EnumerateFileSystemEntryInfos(string path, string searchPattern)
{
return EnumerateFileSystemEntryInfosCore(null, path, searchPattern, DirectoryEnumerationOptions.FilesAndFolders, PathFormat.RelativePath);
}
/// [AlphaFS] Returns an enumerable collection of file system entries that match a in a specified path.
/// The matching file system entries. The type of the items is determined by the type .
///
///
///
///
///
///
/// The type to return. This may be one of the following types:
///
/// -
///
/// This method will return instances of instances.
///
/// -
///
/// This method will return instances of and instances.
///
/// -
///
/// This method will return the full path of each item.
///
///
///
/// The directory to search.
///
/// The search string to match against the names of directories in .
/// This parameter can contain a combination of valid literal path and wildcard
/// ( and ) characters, but does not support regular expressions.
///
/// Indicates the format of the path parameter(s).
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Infos")]
[SecurityCritical]
public static IEnumerable EnumerateFileSystemEntryInfos(string path, string searchPattern, PathFormat pathFormat)
{
return EnumerateFileSystemEntryInfosCore(null, path, searchPattern, DirectoryEnumerationOptions.FilesAndFolders, pathFormat);
}
/// [AlphaFS] Returns an enumerable collection of file system entries that match a in a specified path using .
/// The matching file system entries. The type of the items is determined by the type .
///
///
///
///
///
///
/// The type to return. This may be one of the following types:
///
/// -
///
/// This method will return instances of instances.
///
/// -
///
/// This method will return instances of and instances.
///
/// -
///
/// This method will return the full path of each item.
///
///
///
/// The directory to search.
///
/// The search string to match against the names of directories in .
/// This parameter can contain a combination of valid literal path and wildcard
/// ( and ) characters, but does not support regular expressions.
///
/// flags that specify how the directory is to be enumerated.
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Infos")]
[SecurityCritical]
public static IEnumerable EnumerateFileSystemEntryInfos(string path, string searchPattern, DirectoryEnumerationOptions options)
{
return EnumerateFileSystemEntryInfosCore(null, path, searchPattern, options, PathFormat.RelativePath);
}
/// [AlphaFS] Returns an enumerable collection of file system entries that match a in a specified path using .
/// The matching file system entries. The type of the items is determined by the type .
///
///
///
///
///
///
/// The type to return. This may be one of the following types:
///
/// -
///
/// This method will return instances of instances.
///
/// -
///
/// This method will return instances of and instances.
///
/// -
///
/// This method will return the full path of each item.
///
///
///
/// The directory to search.
///
/// The search string to match against the names of directories in .
/// This parameter can contain a combination of valid literal path and wildcard
/// ( and ) characters, but does not support regular expressions.
///
/// flags that specify how the directory is to be enumerated.
/// Indicates the format of the path parameter(s).
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Infos")]
[SecurityCritical]
public static IEnumerable EnumerateFileSystemEntryInfos(string path, string searchPattern, DirectoryEnumerationOptions options, PathFormat pathFormat)
{
return EnumerateFileSystemEntryInfosCore(null, path, searchPattern, options, pathFormat);
}
#region Transactional
/// [AlphaFS] Returns an enumerable collection of file system entries in a specified path.
/// The matching file system entries. The type of the items is determined by the type .
///
///
///
///
///
///
/// The type to return. This may be one of the following types:
///
/// -
///
/// This method will return instances of instances.
///
/// -
///
/// This method will return instances of and instances.
///
/// -
///
/// This method will return the full path of each item.
///
///
///
/// The transaction.
/// The directory to search.
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Infos")]
[SecurityCritical]
public static IEnumerable EnumerateFileSystemEntryInfosTransacted(KernelTransaction transaction, string path)
{
return EnumerateFileSystemEntryInfosCore(transaction, path, Path.WildcardStarMatchAll, DirectoryEnumerationOptions.FilesAndFolders, PathFormat.RelativePath);
}
/// [AlphaFS] Returns an enumerable collection of file system entries in a specified path.
/// The matching file system entries. The type of the items is determined by the type .
///
///
///
///
///
///
/// The type to return. This may be one of the following types:
///
/// -
///
/// This method will return instances of instances.
///
/// -
///
/// This method will return instances of and instances.
///
/// -
///
/// This method will return the full path of each item.
///
///
///
/// The transaction.
/// The directory to search.
/// Indicates the format of the path parameter(s).
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Infos")]
[SecurityCritical]
public static IEnumerable EnumerateFileSystemEntryInfosTransacted(KernelTransaction transaction, string path, PathFormat pathFormat)
{
return EnumerateFileSystemEntryInfosCore(transaction, path, Path.WildcardStarMatchAll, DirectoryEnumerationOptions.FilesAndFolders, pathFormat);
}
/// [AlphaFS] Returns an enumerable collection of file system entries in a specified path.
/// The matching file system entries. The type of the items is determined by the type .
///
///
///
///
///
///
/// The type to return. This may be one of the following types:
///
/// -
///
/// This method will return instances of instances.
///
/// -
///
/// This method will return instances of and instances.
///
/// -
///
/// This method will return the full path of each item.
///
///
///
/// The transaction.
/// The directory to search.
/// flags that specify how the directory is to be enumerated.
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Infos")]
[SecurityCritical]
public static IEnumerable EnumerateFileSystemEntryInfosTransacted(KernelTransaction transaction, string path, DirectoryEnumerationOptions options)
{
return EnumerateFileSystemEntryInfosCore(transaction, path, Path.WildcardStarMatchAll, options, PathFormat.RelativePath);
}
/// [AlphaFS] Returns an enumerable collection of file system entries in a specified path.
/// The matching file system entries. The type of the items is determined by the type .
///
///
///
///
///
///
/// The type to return. This may be one of the following types:
///
/// -
///
/// This method will return instances of instances.
///
/// -
///
/// This method will return instances of and instances.
///
/// -
///
/// This method will return the full path of each item.
///
///
///
/// The transaction.
/// The directory to search.
/// flags that specify how the directory is to be enumerated.
/// Indicates the format of the path parameter(s).
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Infos")]
[SecurityCritical]
public static IEnumerable EnumerateFileSystemEntryInfosTransacted(KernelTransaction transaction, string path, DirectoryEnumerationOptions options, PathFormat pathFormat)
{
return EnumerateFileSystemEntryInfosCore(transaction, path, Path.WildcardStarMatchAll, options, pathFormat);
}
/// [AlphaFS] Returns an enumerable collection of file system entries that match a in a specified path.
/// The matching file system entries. The type of the items is determined by the type .
///
///
///
///
///
///
/// The type to return. This may be one of the following types:
///
/// -
///
/// This method will return instances of instances.
///
/// -
///
/// This method will return instances of and instances.
///
/// -
///
/// This method will return the full path of each item.
///
///
///
/// The transaction.
/// The directory to search.
///
/// The search string to match against the names of directories in .
/// This parameter can contain a combination of valid literal path and wildcard
/// ( and ) characters, but does not support regular expressions.
///
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Infos")]
[SecurityCritical]
public static IEnumerable EnumerateFileSystemEntryInfosTransacted(KernelTransaction transaction, string path, string searchPattern)
{
return EnumerateFileSystemEntryInfosCore(transaction, path, searchPattern, DirectoryEnumerationOptions.FilesAndFolders, PathFormat.RelativePath);
}
/// [AlphaFS] Returns an enumerable collection of file system entries that match a in a specified path.
/// The matching file system entries. The type of the items is determined by the type .
///
///
///
///
///
///
/// The type to return. This may be one of the following types:
///
/// -
///
/// This method will return instances of instances.
///
/// -
///
/// This method will return instances of and instances.
///
/// -
///
/// This method will return the full path of each item.
///
///
///
/// The transaction.
/// The directory to search.
///
/// The search string to match against the names of directories in .
/// This parameter can contain a combination of valid literal path and wildcard
/// ( and ) characters, but does not support regular expressions.
///
/// Indicates the format of the path parameter(s).
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Infos")]
[SecurityCritical]
public static IEnumerable EnumerateFileSystemEntryInfosTransacted(KernelTransaction transaction, string path, string searchPattern, PathFormat pathFormat)
{
return EnumerateFileSystemEntryInfosCore(transaction, path, searchPattern, DirectoryEnumerationOptions.FilesAndFolders, pathFormat);
}
/// [AlphaFS] Returns an enumerable collection of file system entries that match a in a specified path using .
/// The matching file system entries. The type of the items is determined by the type .
///
///
///
///
///
///
/// The type to return. This may be one of the following types:
///
/// -
///
/// This method will return instances of instances.
///
/// -
///
/// This method will return instances of and instances.
///
/// -
///
/// This method will return the full path of each item.
///
///
///
/// The transaction.
/// The directory to search.
///
/// The search string to match against the names of directories in .
/// This parameter can contain a combination of valid literal path and wildcard
/// ( and ) characters, but does not support regular expressions.
///
/// flags that specify how the directory is to be enumerated.
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Infos")]
[SecurityCritical]
public static IEnumerable EnumerateFileSystemEntryInfosTransacted(KernelTransaction transaction, string path, string searchPattern, DirectoryEnumerationOptions options)
{
return EnumerateFileSystemEntryInfosCore(transaction, path, searchPattern, options, PathFormat.RelativePath);
}
/// [AlphaFS] Returns an enumerable collection of file system entries that match a in a specified path using .
/// The matching file system entries. The type of the items is determined by the type .
///
///
///
///
///
///
/// The type to return. This may be one of the following types:
///
/// -
///
/// This method will return instances of instances.
///
/// -
///
/// This method will return instances of and instances.
///
/// -
///
/// This method will return the full path of each item.
///
///
///
/// The transaction.
/// The directory to search.
///
/// The search string to match against the names of directories in .
/// This parameter can contain a combination of valid literal path and wildcard
/// ( and ) characters, but does not support regular expressions.
///
/// flags that specify how the directory is to be enumerated.
/// Indicates the format of the path parameter(s).
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Infos")]
[SecurityCritical]
public static IEnumerable EnumerateFileSystemEntryInfosTransacted(KernelTransaction transaction, string path, string searchPattern, DirectoryEnumerationOptions options, PathFormat pathFormat)
{
return EnumerateFileSystemEntryInfosCore(transaction, path, searchPattern, options, pathFormat);
}
#endregion // Transactional
#region Internal Methods
/// Returns an enumerable collection of file system entries in a specified path using .
/// The matching file system entries. The type of the items is determined by the type .
///
///
///
///
///
///
/// The type to return. This may be one of the following types:
///
/// -
///
/// This method will return instances of instances.
///
/// -
///
/// This method will return instances of and instances.
///
/// -
///
/// This method will return the full path of each item.
///
///
///
/// The transaction.
/// The directory to search.
///
/// The search string to match against the names of directories in .
/// This parameter can contain a combination of valid literal path and wildcard
/// ( and ) characters, but does not support regular expressions.
///
/// flags that specify how the directory is to be enumerated.
/// Indicates the format of the path parameter(s).
[SecurityCritical]
internal static IEnumerable EnumerateFileSystemEntryInfosCore(KernelTransaction transaction, string path, string searchPattern, DirectoryEnumerationOptions options, PathFormat pathFormat)
{
// Enable BasicSearch and LargeCache by default.
options |= DirectoryEnumerationOptions.BasicSearch | DirectoryEnumerationOptions.LargeCache;
return new FindFileSystemEntryInfo(true, transaction, path, searchPattern, options, typeof(T), pathFormat).Enumerate();
}
#endregion // Internal Methods
}
}