ICommandRuntime.WriteObject Method

  • Reference

Definition

Namespace:
System.Management.Automation
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

Overloads

WriteObject(Object)

Called to write objects to the output pipe.
WriteObject(Object, Boolean)

Called to write one or more objects to the output pipe. If the object is a collection and the enumerateCollection flag is true, the objects in the collection will be written individually.

WriteObject(Object)

Called to write objects to the output pipe.

public:
 void WriteObject(System::Object ^ sendToPipeline);
public:
 void WriteObject(Platform::Object ^ sendToPipeline);
void WriteObject(winrt::Windows::Foundation::IInspectable const & sendToPipeline);
public void WriteObject (object sendToPipeline);
public void WriteObject (object? sendToPipeline);
abstract member WriteObject : obj -> unit
Public Sub WriteObject (sendToPipeline As Object)

Parameters

sendToPipeline
Object

The object that needs to be written. This will be written as a single object, even if it is an enumeration.

Remarks

When the cmdlet wants to write a single object out, it will call this API. It is up to the implementation to decide what to do with these objects.

Applies to

WriteObject(Object, Boolean)

Called to write one or more objects to the output pipe. If the object is a collection and the enumerateCollection flag is true, the objects in the collection will be written individually.

public:
 void WriteObject(System::Object ^ sendToPipeline, bool enumerateCollection);
public:
 void WriteObject(Platform::Object ^ sendToPipeline, bool enumerateCollection);
void WriteObject(winrt::Windows::Foundation::IInspectable const & sendToPipeline, bool enumerateCollection);
public void WriteObject (object sendToPipeline, bool enumerateCollection);
public void WriteObject (object? sendToPipeline, bool enumerateCollection);
abstract member WriteObject : obj * bool -> unit
Public Sub WriteObject (sendToPipeline As Object, enumerateCollection As Boolean)

Parameters

sendToPipeline
Object

The object that needs to be written to the pipeline.

enumerateCollection
Boolean

true if the collection should be enumerated

Remarks

When the cmdlet wants to write multiple objects out, it will call this API. It is up to the implementation to decide what to do with these objects.

Applies to