HLO MISCELANEOUS APIS ICR (4724)

Name

Value

NUMBER

4724

IA #

4724

DATE CREATED

2005/08/19

CUSTODIAL PACKAGE

HEALTH LEVEL SEVEN

USAGE

Supported

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

HLOAPI3

NAME

HLO MISCELANEOUS APIS

GENERAL DESCRIPTION

These are APIs provided by HLO that don't fit into any
of the other categories.

STATUS

Active

DURATION

Till Otherwise Agreed

HLOAPI3

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

$$RESEND(MSGIEN,.ERROR)

This routine re-transmits a message.  It does this by
making a copy of the message, reusing all the original parameters. Then the
message is placed in the same outgoing queue.

VARIABLES	TYPE	VARIABLES DESCRIPTION
$$RESEND	Output	The function returns 1 on success, 0 on failure.
MSGIEN	Input	The IEN of the message that is to be sent from HLO MESSAGES file( #778).
ERROR	Output	On failure, the function also returns an error message.

$$REPROC(MSGIEN,.ERROR)

This routine reprocesses a message by placing it on
the appropriate incoming queue.

VARIABLES	TYPE	VARIABLES DESCRIPTION
$$REPROC	Output	This function returns 1 on success, 0 on failure.
MSGIEN	Input	The IEN of the message that is to be sent from HLO MESSAGES file( #778).
ERROR	Output	On failure, this function also returns an error message.

$$SETPURGE(MSGIEN,TIME)

This API can be used to reset the scheduled purge
date/time.

VARIABLES

TYPE

VARIABLES DESCRIPTION

$$SETPURGE

Output

This function returns 1 on success, 0 on failure.

MSGIEN

Input

The IEN of the message that is to be reprocessed from
HLO MESSAGES file (#778).

TIME

Input

Optional, date/time to which to set the purge time.
If not defined, defaults to NOW.