C# Class BExplorer.Shell.KnownFolderHelper

Creates the helper class for known folders.
Show file Open project: Gainedge/BetterExplorer Class Usage Examples

Public Methods

Method Description
FromCanonicalName ( string canonicalName ) : IKnownFolder

Returns the known folder given its canonical name.

FromKnownFolderId ( System.Guid knownFolderId ) : IKnownFolder

Returns a known folder given a globally unique identifier.

FromParsingName ( string parsingName ) : IKnownFolder

Returns a known folder given its shell path, such as C:\users\public\documents or ::{645FF040-5081-101B-9F08-00AA002F954E} for the Recycle Bin.

FromParsingNameOnly ( string parsingName ) : IKnownFolder

Returns a known folder given its shell namespace parsing name, such as ::{645FF040-5081-101B-9F08-00AA002F954E} for the Recycle Bin.

Private Methods

Method Description
FromKnownFolderIdInternal ( System.Guid knownFolderId ) : IKnownFolder

Returns a known folder given a globally unique identifier.

FromPIDL ( IntPtr pidl ) : IKnownFolderNative

Returns the native known folder (IKnownFolderNative) given a PID list

GetKnownFolder ( IKnownFolderNative knownFolderNative ) : IKnownFolder

Given a native KnownFolder (IKnownFolderNative), create the right type of IKnownFolder object (FileSystemKnownFolder or NonFileSystemKnownFolder)

Method Details

FromCanonicalName() public static method

Returns the known folder given its canonical name.
Thrown if the given canonical name is invalid or if the KnownFolder could not be created.
public static FromCanonicalName ( string canonicalName ) : IKnownFolder
canonicalName string A non-localized canonical name for the known folder, such as MyComputer.
return IKnownFolder

FromKnownFolderId() public static method

Returns a known folder given a globally unique identifier.
Thrown if the given Known Folder ID is invalid.
public static FromKnownFolderId ( System.Guid knownFolderId ) : IKnownFolder
knownFolderId System.Guid A GUID for the requested known folder.
return IKnownFolder

FromParsingName() public static method

Returns a known folder given its shell path, such as C:\users\public\documents or ::{645FF040-5081-101B-9F08-00AA002F954E} for the Recycle Bin.
public static FromParsingName ( string parsingName ) : IKnownFolder
parsingName string The path for the requested known folder; either a physical path or a virtual path.
return IKnownFolder

FromParsingNameOnly() public static method

Returns a known folder given its shell namespace parsing name, such as ::{645FF040-5081-101B-9F08-00AA002F954E} for the Recycle Bin.
Thrown if the given parsing name is invalid.
public static FromParsingNameOnly ( string parsingName ) : IKnownFolder
parsingName string The parsing name (or path) for the requested known folder.
return IKnownFolder