The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IPropertyCmdletProvider Interface


Updated: April 27, 2016

Applies To: Windows PowerShell

Defines the methods used to expose the properties of an item in the data store.

Namespace:   System.Management.Automation.Provider
Assembly:  System.Management.Automation (in System.Management.Automation.dll)

public interface IPropertyCmdletProvider

System_CAPS_pubmethodClearProperty(String, Collection<String>)

Clears a property from the specified item.

System_CAPS_pubmethodClearPropertyDynamicParameters(String, Collection<String>)

Returns additional parameters that are required by this implementation of the Clear-ItemProperty cmdlet.

System_CAPS_pubmethodGetProperty(String, Collection<String>)

Retrieves the properties of the specified item.

System_CAPS_pubmethodGetPropertyDynamicParameters(String, Collection<String>)

Returns any additional parameters required by this implementation of the Get-ItemProperty cmdlet.

System_CAPS_pubmethodSetProperty(String, PSObject)

Sets the properties of the specified item.

System_CAPS_pubmethodSetPropertyDynamicParameters(String, PSObject)

Returns any additional parameters that are required by this implementation of the Set-ItemProperty cmdlet.

Developers should implement this interface under the following conditions:

In this context, an "item" is an element of data within a data store. For example, the items exposed through the FileSystem provider can be files or directories. This interface provides the base operations for the other property provider interfaces.

Windows PowerShell provides a TemplateProvider.cs file that is available on the Windows SDK. To start writing your own provider make a copy of this file and use that copy to create your provider, removing any functionality that you do not need. For more information about designing a provider, see Designing Your Windows PowerShell Provider [ps].

Return to top