IContentCmdletProvider.GetContentReader(String) Method

Reference

Definition

Namespace:: System.Management.Automation.Provider

Assembly:: System.Management.Automation.dll

Package:: Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0

Package:: System.Management.Automation v7.0.13

Package:: System.Management.Automation v7.1.7

Package:: System.Management.Automation v7.2.12

Package:: System.Management.Automation v7.3.5

Package:: System.Management.Automation v7.4.0

Package:: Microsoft.WSMan.Runtime v6.1.0

Package:: Microsoft.WSMan.Runtime v6.2.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets the content reader for the item at the specified path.

public:
 System::Management::Automation::Provider::IContentReader ^ GetContentReader(System::String ^ path);

public System.Management.Automation.Provider.IContentReader GetContentReader (string path);

public System.Management.Automation.Provider.IContentReader? GetContentReader (string path);

abstract member GetContentReader : string -> System.Management.Automation.Provider.IContentReader

Public Function GetContentReader (path As String) As IContentReader

Parameters

path: String

The path to the item to get the content reader for.

Returns

IContentReader

Remarks

Overrides of this method should return an IContentReader for the item specified by the path.

Providers that declare 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 return a content reader for 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.

Applies to