sean-m
/
Vanara
mirror of https://github.com/dahall/Vanara.git
1
0
Fork 0
Code Issues Releases Wiki Activity

BREAKING CHANGES: Guid.KnownFolderId() and Environment.SpecialFolder.KnownFolderId were changed to return null when value is not found rather than throwing an exception.

master
David Hall 2024-06-14 14:55:36 -04:00
parent 099576f5e6
commit 7e05dd64bf
1 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
PInvoke/Shell32/KnownFolderIdExt.cs
View File

@ -46,9 +46,8 @@ public static class KnownFolderIdExt
/// <param name="guid">The unique identifier representing a known folder.</param> /// <param name="guid">The unique identifier representing a known folder.</param>
/// <returns>A corresponding <see cref="KNOWNFOLDERID"/>, if found. If not, an exception is thrown.</returns> /// <returns>A corresponding <see cref="KNOWNFOLDERID"/>, if found. If not, an exception is thrown.</returns>
/// <exception cref="ArgumentOutOfRangeException">guid - Provided GUID value does not correspond to a known folder.</exception> /// <exception cref="ArgumentOutOfRangeException">guid - Provided GUID value does not correspond to a known folder.</exception>
public static KNOWNFOLDERID KnownFolderId(this Guid guid) => public static KNOWNFOLDERID? KnownFolderId(this Guid guid) =>
AssociateAttribute.TryEnumLookup<KNOWNFOLDERID>(guid, out var kf) ? kf : AssociateAttribute.TryEnumLookup<KNOWNFOLDERID>(guid, out var kf) ? kf : null;
throw new ArgumentOutOfRangeException(nameof(guid), "Provided GUID value does not correspond to a known folder.");
/// <summary>Gets a registry property associated with this known folder.</summary> /// <summary>Gets a registry property associated with this known folder.</summary>
/// <typeparam name="T">Return type.</typeparam> /// <typeparam name="T">Return type.</typeparam>
@ -66,13 +65,13 @@ public static class KnownFolderIdExt
/// <summary>Retrieves the <see cref="KNOWNFOLDERID"/> associated with the <see cref="Environment.SpecialFolder"/>.</summary> /// <summary>Retrieves the <see cref="KNOWNFOLDERID"/> associated with the <see cref="Environment.SpecialFolder"/>.</summary>
/// <param name="spFolder">The <see cref="Environment.SpecialFolder"/>.</param> /// <param name="spFolder">The <see cref="Environment.SpecialFolder"/>.</param>
/// <returns>Matching <see cref="KNOWNFOLDERID"/>.</returns> /// <returns>Matching <see cref="KNOWNFOLDERID"/>.</returns>
public static KNOWNFOLDERID KnownFolderId(this Environment.SpecialFolder spFolder) public static KNOWNFOLDERID? KnownFolderId(this Environment.SpecialFolder spFolder)
{ {
if (spFolder == Environment.SpecialFolder.Personal) return KNOWNFOLDERID.FOLDERID_Documents; if (spFolder == Environment.SpecialFolder.Personal) return KNOWNFOLDERID.FOLDERID_Documents;
if (spFolder == Environment.SpecialFolder.DesktopDirectory) return KNOWNFOLDERID.FOLDERID_Desktop; if (spFolder == Environment.SpecialFolder.DesktopDirectory) return KNOWNFOLDERID.FOLDERID_Desktop;
foreach (KNOWNFOLDERID val in Enum.GetValues(typeof(KNOWNFOLDERID)).Cast<KNOWNFOLDERID>()) foreach (KNOWNFOLDERID val in Enum.GetValues(typeof(KNOWNFOLDERID)).Cast<KNOWNFOLDERID>())
if (val.SpecialFolder() == spFolder) return val; if (val.SpecialFolder() == spFolder) return val;
throw new InvalidCastException(@"There is not a Known Folder equivalent to this SpecialFolder."); return null;
} }
/// <summary>Retrieves the name associated with a <see cref="KNOWNFOLDERID"/>.</summary> /// <summary>Retrieves the name associated with a <see cref="KNOWNFOLDERID"/>.</summary>