File size: 5,386 Bytes
8c763fb | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Collections.ObjectModel;
using System.Management.Automation;
namespace Microsoft.PowerShell.Commands
{
/// <summary>
/// A command to clear the value of a property of an item at a specified path.
/// </summary>
[Cmdlet(VerbsCommon.Clear, "ItemProperty", DefaultParameterSetName = "Path", SupportsShouldProcess = true, SupportsTransactions = true,
HelpUri = "https://go.microsoft.com/fwlink/?LinkID=2096903")]
public class ClearItemPropertyCommand : PassThroughItemPropertyCommandBase
{
#region Parameters
/// <summary>
/// Gets or sets the path parameter to the command.
/// </summary>
[Parameter(Position = 0, ParameterSetName = "Path",
Mandatory = true, ValueFromPipeline = true, ValueFromPipelineByPropertyName = true)]
public string[] Path
{
get
{
return paths;
}
set
{
paths = value;
}
}
/// <summary>
/// Gets or sets the literal path parameter to the command.
/// </summary>
[Parameter(ParameterSetName = "LiteralPath",
Mandatory = true, ValueFromPipeline = false, ValueFromPipelineByPropertyName = true)]
[Alias("PSPath", "LP")]
public string[] LiteralPath
{
get
{
return paths;
}
set
{
base.SuppressWildcardExpansion = true;
paths = value;
}
}
/// <summary>
/// The properties to clear from the item.
/// </summary>
[Parameter(Position = 1, Mandatory = true, ValueFromPipelineByPropertyName = true)]
public string Name
{
get
{
return _property;
}
set
{
_property = value;
}
}
/// <summary>
/// A virtual method for retrieving the dynamic parameters for a cmdlet. Derived cmdlets
/// that require dynamic parameters should override this method and return the
/// dynamic parameter object.
/// </summary>
/// <param name="context">
/// The context under which the command is running.
/// </param>
/// <returns>
/// An object representing the dynamic parameters for the cmdlet or null if there
/// are none.
/// </returns>
internal override object GetDynamicParameters(CmdletProviderContext context)
{
Collection<string> propertyCollection = new();
propertyCollection.Add(_property);
if (Path != null && Path.Length > 0)
{
// Go ahead and let any exception terminate the pipeline.
return InvokeProvider.Property.ClearPropertyDynamicParameters(
Path[0],
propertyCollection,
context);
}
return InvokeProvider.Property.ClearPropertyDynamicParameters(
".",
propertyCollection,
context);
}
#endregion Parameters
#region parameter data
/// <summary>
/// The properties to be cleared.
/// </summary>
private string _property;
#endregion parameter data
#region Command code
/// <summary>
/// Clears the properties of an item at the specified path.
/// </summary>
protected override void ProcessRecord()
{
CmdletProviderContext currentContext = CmdletProviderContext;
currentContext.PassThru = PassThru;
Collection<string> propertyCollection = new();
propertyCollection.Add(_property);
foreach (string path in Path)
{
try
{
InvokeProvider.Property.Clear(
path,
propertyCollection,
currentContext);
}
catch (PSNotSupportedException notSupported)
{
WriteError(
new ErrorRecord(
notSupported.ErrorRecord,
notSupported));
}
catch (DriveNotFoundException driveNotFound)
{
WriteError(
new ErrorRecord(
driveNotFound.ErrorRecord,
driveNotFound));
}
catch (ProviderNotFoundException providerNotFound)
{
WriteError(
new ErrorRecord(
providerNotFound.ErrorRecord,
providerNotFound));
}
catch (ItemNotFoundException pathNotFound)
{
WriteError(
new ErrorRecord(
pathNotFound.ErrorRecord,
pathNotFound));
}
}
}
#endregion Command code
}
}
|