File size: 4,721 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 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Management.Automation;
namespace Microsoft.PowerShell.Commands
{
/// <summary>
/// A command to rename a property of an item at a specified path.
/// </summary>
[Cmdlet(VerbsCommon.Rename, "ItemProperty", DefaultParameterSetName = "Path", SupportsShouldProcess = true, SupportsTransactions = true,
HelpUri = "https://go.microsoft.com/fwlink/?LinkID=2097152")]
public class RenameItemPropertyCommand : 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 _path;
}
set
{
_path = 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 _path;
}
set
{
base.SuppressWildcardExpansion = true;
_path = value;
}
}
/// <summary>
/// The properties to be renamed on the item.
/// </summary>
[Parameter(Mandatory = true, Position = 1, ValueFromPipelineByPropertyName = true)]
[Alias("PSProperty")]
public string Name { get; set; }
/// <summary>
/// The new name of the property on the item.
/// </summary>
[Parameter(Mandatory = true, Position = 2, ValueFromPipelineByPropertyName = true)]
public string NewName { get; set; }
/// <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)
{
if (Path != null)
{
return InvokeProvider.Property.RenamePropertyDynamicParameters(Path, Name, NewName, context);
}
return InvokeProvider.Property.RenamePropertyDynamicParameters(".", Name, NewName, context);
}
#endregion Parameters
#region parameter data
/// <summary>
/// The path to rename the property on.
/// </summary>
private string _path;
#endregion parameter data
#region Command code
/// <summary>
/// Renames a property on an item.
/// </summary>
protected override void ProcessRecord()
{
try
{
CmdletProviderContext currentContext = CmdletProviderContext;
currentContext.PassThru = PassThru;
InvokeProvider.Property.Rename(_path, Name, NewName, 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
}
}
|