ITeamFoundationJobService.QueueDelayedJob Method (Guid, 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 ( _
    jobId As Guid, _
    maxDelaySeconds As Integer _
) As Integer
int QueueDelayedJob(
    Guid jobId,
    int maxDelaySeconds
)
int QueueDelayedJob(
    Guid jobId, 
    int maxDelaySeconds
)
abstract QueueDelayedJob : 
        jobId:Guid * 
        maxDelaySeconds:int -> int
function QueueDelayedJob(
    jobId : Guid, 
    maxDelaySeconds : int
) : int

Parameters

  • jobId
    Type: System.Guid

    The GUID of the job 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

See Also

Reference

ITeamFoundationJobService Interface

QueueDelayedJob Overload

Microsoft.TeamFoundation.Framework.Client Namespace