创建 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。 <PowerShell 示例> 目录中提供了下载的模板。 应创建此文件的副本，并使用副本创建新的 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.ProviderCapabilities 枚举中声明 ExpandWildcards、Filter、Include 或 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.RuntimeDefinedParameterDictionary 对象类似的属性和字段。 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.ProviderCapabilities 枚举中声明 ExpandWildcards、Filter、Include 或 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.RuntimeDefinedParameterDictionary 对象类似的分析属性和字段。 如果未添加动态参数，则可以返回 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.ProviderCapabilities 枚举中声明 ExpandWildcards、Filter、Include 或 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.RuntimeDefinedParameterDictionary 对象类似的分析属性和字段。 如果未添加动态参数，则可以返回 null 值。

下面是 Windows PowerShell 提供的 TemplateProvider.cs 文件中 System.Management.Automation.Provider.IPropertyCmdletProvider.ClearPropertyDynamicParameters* 的默认实现。

生成 Windows PowerShell 提供程序

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

另请参阅

Windows PowerShell 提供程序

设计 Windows PowerShell 提供程序

扩展对象类型和格式设置

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