RegisterObjectEventCommand Class

Definition

Namespace:

Microsoft.PowerShell.Commands

Assembly:

Microsoft.PowerShell.Commands.Utility.dll

Package:

Microsoft.PowerShell.Commands.Utility v7.4.0

Registers for an event on an object.

public ref class RegisterObjectEventCommand : Microsoft::PowerShell::Commands::ObjectEventRegistrationBase

[System.Management.Automation.Cmdlet("Register", "ObjectEvent", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096714")]
[System.Management.Automation.OutputType(typeof(System.Management.Automation.PSEventJob))]
public class RegisterObjectEventCommand : Microsoft.PowerShell.Commands.ObjectEventRegistrationBase

[<System.Management.Automation.Cmdlet("Register", "ObjectEvent", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096714")>]
[<System.Management.Automation.OutputType(typeof(System.Management.Automation.PSEventJob))>]
type RegisterObjectEventCommand = class
    inherit ObjectEventRegistrationBase

Public Class RegisterObjectEventCommand
Inherits ObjectEventRegistrationBase

Inheritance

Object

InternalCommand

Cmdlet

PSCmdlet

ObjectEventRegistrationBase

RegisterObjectEventCommand

Attributes

CmdletAttribute OutputTypeAttribute

Constructors

RegisterObjectEventCommand()

Properties

Action	Parameter for any action to be invoked when the event arrives. (Inherited from ObjectEventRegistrationBase)
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)
EventName	The event name to subscribe.
Events	Gets the event manager for the current runspace. (Inherited from PSCmdlet)
Forward	Parameter for the flag that determines whether this subscription will forward its events to the PowerShell client during remote executions. (Inherited from ObjectEventRegistrationBase)
Host	Gets the host interaction APIs. (Inherited from PSCmdlet)
InputObject	The object on which to subscribe.
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)
MaxTriggerCount	Parameter to indicate that the subscriber should be auto-unregistered after being triggered for specified times. If the value is equal or less than zero, there is no limit on the number of times the event can be triggered without being unregistered. (Inherited from ObjectEventRegistrationBase)
MessageData	Parameter for additional data to be associated with this event subscription. (Inherited from ObjectEventRegistrationBase)
MyInvocation	Contains information about the identity of this cmdlet and how it was invoked. (Inherited from PSCmdlet)
NewSubscriber	Gets the subscriber generated by this command. (Inherited from ObjectEventRegistrationBase)
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)
SessionState	Gets the instance of session state for the current runspace. (Inherited from PSCmdlet)
SourceIdentifier	Parameter for an identifier for this event subscription. (Inherited from ObjectEventRegistrationBase)
Stopping	Is this command stopping? (Inherited from Cmdlet)
SupportEvent	Parameter for the flag that determines if this subscription is used to support other subscriptions. (Inherited from ObjectEventRegistrationBase)

Methods

BeginProcessing()	Check arguments. (Inherited from ObjectEventRegistrationBase)
CurrentProviderLocation(String)	(Inherited from PSCmdlet)
EndProcessing()	Subscribe to the event on the object. (Inherited from ObjectEventRegistrationBase)
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)
GetSourceObject()	Returns the object that generates events to be monitored.
GetSourceObjectEventName()	Returns the event name to be monitored on the input object.
GetUnresolvedProviderPathFromPSPath(String)	(Inherited from PSCmdlet)
GetVariableValue(String, Object)	(Inherited from PSCmdlet)
GetVariableValue(String)	(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()	When overridden in the derived class, performs execution of the command. (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)
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)	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)
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)
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)	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)	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)
StopProcessing()	When overridden in the derived class, interrupts currently running code within the command. It should interrupt BeginProcessing, ProcessRecord, and EndProcessing. Default implementation in the base class just returns. (Inherited from Cmdlet)
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, 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)
WriteObject(Object)	Writes the object to the output pipe. (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)