TraceCommandCommand Class

Definition

A cmdlet that traces the specified categories and flags for the duration of the specified expression.

public ref class TraceCommandCommand : Microsoft::PowerShell::Commands::TraceListenerCommandBase, IDisposable
public class TraceCommandCommand : Microsoft.PowerShell.Commands.TraceListenerCommandBase, IDisposable
[System.Management.Automation.Cmdlet("Trace", "Command", DefaultParameterSetName="expressionSet", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2097136")]
public class TraceCommandCommand : Microsoft.PowerShell.Commands.TraceListenerCommandBase, IDisposable
[System.Management.Automation.Cmdlet("Trace", "Command", DefaultParameterSetName="expressionSet", HelpUri="https://go.microsoft.com/fwlink/?LinkID=113419")]
public class TraceCommandCommand : Microsoft.PowerShell.Commands.TraceListenerCommandBase, IDisposable
type TraceCommandCommand = class
    inherit TraceListenerCommandBase
    interface IDisposable
[<System.Management.Automation.Cmdlet("Trace", "Command", DefaultParameterSetName="expressionSet", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2097136")>]
type TraceCommandCommand = class
    inherit TraceListenerCommandBase
    interface IDisposable
[<System.Management.Automation.Cmdlet("Trace", "Command", DefaultParameterSetName="expressionSet", HelpUri="https://go.microsoft.com/fwlink/?LinkID=113419")>]
type TraceCommandCommand = class
    inherit TraceListenerCommandBase
    interface IDisposable
Public Class TraceCommandCommand
Inherits TraceListenerCommandBase
Implements IDisposable
Inheritance
Attributes
Implements

Constructors

TraceCommandCommand()

Properties

ArgumentList

When set, this parameter is the arguments to pass to the command specified by the -Command parameter.

Command

The parameter for the expression that should be traced.

CommandOrigin

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

(Inherited from InternalCommand)
CommandRuntime

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

(Inherited from Cmdlet)
CurrentPSTransaction

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

(Inherited from Cmdlet)
Debugger

If this parameter is specified the Debugger trace listener will be added.

Events

Gets the event manager for the current runspace.

(Inherited from PSCmdlet)
Expression

The parameter for the expression that should be traced.

FilePath

Adds the file trace listener using the specified file.

Force

Force parameter to control read-only files.

ForceWrite

Property that sets force parameter. This will clear the read-only attribute on an existing file if present.

(Inherited from TraceListenerCommandBase)
Host

Gets the host interaction APIs.

(Inherited from PSCmdlet)
InputObject

This parameter specifies the current pipeline object.

InvokeCommand

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

(Inherited from PSCmdlet)
InvokeProvider

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

(Inherited from PSCmdlet)
JobManager

Manager for JobSourceAdapters registered.

(Inherited from PSCmdlet)
JobRepository

Repository for jobs.

(Inherited from PSCmdlet)
ListenerOption

The parameter which determines the options for output from the trace listeners.

MyInvocation

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

(Inherited from PSCmdlet)
Name

The TraceSource parameter determines which TraceSource categories the operation will take place on.

Option

The flags to be set on the TraceSource.

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

The name of the parameter set in effect.

(Inherited from PSCmdlet)
PSHost

If this parameter is specified the Msh Host trace listener will be added.

SessionState

Gets the instance of session state for the current runspace.

(Inherited from PSCmdlet)
Stopping

Is this command stopping?

(Inherited from Cmdlet)

Methods

BeginProcessing()

Gets the PSTraceSource instances that match the names specified.

ClearStoredState()

Clears the store TraceSource state.

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

Resets the TraceSource flags back to their original value and restores the original TraceListeners.

EndProcessing()

Finishes running the command if specified and then sets the tracing options and listeners back to their original values.

GetResolvedProviderPathFromPSPath(String, ProviderInfo) (Inherited from PSCmdlet)
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) (Inherited from PSCmdlet)
GetVariableValue(String) (Inherited from PSCmdlet)
GetVariableValue(String, Object) (Inherited from PSCmdlet)
Invoke()

Invoke this cmdlet object returning a collection of results.

(Inherited from Cmdlet)
Invoke<T>()

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

(Inherited from Cmdlet)
ProcessRecord()

Executes the expression. Note, this was taken from apply-expression.

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)

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)

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)

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)

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)

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)

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()

Ensures that the sub-pipeline we created gets stopped as well.

ThrowTerminatingError(ErrorRecord)

Terminate the command and report an error.

(Inherited from Cmdlet)
TransactionAvailable()

Returns true if a transaction is available and active.

(Inherited from Cmdlet)
WriteCommandDetail(String)

Write text into pipeline execution log.

(Inherited from Cmdlet)
WriteDebug(String)

Display debug information.

(Inherited from Cmdlet)
WriteError(ErrorRecord)

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

(Inherited from Cmdlet)
WriteInformation(InformationRecord)

Route information to the user or host.

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

Route information to the user or host.

(Inherited from Cmdlet)
WriteObject(Object)

Writes the object to the output pipe.

(Inherited from Cmdlet)
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)
WriteProgress(ProgressRecord)

Display progress information.

(Inherited from Cmdlet)
WriteVerbose(String)

Display verbose information.

(Inherited from Cmdlet)
WriteWarning(String)

Display warning information.

(Inherited from Cmdlet)

Applies to