Description
The BATCH_QUEUE_INFO_2 structure completely describes a queue and all of its attributes.
Structure
|
struct _batchQinfo2 |
||
|
{ |
||
|
LPTSTR qname |
/* full batch queue name */ |
|
|
DWORD qtype |
/* type: BATCH or PIPE */ |
|
|
DWORD state |
/* INFLOW | OUTFLOW */ |
|
|
DWORD qpri |
/* intraqueue priority */ |
|
|
long defaultpri |
/* default job priority */ |
|
|
DWORD runprilimit |
/* maximum run-time priority. */ |
|
|
DWORD runlimit |
/* max running jobs */ |
|
|
DWORD sizelimit |
/* max size of incoming jobs. [Not Implemented] */ |
|
|
DWORD jobcount |
/* number of jobs currently in queue */ |
|
|
LPTSTR description |
/* text description of queue */ |
|
|
PSECURITY_DESCRIPTOR pSD |
/* who can use this queue */ |
|
|
FILETIME system |
/* amount of kernel time used by jobs */ |
|
|
FILETIME user |
/* amount of user time used by jobs */ |
|
|
DWORD processor_affinity |
/* multiprocessor flags */ |
|
|
LPBYTE reserved |
/* NULL: reserved for future features */ |
|
|
union v |
||
|
{ |
||
|
struct batch |
||
|
{ |
||
|
LPTSTR *shell_list |
/* list of valid shells for this queue */ |
|
|
LPTSTR defaultshell |
/* default shell for jobs */ |
|
|
}; |
||
|
struct pipe |
||
|
{ |
||
|
LPTSTR *dest_list |
/* list of pipe queue destinations */ |
|
|
}; |
||
|
} |
||
|
} BATCH_QUEUE_INFO_2, *PBATCH_QUEUE_INFO_2; |
Parameters
|
LPTSTR qname |
The full name of the queue, including the server name. |
|
|
DWORD qtype |
The queue type. This value is either BATCH_QUEUE_TYPE_BATCH (batch queue) or BATCH_QUEUE_TYPE_PIPE (pipe queue). |
|
|
DWORD state |
The queue state (a bitwise OR of the inflow and outflow states). The following inflow states are valid: |
|
|
BATCH_QUEUE_INFLOW_STATE_CLOSED |
||
|
BATCH_QUEUE_INFLOW_STATE_ENABLED |
||
|
BATCH_QUEUE_INFLOW_STATE_DISABLED |
||
|
The following outflow states are valid: |
||
|
BATCH_QUEUE_OUTFLOW_STATE_STARTED |
||
|
BATCH_QUEUE_OUTFLOW_STATE_STOPPED |
||
|
BATCH_QUEUE_OUTFLOW_STATE_STOPPING |
||
|
BATCH_QUEUE_OUTFLOW_STATE_SHUTDOWN |
||
|
DWORD qpri |
The priority of the queue, which is used to determine the relative order of access to limited resources between queues. Queue priorities range from 0 to 64. |
|
|
long defaultpri |
The priority assigned to jobs in the queue that do not have a job priority set, in the range -1024 to 1023. The default value is 31. |
|
|
DWORD runprilimit |
The maximum run-time job priority allowed in this queue. This limit is only enforced for batch queues. The following values are valid (the default priority is NORMAL_PRIORITY_CLASS): |
|
|
IDLE_PRIORITY_CLASS |
||
|
NORMAL_PRIORITY_CLASS |
||
|
HIGH_PRIORITY_CLASS |
||
|
REALTIME_PRIORITY_CLASS
|
||
|
DWORD runlimit |
The maximum number of simultaneous running jobs allowed in this queue. The default runlimit is 1. |
|
|
DWORD sizelimit |
The maximum total file size allowed for a batch job. This limit is not enforced, but may be used in later versions. |
|
|
DWORD jobcount |
The number of jobs in this queue. |
|
|
LPTSTR description |
A user-supplied text description of the queue. |
|
|
PSECURITY_DESCRIPTOR pSD |
A security descriptor containing the access control list for this queue. By default, the access control list will allow all users to have submit access to the queue. |
|
|
FILETIME system |
The cumulative system-execution time used by all batch jobs run in this queue since its creation. |
|
|
FILETIME user |
The cumulative user-space execution time used by all batch jobs run in this queue since its creation. |
|
|
DWORD processor_affinity |
A bitmask of flags used to set multiprocessor options. |
|
|
LPBYTE reserved |
A NULL pointer. In future versions, this pointer may reference added queue attributes. |
|
|
union v |
A union of structures containing batch and pipe queue specific information. |
|
|
v.batch |
A structure containing batch queue specific information that is not needed for other queue types. |
|
|
LPTSTR *shell_list |
A list of command interpreters that jobs are allowed to use for this queue. The list is in the format shellname=shellpath, where shellname is the short text name of the shell (such as ksh, perl, or DOS), and shellpath is a full pathname to the corresponding command interpreter. The same pathname may be used for more than one shellname, but the shellnames must be unique. Both shellname and shellpath may be of unlimited length. |
|
|
LPTSTR defaultshell |
The name of the default command interpreter for batch shell scripts. |
|
|
v.pipe |
A structure containing pipe queue specific information that is not needed for other queue types. |
|
|
LPTSTR *dest_list |
A list of pipe queue destinations. The list consists of full queue names (including the server name) to which jobs in the pipe queue may be routed. |
A REALTIME process preempts all other processes, including the operating system.
Intergraph recommends that you avoid using the REALTIME priority.