OutFileCommand OutFileCommand OutFileCommand OutFileCommand Class

Definition

implementation for the out-file command

public ref class OutFileCommand : Microsoft::PowerShell::Commands::Internal::Format::FrontEndCommandBase
[System.Management.Automation.Cmdlet("Out", "File", DefaultParameterSetName="ByPath", HelpUri="https://go.microsoft.com/fwlink/?LinkID=113363", SupportsShouldProcess=true)]
public class OutFileCommand : Microsoft.PowerShell.Commands.Internal.Format.FrontEndCommandBase
type OutFileCommand = class
    inherit FrontEndCommandBase
Public Class OutFileCommand
Inherits FrontEndCommandBase
Inheritance
Attributes

Constructors

OutFileCommand() OutFileCommand() OutFileCommand() OutFileCommand()

set inner command

Properties

Append Append Append Append

Property that sets append parameter.

CommandOrigin CommandOrigin CommandOrigin CommandOrigin

This property tells you if you were being invoked inside the runspace or if it was an external request.

(Inherited from InternalCommand)
CommandRuntime CommandRuntime CommandRuntime CommandRuntime

Holds the command runtime object for this command. This object controls what actually happens when a write is called.

(Inherited from Cmdlet)
CurrentPSTransaction CurrentPSTransaction CurrentPSTransaction CurrentPSTransaction

Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction

(Inherited from Cmdlet)
Encoding Encoding Encoding Encoding

Encoding optional flag

Events Events Events Events

Gets the event manager for the current runspace.

(Inherited from PSCmdlet)
FilePath FilePath FilePath FilePath

mandatory file name to write to

Force Force Force Force

Property that sets force parameter.

Host Host Host Host

Gets the host interaction APIs.

(Inherited from PSCmdlet)
InputObject InputObject InputObject InputObject

This parameter specifies the current pipeline object

(Inherited from FrontEndCommandBase)
InvokeCommand InvokeCommand InvokeCommand InvokeCommand

Provides access to utility routines for executing scripts and creating script blocks.

(Inherited from PSCmdlet)
InvokeProvider InvokeProvider InvokeProvider InvokeProvider

Gets the instance of the provider interface APIs for the current runspace.

(Inherited from PSCmdlet)
JobManager JobManager JobManager JobManager

Manager for JobSourceAdapters registered.

(Inherited from PSCmdlet)
JobRepository JobRepository JobRepository JobRepository

Repository for jobs

(Inherited from PSCmdlet)
LiteralPath LiteralPath LiteralPath LiteralPath

mandatory file name to write to

MyInvocation MyInvocation MyInvocation MyInvocation

Contains information about the identity of this cmdlet and how it was invoked.

(Inherited from PSCmdlet)
NoClobber NoClobber NoClobber NoClobber

Property that prevents file overwrite.

NoNewline NoNewline NoNewline NoNewline

False to add a newline to the end of the output string, true if not.

PagingParameters PagingParameters PagingParameters PagingParameters

If the cmdlet declares paging support (via SupportsPaging), then PagingParameters property contains arguments of the paging parameters. Otherwise PagingParameters property is null.

(Inherited from PSCmdlet)
ParameterSetName ParameterSetName ParameterSetName ParameterSetName

The name of the parameter set in effect.

(Inherited from PSCmdlet)
SessionState SessionState SessionState SessionState

Gets the instance of session state for the current runspace.

(Inherited from PSCmdlet)
Stopping Stopping Stopping Stopping

Is this command stopping?

(Inherited from Cmdlet)
Width Width Width Width

optional, number of columns to use when writing to device

Methods

BeginProcessing() BeginProcessing() BeginProcessing() BeginProcessing()

read command line parameters

CurrentProviderLocation(String) CurrentProviderLocation(String) CurrentProviderLocation(String) CurrentProviderLocation(String) Inherited from PSCmdlet
Dispose() Dispose() Dispose() Dispose()

default implementation just delegates to internal helper

(Inherited from FrontEndCommandBase)
Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Dispose(Boolean)

Dispose pattern implementation

(Inherited from FrontEndCommandBase)
EndProcessing() EndProcessing() EndProcessing() EndProcessing()

execution entry point

GetResolvedProviderPathFromPSPath(String, ProviderInfo) GetResolvedProviderPathFromPSPath(String, ProviderInfo) GetResolvedProviderPathFromPSPath(String, ProviderInfo) GetResolvedProviderPathFromPSPath(String, ProviderInfo) Inherited from PSCmdlet
GetResourceString(String, String) GetResourceString(String, String) GetResourceString(String, String) GetResourceString(String, String)

Gets the resource string corresponding to baseName and resourceId from the current assembly. You should override this if you require a different behavior.

(Inherited from Cmdlet)
GetUnresolvedProviderPathFromPSPath(String) GetUnresolvedProviderPathFromPSPath(String) GetUnresolvedProviderPathFromPSPath(String) GetUnresolvedProviderPathFromPSPath(String) Inherited from PSCmdlet
GetVariableValue(String) GetVariableValue(String) GetVariableValue(String) GetVariableValue(String) Inherited from PSCmdlet
GetVariableValue(String, Object) GetVariableValue(String, Object) GetVariableValue(String, Object) GetVariableValue(String, Object) Inherited from PSCmdlet
InputObjectCall() InputObjectCall() InputObjectCall() InputObjectCall()

