This documentation is archived and is not being maintained.

ITeamFoundationJobService.QueueDelayedJob Method (TeamFoundationJobDefinition)

Schedules the specified job to be executed in the near future.

Namespace:  Microsoft.TeamFoundation.Framework.Client
Assembly:  Microsoft.TeamFoundation.Client (in Microsoft.TeamFoundation.Client.dll)

int QueueDelayedJob(
	TeamFoundationJobDefinition job
)

Parameters

job
Type: Microsoft.TeamFoundation.Framework.Client.TeamFoundationJobDefinition

The job definition to schedule for execution.

Return Value

Type: System.Int32
Returns 1 if the job was successfully queued; otherwise, returns 0.

QueueDelayedJob will only cause a job to run sooner or will have no effect. It will never postpone a job that is already scheduled to be executed in the near future.

Show: