File size: 15,700 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 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
#nullable enable
namespace System.Management.Automation.Provider
{
#region IDynamicPropertyCmdletProvider
/// <summary>
/// An interface that can be implemented on a Cmdlet provider to expose the dynamic
/// manipulation of properties.
/// </summary>
/// <remarks>
/// An IDynamicPropertyCmdletProvider provider implements a set of methods that allows
/// the use of a set of core commands against the data store that the provider
/// gives access to. By implementing this interface users can take advantage
/// the commands that expose the creation and deletion of properties on an item.
/// rename-itemproperty
/// remove-itemproperty
/// new-itemproperty
/// etc.
/// This interface should only be implemented on derived classes of
/// <see cref="CmdletProvider"/>, <see cref="ItemCmdletProvider"/>,
/// <see cref="ContainerCmdletProvider"/>, or <see cref="NavigationCmdletProvider"/>.
///
/// A Cmdlet provider should implemented this interface if items in the
/// namespace have dynamic properties the provide wishes to expose.
/// </remarks>
public interface IDynamicPropertyCmdletProvider : IPropertyCmdletProvider
{
/// <summary>
/// Creates a new property on the specified item.
/// </summary>
/// <param name="path">
/// The path to the item on which the new property should be created.
/// </param>
/// <param name="propertyName">
/// The name of the property that should be created.
/// </param>
/// <param name="propertyTypeName">
/// The type of the property that should be created.
/// </param>
/// <param name="value">
/// The new value of the property that should be created.
/// </param>
/// <returns>
/// Nothing. The new property that was created should be passed to the WritePropertyObject method.
/// </returns>
/// <remarks>
/// Providers override this method to give the user the ability to add properties to provider objects
/// using the new-itemproperty cmdlet.
///
/// Providers that declare <see cref="System.Management.Automation.Provider.ProviderCapabilities"/>
/// of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those
/// requirements by accessing the appropriate property from the base class.
///
/// By default overrides of this method should not create new properties on objects that are generally hidden from
/// the user unless the Force property is set to true. An error should be sent to the WriteError method if
/// the path represents an item that is hidden from the user and Force is set to false.
/// </remarks>
void NewProperty(
string path,
string propertyName,
string propertyTypeName,
object? value);
/// <summary>
/// Gives the provider an opportunity to attach additional parameters to the
/// new-itemproperty cmdlet.
/// </summary>
/// <param name="path">
/// If the path was specified on the command line, this is the path
/// to the item to get the dynamic parameters for.
/// </param>
/// <param name="propertyName">
/// The name of the property that should be created.
/// </param>
/// <param name="propertyTypeName">
/// The type of the property that should be created.
/// </param>
/// <param name="value">
/// The new value of the property that should be created.
/// </param>
/// <returns>
/// Overrides of this method should return an object that has properties and fields decorated with
/// parsing attributes similar to a cmdlet class or a
/// <see cref="System.Management.Automation.RuntimeDefinedParameterDictionary"/>.
///
/// The default implementation returns null. (no additional parameters)
/// </returns>
object? NewPropertyDynamicParameters(
string path,
string propertyName,
string propertyTypeName,
object? value);
/// <summary>
/// Removes a property on the item specified by the path.
/// </summary>
/// <param name="path">
/// The path to the item on which the property should be removed.
/// </param>
/// <param name="propertyName">
/// The name of the property to be removed.
/// </param>
/// <returns>
/// Nothing.
/// </returns>
/// <remarks>
/// Providers override this method to give the user the ability to remove properties from provider objects
/// using the remove-itemproperty cmdlet.
///
/// Providers that declare <see cref="System.Management.Automation.Provider.ProviderCapabilities"/>
/// of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those
/// requirements by accessing the appropriate property from the base class.
///
/// By default overrides of this method should not remove properties on objects that are generally hidden from
/// the user unless the Force property is set to true. An error should be sent to the WriteError method if
/// the path represents an item that is hidden from the user and Force is set to false.
/// </remarks>
void RemoveProperty(
string path,
string propertyName);
/// <summary>
/// Gives the provider an opportunity to attach additional parameters to the
/// remove-itemproperty cmdlet.
/// </summary>
/// <param name="path">
/// If the path was specified on the command line, this is the path
/// to the item to get the dynamic parameters for.
/// </param>
/// <param name="propertyName">
/// The name of the property that should be removed.
/// </param>
/// <returns>
/// Overrides of this method should return an object that has properties and fields decorated with
/// parsing attributes similar to a cmdlet class or a
/// <see cref="System.Management.Automation.RuntimeDefinedParameterDictionary"/>.
///
/// The default implementation returns null. (no additional parameters)
/// </returns>
object RemovePropertyDynamicParameters(
string path,
string propertyName);
/// <summary>
/// Renames a property of the item at the specified path.
/// </summary>
/// <param name="path">
/// The path to the item on which to rename the property.
/// </param>
/// <param name="sourceProperty">
/// The property to rename.
/// </param>
/// <param name="destinationProperty">
/// The new name of the property.
/// </param>
/// <returns>
/// Nothing. The new property that was renamed should be passed to the WritePropertyObject method.
/// </returns>
/// <remarks>
/// Providers override this method to give the user the ability to rename properties of provider objects
/// using the rename-itemproperty cmdlet.
///
/// Providers that declare <see cref="System.Management.Automation.Provider.ProviderCapabilities"/>
/// of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those
/// requirements by accessing the appropriate property from the base class.
///
/// By default overrides of this method should not rename properties on objects that are generally hidden from
/// the user unless the Force property is set to true. An error should be sent to the WriteError method if
/// the path represents an item that is hidden from the user and Force is set to false.
/// </remarks>
void RenameProperty(
string path,
string sourceProperty,
string destinationProperty);
/// <summary>
/// Gives the provider an opportunity to attach additional parameters to the
/// rename-itemproperty cmdlet.
/// </summary>
/// <param name="path">
/// If the path was specified on the command line, this is the path
/// to the item to get the dynamic parameters for.
/// </param>
/// <param name="sourceProperty">
/// The property to rename.
/// </param>
/// <param name="destinationProperty">
/// The new name of the property.
/// </param>
/// <returns>
/// Overrides of this method should return an object that has properties and fields decorated with
/// parsing attributes similar to a cmdlet class or a
/// <see cref="System.Management.Automation.RuntimeDefinedParameterDictionary"/>.
///
/// The default implementation returns null. (no additional parameters)
/// </returns>
object? RenamePropertyDynamicParameters(
string path,
string sourceProperty,
string destinationProperty);
/// <summary>
/// Copies a property of the item at the specified path to a new property on the
/// destination item.
/// </summary>
/// <param name="sourcePath">
/// The path to the item on which to copy the property.
/// </param>
/// <param name="sourceProperty">
/// The name of the property to copy.
/// </param>
/// <param name="destinationPath">
/// The path to the item on which to copy the property to.
/// </param>
/// <param name="destinationProperty">
/// The destination property to copy to.
/// </param>
/// <returns>
/// Nothing. The new property that was copied to should be passed to the WritePropertyObject method.
/// </returns>
/// <remarks>
/// Providers override this method to give the user the ability to copy properties of provider objects
/// using the copy-itemproperty cmdlet.
///
/// Providers that declare <see cref="System.Management.Automation.Provider.ProviderCapabilities"/>
/// of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those
/// requirements by accessing the appropriate property from the base class.
///
/// By default overrides of this method should not copy properties from or to objects that are generally hidden from
/// the user unless the Force property is set to true. An error should be sent to the WriteError method if
/// the path represents an item that is hidden from the user and Force is set to false.
/// </remarks>
void CopyProperty(
string sourcePath,
string sourceProperty,
string destinationPath,
string destinationProperty);
/// <summary>
/// Gives the provider an opportunity to attach additional parameters to the
/// copy-itemproperty cmdlet.
/// </summary>
/// <param name="sourcePath">
/// If the path was specified on the command line, this is the path
/// to the item to get the dynamic parameters for.
/// </param>
/// <param name="sourceProperty">
/// The name of the property to copy.
/// </param>
/// <param name="destinationPath">
/// The path to the item on which to copy the property to.
/// </param>
/// <param name="destinationProperty">
/// The destination property to copy to.
/// </param>
/// <returns>
/// Overrides of this method should return an object that has properties and fields decorated with
/// parsing attributes similar to a cmdlet class or a
/// <see cref="System.Management.Automation.RuntimeDefinedParameterDictionary"/>.
///
/// The default implementation returns null. (no additional parameters)
/// </returns>
object? CopyPropertyDynamicParameters(
string sourcePath,
string sourceProperty,
string destinationPath,
string destinationProperty);
/// <summary>
/// Moves a property on an item specified by the path.
/// </summary>
/// <param name="sourcePath">
/// The path to the item on which to move the property.
/// </param>
/// <param name="sourceProperty">
/// The name of the property to move.
/// </param>
/// <param name="destinationPath">
/// The path to the item on which to move the property to.
/// </param>
/// <param name="destinationProperty">
/// The destination property to move to.
/// </param>
/// <returns>
/// Nothing. The new property that was created should be passed to the WritePropertyObject method.
/// </returns>
/// <remarks>
/// Providers override this method to give the user the ability to move properties from one provider object
/// to another using the move-itemproperty cmdlet.
///
/// Providers that declare <see cref="System.Management.Automation.Provider.ProviderCapabilities"/>
/// of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those
/// requirements by accessing the appropriate property from the base class.
///
/// By default overrides of this method should not move properties on or to objects that are generally hidden from
/// the user unless the Force property is set to true. An error should be sent to the WriteError method if
/// the path represents an item that is hidden from the user and Force is set to false.
/// </remarks>
void MoveProperty(
string sourcePath,
string sourceProperty,
string destinationPath,
string destinationProperty);
/// <summary>
/// Gives the provider an opportunity to attach additional parameters to the
/// move-itemproperty cmdlet.
/// </summary>
/// <param name="sourcePath">
/// If the path was specified on the command line, this is the path
/// to the item to get the dynamic parameters for.
/// </param>
/// <param name="sourceProperty">
/// The name of the property to copy.
/// </param>
/// <param name="destinationPath">
/// The path to the item on which to copy the property to.
/// </param>
/// <param name="destinationProperty">
/// The destination property to copy to.
/// </param>
/// <returns>
/// Overrides of this method should return an object that has properties and fields decorated with
/// parsing attributes similar to a cmdlet class or a
/// <see cref="System.Management.Automation.RuntimeDefinedParameterDictionary"/>.
///
/// The default implementation returns null. (no additional parameters)
/// </returns>
object? MovePropertyDynamicParameters(
string sourcePath,
string sourceProperty,
string destinationPath,
string destinationProperty);
}
#endregion IDynamicPropertyCmdletProvider
}
|