ITeamFoundationJobService.QueueDelayedJob Method (TeamFoundationJobDefinition, Int32)

Schedules a job to be executed in the near future.

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

Syntax

'Declaration
Function QueueDelayedJob ( _
    job As TeamFoundationJobDefinition, _
    maxDelaySeconds As Integer _
) As Integer

int QueueDelayedJob(
    TeamFoundationJobDefinition job,
    int maxDelaySeconds
)

int QueueDelayedJob(
    TeamFoundationJobDefinition^ job, 
    int maxDelaySeconds
)

abstract QueueDelayedJob : 
        job:TeamFoundationJobDefinition * 
        maxDelaySeconds:int -> int 

function QueueDelayedJob(
    job : TeamFoundationJobDefinition, 
    maxDelaySeconds : int
) : int

Parameters

• job
  Type: Microsoft.TeamFoundation.Framework.Client.TeamFoundationJobDefinition
  The job definition to schedule for execution.

• maxDelaySeconds
  Type: System.Int32
  The number of seconds to delay the start of the job.

Return Value

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

Remarks

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.

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

ITeamFoundationJobService Interface

QueueDelayedJob Overload

Microsoft.TeamFoundation.Framework.Client Namespace