Syroot.Windows.IO.KnownFolders 1.3.0

Prefix Reserved
.NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. 
dotnet add package Syroot.Windows.IO.KnownFolders --version 1.3.0
                    


                    

                
NuGet\Install-Package Syroot.Windows.IO.KnownFolders -Version 1.3.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Syroot.Windows.IO.KnownFolders" Version="1.3.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Syroot.Windows.IO.KnownFolders" Version="1.3.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Syroot.Windows.IO.KnownFolders" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Syroot.Windows.IO.KnownFolders --version 1.3.0
                    


                    

                
#r "nuget: Syroot.Windows.IO.KnownFolders, 1.3.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#addin nuget:?package=Syroot.Windows.IO.KnownFolders&version=1.3.0
                    


                            Install Syroot.Windows.IO.KnownFolders as a Cake Addin
                        

                    

                
#tool nuget:?package=Syroot.Windows.IO.KnownFolders&version=1.3.0
                    


                            Install Syroot.Windows.IO.KnownFolders as a Cake Tool

KnownFolders

This library retrieves paths to all "special folders" available on Windows systems, including those not exposed by the System.Environment.GetFolderPath method, which only covers folders available up to Windows XP, most popularly missing the path to the "Downloads" or other user folders introduced in Windows Vista and later.

The library is is available on NuGet. The motivation is described in my CodeProject article.

Usage

using Syroot.Windows.IO;
string downloadsPath = KnownFolders.Downloads.Path;

The starting point is a KnownFolder instance, which represents exactly one special folder. It offers access to the following:

  • string Path { get; set; }: The current path (which might be customized by the user). This is what you want in most cases.
  • string DefaultPath { get; set; }: The default path the folder has if it would not have been redirected.
  • string ExpandedPath { get; set; }: Same as Path, but with all environment variables expanded.
  • string DisplayName { get; }: Returns a user friendly folder name as displayed in the File Explorer.
  • Create(): This method creates and initializes the known folder, e.g. creates the folder at the current path and writes the corresponding Desktop.ini (to set up the icon and localized name).

To retrieve a KnownFolder instance, there are two ways, depending on what you want to do:

  1. The easiest way is to use one of the many properties in the static KnownFolders class, which contains one property for each special folder.
  2. If you want to get the paths of another user than the current one (required rights assumed), you have to use the constructor of the KnownFolder class. You pass in a value of the KnownFolderType enumeration (which contains one member for each special folder) and the WindowsIdentity instance of the user to impersonate.

The test application shows more sample code to enumerate all known folders of a Windows system.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (8)

Showing the top 5 NuGet packages that depend on Syroot.Windows.IO.KnownFolders:

Package Downloads
Davasorus.Utility.Api.ApiInteraction

Update API Interaction for TEPS Utilities
SDSDownloadOperations

A simple downloader package that can be used for creating simple yet efficient file downloading applications. If you'd like, please send me your opinions on the package through email so that I could improve it as time goes on. This version of the project has discontinued and has moved to here: https://www.nuget.org/packages/CarbonlessWebOperations/1.1.0 This project will no longer be updated.
Davasorus.Utility.Utility.ApiInteraction

Generic API interaction code for TEPS Utilities
AutomationFramework_NetCore

AT Net Core Automation Framework
PureManApplicationDeployment.Blue-10

Wrapper for ClickOnce in .NET 6

GitHub repositories (4)

Showing the top 4 popular GitHub repositories that depend on Syroot.Windows.IO.KnownFolders:

Repository Stars
qmk/qmk_toolbox
A Toolbox companion for QMK Firmware
omeryanar/FileExplorer
Windows File Explorer alternative with tab browsing
bcssov/IronyModManager
Mod Manager for Paradox Games. Official Discord: https://discord.gg/t9JmY8KFrV
SafeExamBrowser/seb-win-refactoring
Safe Exam Browser for Windows.
Version Downloads Last updated
1.3.0 224,161 4/20/2022
1.2.4 3,801 4/14/2022
1.2.3 492,911 2/26/2020
1.2.1 143,866 10/22/2018

Add KnownFolder.DisplayName property to retrieve user friendly folder names.