Skip to content

Commit 308fb4e

Browse files
author
David Hall
committed
Updated help files
1 parent 22e0840 commit 308fb4e

File tree

1,211 files changed

+2649
-1912
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,211 files changed

+2649
-1912
lines changed

‎docs/Microsoft.Win32.TaskScheduler.xml

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1679,6 +1679,15 @@
16791679
</summary>
16801680
<returns>String representation of this action.</returns>
16811681
</member>
1682+
<member name="T:Microsoft.Win32.TaskScheduler.SnapshotItem">
1683+
<summary>Abstract class representing a secured item for storage in a <see cref="T:Microsoft.Win32.TaskScheduler.TaskSchedulerSnapshot" />.</summary>
1684+
</member>
1685+
<member name="P:Microsoft.Win32.TaskScheduler.SnapshotItem.Path">
1686+
<summary>Gets the path to the item.</summary>
1687+
</member>
1688+
<member name="P:Microsoft.Win32.TaskScheduler.SnapshotItem.Sddl">
1689+
<summary>Gets the SDDL for the item.</summary>
1690+
</member>
16821691
<member name="T:Microsoft.Win32.TaskScheduler.StandardTaskEventId">
16831692
<summary>
16841693
Changes to tasks and the engine that cause events.
@@ -3275,6 +3284,9 @@
32753284
true if <paramref name="item" /> was successfully removed from the <see cref="T:System.Collections.Generic.ICollection`1" />; otherwise, false. This method also returns false if <paramref name="item" /> is not found in the original <see cref="T:System.Collections.Generic.ICollection`1" />.
32763285
</returns>
32773286
</member>
3287+
<member name="T:Microsoft.Win32.TaskScheduler.TaskFolderSnapshot">
3288+
<summary>Represents a <see cref="T:Microsoft.Win32.TaskScheduler.TaskFolder" /> instance and captures its name and security.</summary>
3289+
</member>
32783290
<member name="T:Microsoft.Win32.TaskScheduler.TaskInstancesPolicy">
32793291
<summary>Defines how the Task Scheduler handles existing instances of the task when it starts a new instance of the task.</summary>
32803292
</member>
@@ -3756,6 +3768,112 @@
37563768
<member name="F:Microsoft.Win32.TaskScheduler.TaskRunLevel.Highest">
37573769
<summary>Tasks will be run with the highest privileges.</summary>
37583770
</member>
3771+
<member name="T:Microsoft.Win32.TaskScheduler.TaskSchedulerSnapshot">
3772+
<summary>
3773+
Represents all the information about the tasks and folders from a <see cref="T:Microsoft.Win32.TaskScheduler.TaskService" /> instance that can be used to reconstitute tasks and folders
3774+
on the same or different systems. <note>This class and related classes are only available under the .NET 4.5.2 build and later .NET versions due to
3775+
dependencies on threading and compressed (zip) files.</note></summary>
3776+
</member>
3777+
<member name="M:Microsoft.Win32.TaskScheduler.TaskSchedulerSnapshot.#ctor(System.String)">
3778+
<summary>Creates a new instance of <see cref="T:Microsoft.Win32.TaskScheduler.TaskSchedulerSnapshot" /> from an existing snapshot.</summary>
3779+
<param name="path">The zip file snapshot created by the <see cref="M:Microsoft.Win32.TaskScheduler.TaskSchedulerSnapshot.Create(Microsoft.Win32.TaskScheduler.TaskService,System.String)" /> method.</param>
3780+
</member>
3781+
<member name="M:Microsoft.Win32.TaskScheduler.TaskSchedulerSnapshot.Create(Microsoft.Win32.TaskScheduler.TaskService,System.String)">
3782+
<summary>
3783+
Creates a compressed zip file that contains all the information accessible to the user from the <see cref="T:Microsoft.Win32.TaskScheduler.TaskService" /> instance necessary to
3784+
reconstitute its tasks and folders. <note>This method can take many seconds to execute. It is recommended to call the asynchronous
3785+
version.</note><note type="warning">This method will execute without error even if the user does not have permissions to see all tasks and folders.
3786+
It is imperative that the developer ensures that the user has Administrator or equivalent rights before calling this method.</note></summary>
3787+
<param name="ts">The <see cref="T:Microsoft.Win32.TaskScheduler.TaskService" /> from which to pull the tasks and folders.</param>
3788+
<param name="path">The output zip file in which to place the snapshot information.</param>
3789+
<returns>A <see cref="T:Microsoft.Win32.TaskScheduler.TaskSchedulerSnapshot" /> instance with the contents of the specified Task Scheduler connection.</returns>
3790+
</member>
3791+
<member name="M:Microsoft.Win32.TaskScheduler.TaskSchedulerSnapshot.Create(Microsoft.Win32.TaskScheduler.TaskService,System.String,System.Threading.CancellationToken,System.IProgress{System.Tuple{System.Int32,System.String}})">
3792+
<summary>
3793+
Creates a compressed zip file that contains all the information accessible to the user from the <see cref="T:Microsoft.Win32.TaskScheduler.TaskService" /> instance necessary to
3794+
reconstitute its tasks and folders. <note type="warning">This method will execute without error even if the user does not have permissions to see all
3795+
tasks and folders. It is imperative that the developer ensures that the user has Administrator or equivalent rights before calling this method.</note></summary>
3796+
<param name="ts">The <see cref="T:Microsoft.Win32.TaskScheduler.TaskService" /> from which to pull the tasks and folders.</param>
3797+
<param name="path">The output zip file in which to place the snapshot information.</param>
3798+
<param name="cancelToken">A cancellation token to use to cancel this asynchronous operation.</param>
3799+
<param name="progress">An optional <see cref="T:System.IProgress`1" /> instance to use to report progress of the asynchronous operation.</param>
3800+
<returns>An asynchronous <see cref="T:Microsoft.Win32.TaskScheduler.TaskSchedulerSnapshot" /> instance with the contents of the specified Task Scheduler connection.</returns>
3801+
</member>
3802+
<member name="P:Microsoft.Win32.TaskScheduler.TaskSchedulerSnapshot.Items">
3803+
<summary>
3804+
Gets a list of <see cref="T:Microsoft.Win32.TaskScheduler.TaskSnapshot" /> and <see cref="T:Microsoft.Win32.TaskScheduler.TaskFolderSnapshot" /> instances the represent the tasks and folders from a Task Scheduler instance.
3805+
</summary>
3806+
</member>
3807+
<member name="M:Microsoft.Win32.TaskScheduler.TaskSchedulerSnapshot.Open(System.String)">
3808+
<summary>Opens an existing snapshot and returns a new instance of <see cref="T:Microsoft.Win32.TaskScheduler.TaskSchedulerSnapshot" />.</summary>
3809+
<param name="path">The zip file snapshot created by the <see cref="M:Microsoft.Win32.TaskScheduler.TaskSchedulerSnapshot.Create(Microsoft.Win32.TaskScheduler.TaskService,System.String)" /> method.</param>
3810+
<returns>A <see cref="T:Microsoft.Win32.TaskScheduler.TaskSchedulerSnapshot" /> instance with the contents of the specified snapshot file.</returns>
3811+
</member>
3812+
<member name="P:Microsoft.Win32.TaskScheduler.TaskSchedulerSnapshot.Path">
3813+
<summary>Gets the path of the file based snapshot.</summary>
3814+
</member>
3815+
<member name="M:Microsoft.Win32.TaskScheduler.TaskSchedulerSnapshot.Restore(Microsoft.Win32.TaskScheduler.TaskService,System.Collections.Generic.ICollection{Microsoft.Win32.TaskScheduler.SnapshotItem},System.Boolean,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.String})">
3816+
<summary>Register a list of snapshot items (tasks and folders) into the specified Task Scheduler.</summary>
3817+
<param name="ts">The <see cref="T:Microsoft.Win32.TaskScheduler.TaskService" /> into which the tasks and folders are registered.</param>
3818+
<param name="items">
3819+
The list of <see cref="T:Microsoft.Win32.TaskScheduler.SnapshotItem" /> instances representing the tasks and folders from this snapshot that should be registered on the
3820+
<see cref="T:Microsoft.Win32.TaskScheduler.TaskService" /> instance.
3821+
</param>
3822+
<param name="applyAccessRights">
3823+
If <c>true</c>, takes the access rights from the snapshot item and applies it to both new and existing tasks and folders.
3824+
</param>
3825+
<param name="overwriteExisting">
3826+
If <c>true</c>, overwrite any existing tasks and folders found in the target Task Scheduler that match the path of the snapshot item.
3827+
</param>
3828+
<param name="passwords">
3829+
Lookup table for password. Provide pairs of the user/group account name and the associated passwords for any task that requires a password.
3830+
</param>
3831+
</member>
3832+
<member name="M:Microsoft.Win32.TaskScheduler.TaskSchedulerSnapshot.Restore(Microsoft.Win32.TaskScheduler.TaskService,System.Collections.Generic.ICollection{Microsoft.Win32.TaskScheduler.SnapshotItem},System.Boolean,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.String},System.Threading.CancellationToken,System.IProgress{System.Tuple{System.Int32,System.String}})">
3833+
<summary>Register a list of snapshot items (tasks and folders) into the specified Task Scheduler.</summary>
3834+
<param name="ts">The <see cref="T:Microsoft.Win32.TaskScheduler.TaskService" /> into which the tasks and folders are registered.</param>
3835+
<param name="items">
3836+
The list of <see cref="T:Microsoft.Win32.TaskScheduler.SnapshotItem" /> instances representing the tasks and folders from this snapshot that should be registered on the
3837+
<see cref="T:Microsoft.Win32.TaskScheduler.TaskService" /> instance.
3838+
</param>
3839+
<param name="applyAccessRights">
3840+
If <c>true</c>, takes the access rights from the snapshot item and applies it to both new and existing tasks and folders.
3841+
</param>
3842+
<param name="overwriteExisting">
3843+
If <c>true</c>, overwrite any existing tasks and folders found in the target Task Scheduler that match the path of the snapshot item.
3844+
</param>
3845+
<param name="passwords">
3846+
Lookup table for password. Provide pairs of the user/group account name and the associated passwords for any task that requires a password.
3847+
</param>
3848+
<param name="cancelToken">A cancellation token to use to cancel this asynchronous operation.</param>
3849+
<param name="progress">An optional <see cref="T:System.IProgress`1" /> instance to use to report progress of the asynchronous operation.</param>
3850+
<returns>An asynchronous <see cref="T:Microsoft.Win32.TaskScheduler.Task" /> instance.</returns>
3851+
</member>
3852+
<member name="M:Microsoft.Win32.TaskScheduler.TaskSchedulerSnapshot.Restore(Microsoft.Win32.TaskScheduler.TaskService,System.Collections.Generic.IEnumerable{System.String},System.Boolean,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.String},System.Threading.CancellationToken,System.IProgress{System.Tuple{System.Int32,System.String}})">
3853+
<summary>Register a list of snapshot items (tasks and folders) into the specified Task Scheduler.</summary>
3854+
<param name="ts">The <see cref="T:Microsoft.Win32.TaskScheduler.TaskService" /> into which the tasks and folders are registered.</param>
3855+
<param name="itemPaths">
3856+
The list of paths representing the tasks and folders from this snapshot that should be registered on the <see cref="T:Microsoft.Win32.TaskScheduler.TaskService" /> instance.
3857+
</param>
3858+
<param name="applyAccessRights">
3859+
If <c>true</c>, takes the access rights from the snapshot item and applies it to both new and existing tasks and folders.
3860+
</param>
3861+
<param name="overwriteExisting">
3862+
If <c>true</c>, overwrite any existing tasks and folders found in the target Task Scheduler that match the path of the snapshot item.
3863+
</param>
3864+
<param name="passwords">
3865+
Lookup table for password. Provide pairs of the user/group account name and the associated passwords for any task that requires a password.
3866+
</param>
3867+
<param name="cancelToken">A cancellation token to use to cancel this asynchronous operation.</param>
3868+
<param name="progress">An optional <see cref="T:System.IProgress`1" /> instance to use to report progress of the asynchronous operation.</param>
3869+
<returns>An asynchronous <see cref="T:Microsoft.Win32.TaskScheduler.Task" /> instance.</returns>
3870+
</member>
3871+
<member name="P:Microsoft.Win32.TaskScheduler.TaskSchedulerSnapshot.TargetServer">
3872+
<summary>Gets the machine name of the server from which the snapshot was taken.</summary>
3873+
</member>
3874+
<member name="P:Microsoft.Win32.TaskScheduler.TaskSchedulerSnapshot.TimeStamp">
3875+
<summary>Gets the UTC time stamp for when the snapshot was taken.</summary>
3876+
</member>
37593877
<member name="T:Microsoft.Win32.TaskScheduler.TaskSecurity">
37603878
<summary>
37613879
Represents the Windows access control security for a Task Scheduler task. This class cannot be inherited.
@@ -4390,6 +4508,15 @@
43904508
Gets or sets an XML-formatted definition of the task settings.
43914509
</summary>
43924510
</member>
4511+
<member name="T:Microsoft.Win32.TaskScheduler.TaskSnapshot">
4512+
<summary>Represents a <see cref="T:Microsoft.Win32.TaskScheduler.Task" /> instance and captures its details.</summary>
4513+
</member>
4514+
<member name="P:Microsoft.Win32.TaskScheduler.TaskSnapshot.Enabled">
4515+
<summary>Gets a value indicating whether th <see cref="T:Microsoft.Win32.TaskScheduler.Task" /> is enabled.</summary>
4516+
</member>
4517+
<member name="P:Microsoft.Win32.TaskScheduler.TaskSnapshot.TaskDefinitionXml">
4518+
<summary>Gets the <see cref="T:Microsoft.Win32.TaskScheduler.TaskDefinition" /> XML.</summary>
4519+
</member>
43934520
<member name="T:Microsoft.Win32.TaskScheduler.TaskState">
43944521
<summary>Defines the different states that a registered task can be in.</summary>
43954522
</member>

0 commit comments

Comments
 (0)