adTempus API
ArcanaDevelopment.adTempus.Client Namespace / JobGroup Class / GetGroupsWithPaging Method
Options that control how objects are returned.
Specifies the number of objects to return in each call. Set to 0 to return all objects. See Remarks.
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.


In This Topic
    GetGroupsWithPaging Method
    In This Topic
    Gets all child groups for this group, with options.
    Syntax
    'Declaration
     
    
    Public Function GetGroupsWithPaging( _
       ByVal options As ObjectFetchOptions, _
       ByVal pageSize As Integer, _
       ByRef restartPaging As Boolean _
    ) As JobGroupCollection

    Parameters

    options
    Options that control how objects are returned.
    pageSize
    Specifies 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

    Calling this method has no effect on the set of groups returned by GetGroups or the Groups property, and vice-versa.

    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.

    See Also