meziantou/Meziantou.Framework.Win32.ProjectedFileSystemv2.0.9
✓ Verified.NET 8.0.NET 9.0.NET 10.0
.NET wrapper for Windows Projected File System (ProjFS)
Get Started
$ dotnet add package Meziantou.Framework.Win32.ProjectedFileSystemReadme
Meziantou.Framework.Win32.ProjectedFileSystem
A .NET wrapper for the Windows Projected File System (ProjFS) API, enabling you to create virtual file systems that appear as normal files and folders to users and applications.
Requirements
- 64-bit process only
- Windows 10 version 1809 or later (with the "Projected File System" optional feature installed)
Enable-WindowsOptionalFeature -Online -FeatureName Client-ProjFS -NoRestart
Usage
Basic Example
Create a virtual file system by inheriting from ProjectedFileSystemBase and implementing the required abstract methods:
using Meziantou.Framework.Win32.ProjectedFileSystem;
public class MyVirtualFileSystem : ProjectedFileSystemBase
{
public MyVirtualFileSystem(string rootFolder) : base(rootFolder)
{
}
// Return the list of files and folders for a given path
protected override IEnumerable<ProjectedFileSystemEntry> GetEntries(string path)
{
if (string.IsNullOrEmpty(path))
{
yield return ProjectedFileSystemEntry.Directory("folder");
yield return ProjectedFileSystemEntry.File("file1.txt", length: 100);
yield return ProjectedFileSystemEntry.File("file2.txt", length: 200);
}
else if (AreFileNamesEqual(path, "folder"))
{
yield return ProjectedFileSystemEntry.File("nested.txt", length: 50);
}
}
// Return a stream to read the file content
protected override Stream OpenRead(string path)
{
if (AreFileNamesEqual(path, "file1.txt"))
{
return new MemoryStream(Encoding.UTF8.GetBytes("Hello, World!"));
}
else if (AreFileNamesEqual(path, "file2.txt"))
{
return new MemoryStream(Encoding.UTF8.GetBytes("Another file content"));
}
else if (AreFileNamesEqual(path, "folder\\nested.txt"))
{
return new MemoryStream(Encoding.UTF8.GetBytes("Nested file"));
}
return null;
}
}
// Start the virtual file system
var rootPath = @"C:\MyVirtualFS";
Directory.CreateDirectory(rootPath);
using var vfs = new MyVirtualFileSystem(rootPath);
vfs.Start(options: null);
// The files are now accessible through Windows Explorer or any application
var content = File.ReadAllText(Path.Combine(rootPath, "file1.txt")); // "Hello, World!"