创建 Windows PowerShell 属性提供程序

本主题描述如何创建使用户能够操作数据存储中项目的属性的提供程序。因此，这种类型的提供程序称为 Windows PowerShell 属性提供程序。例如，Windows PowerShell 提供的注册表提供程序将注册表项值作为注册表项的属性进行处理。这种类型的提供程序必须将 System.Management.Automation.Provider.Ipropertycmdletprovider 接口添加到 .NET 类的实现中。

笔记

Windows PowerShell 提供了一个模板文件，可用于开发 Windows PowerShell 提供程序。 TemplateProvider.cs 文件可在适用于 Windows Vista 和 .NET Framework 3.0 运行时组件的 Microsoft Windows 软件开发工具包中找到。有关下载说明，请参阅如何安装 Windows PowerShell 和下载 Windows PowerShell SDK。下载的模板位于 目录中。您应该制作此文件的副本，并使用该副本创建新的 Windows PowerShell 提供程序，删除不需要的任何功能。有关其他 Windows PowerShell 提供程序实现的详细信息，请参阅设计 Windows PowerShell 提供程序。

警告

属性提供程序的方法应使用 System.Management.Automation.Provider.Cmdletprovider.Writepropertyobject* 方法写入任何对象。

定义 Windows PowerShell 提供程序

属性提供程序必须创建支持 System.Management.Automation.Provider.Ipropertycmdletprovider 接口的 .NET 类。以下是 Windows PowerShell 提供的 TemplateProvider.cs 文件中的默认类声明。

定义基本功能

System.Management.Automation.Provider.Ipropertycmdletprovider 接口可以附加到任何提供程序基类，但 System.Management.Automation.Provider.Drivecmdletprovider 类除外。添加您正在使用的基类所需的基本功能。有关基类的详细信息，请参阅设计 Windows PowerShell 提供程序。

检索属性

要检索属性，提供程序必须实现 System.Management.Automation.Provider.Ipropertycmdletprovider.Getproperty* 方法以支持来自 Get-ItemProperty cmdlet 的调用。此方法检索位于指定的提供程序内部路径（完全限定）的项目的属性。

providerSpecificPickList 参数指示要检索的属性。如果此参数为 null 或为空，则该方法应检索所有属性。此外，System.Management.Automation.Provider.Ipropertycmdletprovider.Getproperty* 写入 System.Management.Automation.PSObject 对象的实例，该对象表示所检索属性的属性包。该方法不应返回任何内容。

建议 System.Management.Automation.Provider.Ipropertycmdletprovider.Getproperty* 的实现支持选择列表中每个元素的属性名称的通配符扩展。为此，请使用 System.Management.Automation.Wildcardpattern 类来执行通配符模式匹配。

以下是 Windows PowerShell 提供的 TemplateProvider.cs 文件中 System.Management.Automation.Provider.Ipropertycmdletprovider.Getproperty* 的默认实现。

关于实现 GetProperty 需要记住的事情

以下条件可能适用于 System.Management.Automation.Provider.Ipropertycmdletprovider.Getproperty* 的实现：

• 定义提供程序类时，Windows PowerShell 属性提供程序可能会从 System.Management.Automation.Provider.Providercapability 枚举中声明 ExpandWildcards、Filter、Inclusion 或 Exclude 提供程序功能。在这些情况下，System.Management.Automation.Provider.Ipropertycmdletprovider.Getproperty* 方法的实现需要确保传递给该方法的路径满足指定功能的要求。为此，该方法应访问适当的属性，例如 System.Management.Automation.Provider.Cmdletprovider.Exclude* 和 System.Management.Automation.Provider.Cmdletprovider.Include* 属性。

• 默认情况下，除非 System.Management.Automation.Provider.Cmdletprovider.Force* 属性设置为 true，否则此方法的重写不应检索对用户隐藏的对象的读取器。如果路径表示对用户隐藏的项目并且 System.Management.Automation.Provider.Cmdletprovider.Force* 设置为 false，则应写入错误。

将动态参数附加到 Get-ItemProperty Cmdlet

