BATCH_QUEUE_INFO_1 - Intergraph Batch Services - Help

Intergraph Batch Services Help

Language
English
Product
Intergraph Batch Services
Search by Category
Help

Description

The BATCH_QUEUE_INFO_1 structure is a short form of the queue information suitable for quick status update or for changing common queue attributes.

Structure

struct _batchQinfo1

{

LPTSTR qname

/* full batch queue name */

DWORD qtype

/* type: BATCH or PIPE */

DWORD state

/* INFLOW | OUTFLOW */

DWORD qpri

/* intraqueue priority */

DWORD jobcount

/* number of jobs currently in queue */

LPTSTR description

/* text description of queue */

LPBYTE reserved

/* NULL: reserved for future features. */

} BATCH_QUEUE_INFO_1, *PBATCH_QUEUE_INFO_1;

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 state of the queue, either inflow or outflow (a bitwise OR of the inflow and outflow states). The following 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.

DWORD jobcount

The number of jobs in this queue.

LPTSTR description

A user-supplied text description of the queue.

LPBYTE reserved

NULL pointer. In future versions, this pointer may reference added queue attributes.