Share via


ITask interface

Defines a task.

To create a task, call the ICluster::CreateTask method.

Members

The ITask interface inherits from the IDispatch interface. ITask also has these types of members:

  • Methods

Methods

The ITask interface has these methods.

Method Description
get_CommandLine

Retrieves the command line for the task.

get_CreateTime

Retrieves the task creation time.

get_Depend

Retrieves the dependent tasks.

get_EndTime

Retrieves the task end time.

get_EnvironmentVariables

Retrieves the environment variables for the task.

get_ErrorMessage

Retrieves the task error message.

get_ExitCode

Retrieves the exit code for the task.

get_ExtendedTaskTerms

Retrieves the application-defined extended terms for the task.

get_Id

Retrieves the task identifier.

get_IsExclusive

Checks whether the node should be exclusively allocated to the task.

get_IsRerunnable

Checks whether the task can be rerun after a failure.

get_MaximumNumberOfProcessors

Retrieves the maximum number of processors required by the task.

get_MinimumNumberOfProcessors

Retrieves the minimum number of processors required by the task.

get_Name

Retrieves the display name of the task.

get_ParentJobId

Retrieves the identifier of the parent job.

get_RequiredNodes

Retrieves the list of required nodes for the task.

get_Runtime

Retrieves the run-time limit for the task.

get_StartTime

Retrieves the time that the task started running.

get_Status

Retrieves the task status.

get_Stderr

Retrieves the file to which standard error has been redirected.

get_Stdin

Retrieves the file from which standard input has been redirected.

get_Stdout

Retrieves the file to which standard output has been redirected.

get_SubmitTime

Retrieves the time that the task was submitted.

get_WorkDirectory

Retrieves the startup directory for the task.

put_CommandLine

Sets the command line for the task.

put_Depend

Sets the dependent tasks.

put_IsExclusive

Sets whether the node should be exclusively allocated to the task.

put_IsRerunnable

Sets whether the task can be rerun after a failure.

put_MaximumNumberOfProcessors

Sets the maximum number of processors required by the task.

put_MinimumNumberOfProcessors

Sets the minimum number of processors required by the task.

put_Name

Sets the display name of the task.

put_RequiredNodes

Sets the list of required nodes for the task.

put_Runtime

Sets the run-time limit for the task.

put_Stderr

Redirects standard error to the specified file.

put_Stdin

Redirects standard input to the specified file.

put_Stdout

Redirects standard output to the specified file.

put_WorkDirectory

Sets the startup directory for the task.

SetEnvironmentVariable

Sets the task-specific environment variable.

SetExtendedTaskTerm

Sets the application-defined extended term for the task.

 

Requirements

Product

Compute Cluster Pack Client Utilities

Type library

Ccpapi.tlb

See also

Jobs and Tasks

CCP Interfaces