callback for the implementation to get the current pipeline object

(Inherited from FrontEndCommandBase)
InternalDispose() InternalDispose() InternalDispose() InternalDispose()
Invoke() Invoke() Invoke() Invoke()

Invoke this cmdlet object returning a collection of results.

(Inherited from Cmdlet)
Invoke<T>() Invoke<T>() Invoke<T>() Invoke<T>()

Returns a strongly-typed enumerator for the results of this cmdlet.

(Inherited from Cmdlet)
OuterCmdletCall() OuterCmdletCall() OuterCmdletCall() OuterCmdletCall()

callback for the implementation to obtain a reference to the Cmdlet object

(Inherited from FrontEndCommandBase)
ProcessRecord() ProcessRecord() ProcessRecord() ProcessRecord()

execution entry point

ShouldContinue(String, String) ShouldContinue(String, String) ShouldContinue(String, String) ShouldContinue(String, String)

Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant only offers Yes/No, not YesToAll/NoToAll.

(Inherited from Cmdlet)
ShouldContinue(String, String, Boolean, Boolean) ShouldContinue(String, String, Boolean, Boolean) ShouldContinue(String, String, Boolean, Boolean) ShouldContinue(String, String, Boolean, Boolean)

Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll.

(Inherited from Cmdlet)
ShouldContinue(String, String, Boolean, Boolean, Boolean) ShouldContinue(String, String, Boolean, Boolean, Boolean) ShouldContinue(String, String, Boolean, Boolean, Boolean) ShouldContinue(String, String, Boolean, Boolean, Boolean)

Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll.

(Inherited from Cmdlet)
ShouldProcess(String) ShouldProcess(String) ShouldProcess(String) ShouldProcess(String)

Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed.

(Inherited from Cmdlet)
ShouldProcess(String, String) ShouldProcess(String, String) ShouldProcess(String, String) ShouldProcess(String, String)

Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed.

This variant allows the caller to specify text for both the target resource and the action.

(Inherited from Cmdlet)
ShouldProcess(String, String, String) ShouldProcess(String, String, String) ShouldProcess(String, String, String) ShouldProcess(String, String, String)

Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed.

This variant allows the caller to specify the complete text describing the operation, rather than just the name and action.

(Inherited from Cmdlet)
ShouldProcess(String, String, String, ShouldProcessReason) ShouldProcess(String, String, String, ShouldProcessReason) ShouldProcess(String, String, String, ShouldProcessReason) ShouldProcess(String, String, String, ShouldProcessReason)

Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed.

This variant allows the caller to specify the complete text describing the operation, rather than just the name and action.

(Inherited from Cmdlet)
StopProcessing() StopProcessing() StopProcessing() StopProcessing()

call the implementation

(Inherited from FrontEndCommandBase)
ThrowTerminatingError(ErrorRecord) ThrowTerminatingError(ErrorRecord) ThrowTerminatingError(ErrorRecord) ThrowTerminatingError(ErrorRecord)

Terminate the command and report an error

(Inherited from Cmdlet)
TransactionAvailable() TransactionAvailable() TransactionAvailable() TransactionAvailable()

Returns true if a transaction is available and active.

(Inherited from Cmdlet)
WriteCommandDetail(String) WriteCommandDetail(String) WriteCommandDetail(String) WriteCommandDetail(String)

Write text into pipeline execution log.

(Inherited from Cmdlet)
WriteDebug(String) WriteDebug(String) WriteDebug(String) WriteDebug(String)

Display debug information

(Inherited from Cmdlet)
WriteError(ErrorRecord) WriteError(ErrorRecord) WriteError(ErrorRecord) WriteError(ErrorRecord)

Internal variant: Writes the specified error to the error pipe.

(Inherited from Cmdlet)
WriteInformation(InformationRecord) WriteInformation(InformationRecord) WriteInformation(InformationRecord) WriteInformation(InformationRecord)

Route information to the user or host.

(Inherited from Cmdlet)
WriteInformation(Object, String[]) WriteInformation(Object, String[]) WriteInformation(Object, String[]) WriteInformation(Object, String[])

Route information to the user or host.

(Inherited from Cmdlet)
WriteObject(Object) WriteObject(Object) WriteObject(Object) WriteObject(Object)

Writes the object to the output pipe.

(Inherited from Cmdlet)
WriteObject(Object, Boolean) WriteObject(Object, Boolean) WriteObject(Object, Boolean) WriteObject(Object, Boolean)

Writes 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.

(Inherited from Cmdlet)
WriteObjectCall(Object) WriteObjectCall(Object) WriteObjectCall(Object) WriteObjectCall(Object)

callback for the implementation to write objects

(Inherited from FrontEndCommandBase)
WriteProgress(ProgressRecord) WriteProgress(ProgressRecord) WriteProgress(ProgressRecord) WriteProgress(ProgressRecord)

Display progress information

(Inherited from Cmdlet)
WriteVerbose(String) WriteVerbose(String) WriteVerbose(String) WriteVerbose(String)

Display verbose information

(Inherited from Cmdlet)
WriteWarning(String) WriteWarning(String) WriteWarning(String) WriteWarning(String)

Display warning information

(Inherited from Cmdlet)

Applies to