Get-ItemProperty cmdlet 可能需要在运行时动态指定的其他参数。要提供这些动态参数，Windows PowerShell 属性提供程序必须实现 System.Management.Automation.Provider.Ipropertycmdletprovider.Getpropertydynamicparameters* 方法。 path 参数指示完全限定的提供程序内部路径，而 providerSpecificPickList 参数指定在命令行中输入的提供程序特定属性。如果属性通过管道传输到 cmdlet，则此参数可能为 null 或为空。在这种情况下，此方法返回一个对象，该对象具有与 cmdlet 类或 System.Management.Automation.Runtimedefineparameterdictionary 对象类似的解析属性的属性和字段。 Windows PowerShell 运行时使用返回的对象将参数添加到 cmdlet。

以下是 Windows PowerShell 提供的 TemplateProvider.cs 文件中 System.Management.Automation.Provider.Ipropertycmdletprovider.Getpropertydynamicparameters* 的默认实现。

设置属性

要设置属性，Windows PowerShell 属性提供程序必须实现 System.Management.Automation.Provider.Ipropertycmdletprovider.Setproperty* 方法以支持来自 Set-ItemProperty cmdlet 的调用。此方法在指定路径设置项目的一个或多个属性，并根据需要覆盖提供的属性。 System.Management.Automation.Provider.Ipropertycmdletprovider.Setproperty* 还会写入 System.Management.Automation.PSObject 对象的实例，该对象表示更新属性的属性包。

以下是 Windows PowerShell 提供的 TemplateProvider.cs 文件中 System.Management.Automation.Provider.Ipropertycmdletprovider.Setproperty* 的默认实现。

关于实现 Set-ItemProperty 需要记住的事情

以下条件可能适用于 System.Management.Automation.Provider.Ipropertycmdletprovider.Setproperty* 的实现：

• 定义提供程序类时，Windows PowerShell 属性提供程序可能会从 System.Management.Automation.Provider.Providercapability 枚举中声明 ExpandWildcards、Filter、Inclusion 或 Exclude 提供程序功能。在这些情况下，System.Management.Automation.Provider.Ipropertycmdletprovider.Setproperty* 方法的实现必须确保传递给该方法的路径满足指定功能的要求。为此，该方法应访问适当的属性，例如 System.Management.Automation.Provider.Cmdletprovider.Exclude* 和 System.Management.Automation.Provider.Cmdletprovider.Include* 属性。

• 默认情况下，除非 System.Management.Automation.Provider.Cmdletprovider.Force* 属性设置为 true，否则此方法的重写不应检索对用户隐藏的对象的读取器。如果路径表示对用户隐藏的项目并且 System.Management.Automation.Provider.Cmdletprovider.Force* 设置为 false，则应写入错误。

• System.Management.Automation.Provider.Ipropertycmdletprovider.Setproperty* 方法的实现应调用 System.Management.Automation.Provider.Cmdletprovider.ShouldProcess 并在对数据存储进行任何更改之前验证其返回值。该方法用于在系统状态发生更改（例如重命名文件）时确认操作的执行。 System.Management.Automation.Provider.Cmdletprovider.ShouldProcess 将要更改的资源名称发送给用户，并使用 Windows PowerShell 运行时并处理任何命令行设置或首选项变量来确定应显示的内容。

  调用 System.Management.Automation.Provider.Cmdletprovider.ShouldProcess 返回 true 后，如果可能进行潜在危险的系统修改，则应调用 System.Management.Automation.Provider.Ipropertycmdletprovider.Setproperty* 方法System.Management.Automation.Provider.Cmdletprovider.ShouldContinue 方法。此方法向用户发送确认消息，以允许附加反馈来指示操作应继续。

为 Set-ItemProperty Cmdlet 附加动态参数

Set-ItemProperty cmdlet 可能需要在运行时动态指定的其他参数。要提供这些动态参数，Windows PowerShell 属性提供程序必须实现 System.Management.Automation.Provider.Ipropertycmdletprovider.Setpropertydynamicparameters* 方法。此方法返回一个对象，该对象具有与 cmdlet 类或 System.Management.Automation.Runtimedefineparameterdictionary 对象类似的解析属性的属性和字段。如果不添加动态参数，则可以返回null值。

