HLO QUEUE MANAGEMENT APIS ICR (4730)

Name

Value

NUMBER

4730

IA #

4730

DATE CREATED

2005/08/19

CUSTODIAL PACKAGE

HEALTH LEVEL SEVEN

USAGE

Supported

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

HLOQUE

NAME

HLO QUEUE MANAGEMENT APIS

GENERAL DESCRIPTION

These APIs are for applications to use in KIDS
distributions of messaging applications.  They allow the application to turn
on and off individual queues during the instalation of a patch.

STATUS

Active

DURATION

Till Otherwise Agreed

HLOQUE

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

STOPQUE(DIR,QUEUE)

Routine designed to set a "Stop" flag on a named
queue. Flag to set is ^HLTMP("STOPPED QUEUES",DIR,QUEUE).

VARIABLES	TYPE	VARIABLES DESCRIPTION
DIR	Input	Direction of queue. Values are "IN" or "OUT".
QUEUE	Input	The name of the queue to be stopped.

STARTQUE(DIR,QUEUE)

Routine designed to remove a "Stop" flag on a named
queue. Flag to remove is ^HLTMP("STOPPED QUEUES",DIR,QUEUE).

VARIABLES	TYPE	VARIABLES DESCRIPTION
DIR	Input	Direction of queue. Values are "IN" or "OUT".
QUEUE	Input	The name of the queue to be started.

$$STOPPED(DIR,QUEUE)

Function designed to check the status of a queue by
determining if a "Stop" flag has been set on a named queue. Flag to check is
^HLTMP("STOPPED QUEUES",DIR,QUEUE).

VARIABLES	TYPE	VARIABLES DESCRIPTION
DIR	Input	Direction of queue. Values are "IN" or "OUT".
QUEUE	Input	The name of the queue to be checked.
$$STOPPED	Output	The function returns 1 if the named queue is stopped, 0 otherwise.