ScheduledJobOptionCmdletBase Members

  • Article

Represents the abstract base class for the NewScheduledJobOptionCommand and SetScheduledJobOptionCommand cmdlet wrapper classes. This SDK programming element is introduced in Windows PowerShell 3.0.

The following tables list the members exposed by the ScheduledJobOptionCmdletBase type.

Protected Constructors

  Name Description
  ScheduledJobOptionCmdletBase Initializes a new instance of the ScheduledJobOptionCmdletBase class.

Top

Protected Fields

  Name Description
protected field static OptionsParameterSet Represents the name of the Options parameter set. This field is constant.

Top

Public Properties

  Name Description
public property CommandOrigin  Gets the origin of the command. The command can be invoked within a runspace or it could be an external request (such as invoking the command from the command line). This property is introduced in Windows PowerShell 2.0. (Inherited from InternalCommand)
public property CommandRuntime  Gets and sets the command runtime object that controls what happens when the cmdlet writes an object to the pipeline. (Inherited from Cmdlet)
public property ContinueIfGoingOnBattery Gets or sets the state of the ContinueIfGoingOnBattery cmdlet parameter, which causes a scheduled job to continue running even if the computer switches to battery power. This SDK programming element is introduced in Windows PowerShell 3.0.
public property CurrentPSTransaction  Gets the latest transaction started by running the Start-Transaction cmdlet. This property is introduced in Windows PowerShell 2.0. (Inherited from Cmdlet)
public property DoNotAllowDemandStart Gets or sets the state of the DoNotAllowDemandStart cmdlet parameter, which prevents the job task from being started manually via Task Scheduler. This SDK programming element is introduced in Windows PowerShell 3.0.
public property Events  Gets the event manager for the current session where the cmdlet is running This property is introduced in Windows PowerShell 2.0. (Inherited from PSCmdlet)
public property HideInTaskScheduler Gets or sets the state of the HideInTaskScheduler cmdlet parameter, which prevents the scheduled job from being displayed in Task Scheduler. This SDK programming element is introduced in Windows PowerShell 3.0.
public property Host  Gets information about the host that is being used by the session where the cmdlet is running. (Inherited from PSCmdlet)
public property IdleDuration Gets or sets the IdleDuration cmdlet parameter value, which controls how long the computer needs to be idle before a triggered job task is started. This SDK programming element is introduced in Windows PowerShell 3.0.
public property IdleTimeout Gets or sets the IdleTimeout cmdlet parameter value, which specifies how long Task Scheduler waits for the computer to become idle after a trigger has activated before canceling a job that is scheduled to be run during computer idle time. This SDK programming element is introduced in Windows PowerShell 3.0.
public property InvokeCommand  Gets utility routines for executing scripts and creating script blocks. (Inherited from PSCmdlet)
public property InvokeProvider  Gets provider information that is used to access a data store. (Inherited from PSCmdlet)
public property JobManager  Gets or sets the job manager for the registered JobSourceAdapter objects. (Inherited from PSCmdlet)
public property JobRepository  Get the active jobs available in the current session where the cmdlet is running. This property is introduced in Windows PowerShell 2.0. (Inherited from PSCmdlet)
public property MultipleInstancePolicy Gets or sets the MultipleInstancePolicy cmdlet parameter value, which provides Task Scheduler options for multiple running instances of the job. This SDK programming element is introduced in Windows PowerShell 3.0.
public property MyInvocation  Gets invocation information about the cmdlet. (Inherited from PSCmdlet)
public property 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)
public property ParameterSetName  Gets the name of the parameter set that is used by the cmdlet. (Inherited from PSCmdlet)
public property RequireNetwork Gets or sets the state of the RequireNetwork cmdlet parameter, which allows the job task to be run only when a network connection is available. This SDK programming element is introduced in Windows PowerShell 3.0.
public property RestartOnIdleResume Gets or sets the state of the RestartOnIdleResume cmdlet parameter, which restarts a scheduled job when the computer becomes idle. This SDK programming element is introduced in Windows PowerShell 3.0.
public property RunElevated Gets or sets the state of the RunElevated cmdlet parameter, which runs the scheduled job with the permissions of a member of the Administrators group on the computer on which the job runs. This SDK programming element is introduced in Windows PowerShell 3.0.
public property SessionState  Gets information about the current state of the current session where the cmdlet is running. (Inherited from PSCmdlet)
public property StartIfIdle Gets or sets the state of the StartIfIdle cmdlet parameter, which starts a scheduled job if the computer is idle. This SDK programming element is introduced in Windows PowerShell 3.0.
public property StartIfOnBattery Gets or sets the state of the StartIfOnBattery cmdlet parameter, which starts a scheduled job even if the computer is running on battery power. This SDK programming element is introduced in Windows PowerShell 3.0.
public property StopIfGoingOffIdle Gets or sets the state of the StopIfGoingOffIdle cmdlet parameter, which suspends a job that has already been started by Task Scheduler if the computer is no longer idle. This SDK programming element is introduced in Windows PowerShell 3.0.
public property Stopping  Gets an indicator that the pipeline is stopping. The pipeline can be stopped for numerous reasons, such as when the user has entered the key combination CTRL+C, a terminating error has occurred, the hosting application requested a stop, and so on.  (Inherited from Cmdlet)
public property WakeToRun Gets or sets the state of the WakeToRun cmdlet parameter, which wakes the computer from a Hibernate or Sleep state to run the scheduled job if computer is in sleep mode when the job trigger is activated. This SDK programming element is introduced in Windows PowerShell 3.0.

