TaskPrincipal Class

Provides the security credentials for a principal. These security credentials define the security context for the tasks that are associated with the principal.

Definition

Namespace: Microsoft.Win32.TaskScheduler
Assembly: Microsoft.Win32.TaskScheduler (in Microsoft.Win32.TaskScheduler.dll) Version: 2.11.0

C#View Source Request Example

[XmlRootAttribute("Principals", Namespace = "http://schemas.microsoft.com/windows/2004/02/mit/task", 
	IsNullable = true)]
public sealed class TaskPrincipal : IDisposable, 
	IXmlSerializable, INotifyPropertyChanged

Inheritance: Object TaskPrincipal

Implements: INotifyPropertyChanged, IDisposable, IXmlSerializable

Remarks

This class can only be accessed via Principal. It is used to set properties related to the principal (account) that will run a task.

Example

C#

TaskDefinition td = TaskService.Instance.NewTask();
            td.Principal.UserId = "SYSTEM";
            td.Principal.LogonType = TaskLogonType.ServiceAccount;

Properties

Account	Gets the account associated with this principal. This value is pulled from the TaskDefinition's XMLText property if set.
DisplayName	Gets or sets the name of the principal that is displayed in the Task Scheduler UI.
GroupId	Gets or sets the identifier of the user group that is required to run the tasks that are associated with the principal. Setting this property to something other than a null or empty string, will set the UserId property to NULL and will set the LogonType property to TaskLogonType.Group;
Id	Gets or sets the identifier of the principal.
LogonType	Gets or sets the security logon method that is required to run the tasks that are associated with the principal.
ProcessTokenSidType	Gets or sets the task process security identifier (SID) type.
RequiredPrivileges	Gets the security credentials for a principal. These security credentials define the security context for the tasks that are associated with the principal.
RunLevel	Gets or sets the identifier that is used to specify the privilege level that is required to run the tasks that are associated with the principal.
UserId	Gets or sets the user identifier that is required to run the tasks that are associated with the principal. Setting this property to something other than a null or empty string, will set the GroupId property to NULL;

Methods

Dispose	Releases all resources used by this class.
Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetType	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
RequiresPassword	Gets a value indicating whether current Principal settings require a password to be provided.
ToString	Returns a String that represents this instance. (Overrides ObjectToString)
ValidateAccountForSidType	Validates the supplied account against the supplied TaskProcessTokenSidType.

Events

PropertyChanged

Occurs when a property value changes.