GetJobsWithPaging Method (JobGroup)

In This Topic

Gets all jobs for the group, with options.

Syntax

Visual Basic
C#

'Declaration
 
Public Function GetJobsWithPaging( _
   ByVal options As ObjectFetchOptions, _
   ByVal pageSize As Integer, _
   ByRef restartPaging As Boolean _
) As JobCollection

public JobCollection GetJobsWithPaging( 
   ObjectFetchOptions options,
   int pageSize,
   ref bool restartPaging
)

Parameters

options: Options that control how objects are returned.
pageSize: Specfies the number of objects to return in each call. Set to 0 to return all objects. See Remarks.
restartPaging: On input, indicates whether to start a new paging operation (true) or continue a previous paging operation (false). On return, indicates whether all records have been returned (true) or more records remain (false). See Remarks.

Remarks

Paging To fetch objects in pages (a maximum number of objects is returned in each request), set the pageSize to the maximum number requested and set restartPaging to true. On return, restartPaging will be false if there are more objects that can be fetched. To fetch the remaining pages of objects, continue to call the method, leaving restartPaging set to false, until restartPaging is true on return. At this point, all available objects have been returned.

Reference

JobGroup Class
JobGroup Members