Top

Public Methods

(see also Protected Methods)

  Name Description
public method CurrentProviderLocation  Returns the fully-qualified path of the current working directory for the specified provider. (Inherited from PSCmdlet)
public method Equals  (Inherited from Object)
public method GetHashCode  (Inherited from Object)
public method GetResolvedProviderPathFromPSPath  Returns the resolved provider path from a specified Windows PowerShell path. (Inherited from PSCmdlet)
public method GetResourceString  Gets a resource string that corresponds to the specified resource base key and identifier. (Inherited from Cmdlet)
public method GetType  (Inherited from Object)
public method GetUnresolvedProviderPathFromPSPath  Returns the fully-qualified provider path of a specified relative Windows PowerShell path. (Inherited from PSCmdlet)
public method GetVariableValue  Overloaded. Returns the value of a specific session-state variable. The variants of this method can return a variable value with or without a default value. (Inherited from PSCmdlet)
public method Invoke  Overloaded. Invokes a cmdlet object. The variants of this method can invoke a cmdlet that returns a collection of results or a strongly-typed enumerator. (Inherited from Cmdlet)
public method ShouldContinue  Overloaded. Requests confirmation of an operation from the user. This is typically a second query to the user. The variants of this method can send the query with or without providing yesToall or noToall options to the user. (Inherited from Cmdlet)
public method ShouldProcess  Overloaded. Requests confirmation from the user before an operation is performed. The variants of this method can be used to send the name of the resource to be changed, send the name of the resource and the operation to be performed, and more. The confirmation message that is displayed to the user is based on which variant of this method is called. (Inherited from Cmdlet)
public method ThrowTerminatingError  Reports a terminating error when the cmdlet cannot continue, or when you do not want the cmdlet to continue to process records. (Inherited from Cmdlet)
public method ToString  (Inherited from Object)
public method TransactionAvailable  Determines whether the Start-Transaction cmdlet has been called and that there is a Windows PowerShell transaction available that the cmdlet can participate in. This method is introduced in Windows PowerShell 2.0. (Inherited from Cmdlet)
public method WriteCommandDetail  Writes information to the execution log of the pipeline. (Inherited from Cmdlet)
public method WriteDebug  Writes a debug message to the host. (Inherited from Cmdlet)
public method WriteError  Reports a nonterminating error to the error pipeline when the cmdlet cannot process a record but can continue to process other records. (Inherited from Cmdlet)
public method WriteObject  Overloaded. Writes an object to the output pipeline. The variants of this method can be used to write a single object or an object that can be enumerated. (Inherited from Cmdlet)
public method WriteProgress  Writes a progress record to the host. (Inherited from Cmdlet)
public method WriteVerbose  Writes a general user-level message to the pipeline. These messages can help describe what the cmdlet is doing. (Inherited from Cmdlet)
public method WriteWarning  Writes a warning message that can be displayed. (Inherited from Cmdlet)

Top

Protected Methods

  Name Description
protected method BeginProcessing Overridden. Begins processing of the specified options.
protected method EndProcessing  Provides a one-time, post-processing functionality for the cmdlet. (Inherited from Cmdlet)
protected method Finalize  (Inherited from Object)
protected method MemberwiseClone  (Inherited from Object)
protected method ProcessRecord  Provides a record-by-record processing functionality for the cmdlet. (Inherited from Cmdlet)
protected method StopProcessing  Stops processing records when the user stops the cmdlet asynchronously. (Inherited from Cmdlet)

Top

See Also

Reference

ScheduledJobOptionCmdletBase Class
Microsoft.PowerShell.ScheduledJob Namespace