以下是 Windows PowerShell 提供的 TemplateProvider.cs 文件中 System.Management.Automation.Provider.Ipropertycmdletprovider.Getpropertydynamicparameters* 的默认实现。

清算财产

要清除属性，Windows PowerShell 属性提供程序必须实现 System.Management.Automation.Provider.Ipropertycmdletprovider.Clearproperty* 方法以支持来自 Clear-ItemProperty cmdlet 的调用。此方法为位于指定路径的项目设置一个或多个属性。

以下是 Windows PowerShell 提供的 TemplateProvider.cs 文件中 System.Management.Automation.Provider.Ipropertycmdletprovider.Clearproperty* 的默认实现。

关于实施 ClearProperty 需要记住的事情

以下条件可能适用于 System.Management.Automation.Provider.Ipropertycmdletprovider.Clearproperty* 的实现：

• 定义提供程序类时，Windows PowerShell 属性提供程序可能会从 System.Management.Automation.Provider.Providercapability 枚举中声明 ExpandWildcards、Filter、Inclusion 或 Exclude 提供程序功能。在这些情况下，System.Management.Automation.Provider.Ipropertycmdletprovider.Clearproperty* 方法的实现需要确保传递给该方法的路径满足指定功能的要求。为此，该方法应访问适当的属性，例如 System.Management.Automation.Provider.Cmdletprovider.Exclude* 和 System.Management.Automation.Provider.Cmdletprovider.Include* 属性。

• 默认情况下，除非 System.Management.Automation.Provider.Cmdletprovider.Force* 属性设置为 true，否则此方法的重写不应检索对用户隐藏的对象的读取器。如果路径表示对用户隐藏的项目并且 System.Management.Automation.Provider.Cmdletprovider.Force* 设置为 false，则应写入错误。

• System.Management.Automation.Provider.Ipropertycmdletprovider.Clearproperty* 方法的实现应调用 System.Management.Automation.Provider.Cmdletprovider.ShouldProcess 并在对数据存储进行任何更改之前验证其返回值。此方法用于在系统状态发生更改（例如清除内容）之前确认操作的执行。 System.Management.Automation.Provider.Cmdletprovider.ShouldProcess 将要更改的资源名称发送给用户，Windows PowerShell 运行时会考虑任何命令行设置或首选项变量来确定应显示的内容。

  调用 System.Management.Automation.Provider.Cmdletprovider.ShouldProcess 返回 true 后，如果可能进行潜在危险的系统修改，则应调用 System.Management.Automation.Provider.Ipropertycmdletprovider.Clearproperty* 方法System.Management.Automation.Provider.Cmdletprovider.ShouldContinue 方法。此方法向用户发送确认消息，以允许附加反馈来指示应继续进行潜在危险的操作。

将动态参数附加到 Clear-ItemProperty Cmdlet

Clear-ItemProperty cmdlet 可能需要在运行时动态指定的其他参数。要提供这些动态参数，Windows PowerShell 属性提供程序必须实现 System.Management.Automation.Provider.Ipropertycmdletprovider.Clearpropertydynamicparameters* 方法。此方法返回一个对象，该对象具有与 cmdlet 类或 System.Management.Automation.Runtimedefineparameterdictionary 对象类似的解析属性的属性和字段。如果不添加动态参数，则可以返回null值。

以下是 Windows PowerShell 提供的 TemplateProvider.cs 文件中 System.Management.Automation.Provider.Ipropertycmdletprovider.Clearpropertydynamicparameters* 的默认实现。

构建 Windows PowerShell 提供程序

请参阅如何注册 Cmdlet、提供程序和主机应用程序。

参见

Windows PowerShell 提供程序

设计您的 Windows PowerShell 提供程序

扩展对象类型和格式

如何注册 Cmdlet、提供程序和主机应用程序