GetQueue Method (JobExec)
- Last UpdatedNov 06, 2025
- 1 minute read
The GetQueue() method retrieves the job queue for the specified entity. The job queue consists of all jobs queued to the entity. Optionally, the jobs can be filtered by job state, the required-by date, and/or job priority. Pass the DataSet to populate by reference so the existing instance can continually be refreshed.
'Declaration
Public Function GetQueue( _
ByVal entId As Integer, _
ByVal jobStateFilter As Object, _
ByVal reqdByFilter As Object, _
ByVal jobPriorityFilter As Object, _
ByVal maxRows As Object _
) As DataSet
public DataSet GetQueue(
int entId,
object jobStateFilter,
object reqdByFilter,
object jobPriorityFilter,
object maxRows
)
Parameters
- entId
- Required. Holds the ID of the entity for which to retrieve the job queue.
- jobStateFilter
- Optional. Holds the job state filter to retrieve only queued jobs that are in the current job state. Set to null to ignore.
- reqdByFilter
- Optional. Holds the required-by filter to retrieve only jobs that are required by a certain date/time. Set to null to ignore.
- jobPriorityFilter
- Optional. Holds the job priority filter to retrieve only jobs that are of a particular job priority. Set to null to ignore.
- maxRows
- Optional. Holds the maximum number of rows to return, if required. Set to null if specifying a maximum number of rows is not required.
Return Value
Returns a DataSet containing a row for every job in the queue matching the filter
specifications.