Skip to content

Commit 4ccce1d

Browse files
authored
Merge pull request #58 from brphelps/patch-1
Add info about enabling projFS re: badimageformat
2 parents cdb931a + 5bc1ae7 commit 4ccce1d

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,9 @@ very large git repos.
1717
Conceptual documentation for ProjFS along with documentation of its Win32 API is at
1818
[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/desktop/projfs/projected-file-system).
1919

20-
ProjFS ships as an [optional component](https://docs.microsoft.com/en-us/windows/desktop/projfs/enabling-windows-projected-file-system)
21-
starting in Windows 10 version 1809.
20+
## Enabling ProjFS
21+
22+
ProjFS enablement is **required** for this library to work correctly. ProjFS ships as an [optional component](https://docs.microsoft.com/en-us/windows/desktop/projfs/enabling-windows-projected-file-system) starting in Windows 10 version 1809.
2223

2324
## About the ProjFS Managed API
2425

@@ -68,12 +69,10 @@ you can run SimpleProviderManaged.exe or a provider of your own devising. Refer
6869
[this page](https://docs.microsoft.com/en-us/windows/desktop/projfs/enabling-windows-projected-file-system)
6970
for instructions.
7071

71-
### Dealing with a BadImageFormatException at run time under .NET Core
72-
If you encounter this exception pattern at runtime when using this package under .NET Core:
73-
74-
System.BadImageFormatException: Could not load file or assembly 'ProjectedFSLib.Managed, Version=1.2.19351.1, Culture=neutral, PublicKeyToken=31bf3856ad364e35'. An attempt was made to load a program with an incorrect format.
72+
### Dealing with BadImageFormatExceptions
73+
The simplest cause for BadImageFormatExceptions is that you still need to [enable ProjFS](#enabling-projfs).
7574

76-
This typically occurs when the .NET Core loader attempts to find Ijwhost.dll from the .NET Core runtime. To force this to be deployed with your application under MSBuild, add the following property to each csproj file that is importing the Microsoft.Windows.ProjFS package:
75+
For .Net Core specific consumers, this can also occur when the .NET Core loader attempts to find Ijwhost.dll from the .NET Core runtime. To force this to be deployed with your application under MSBuild, add the following property to each csproj file that is importing the Microsoft.Windows.ProjFS package:
7776

7877
<PropertyGroup>
7978
<UseIJWHost>True</UseIJWHost>

0 commit comments

Comments
 (0)