HLO SUBSCRIPTION REGISTRY APIS (CONTINUED) ICR (4726)

Name

Value

NUMBER

4726

IA #

4726

DATE CREATED

2005/08/19

CUSTODIAL PACKAGE

HEALTH LEVEL SEVEN

USAGE

Supported

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

HLOASUB1

NAME

HLO SUBSCRIPTION REGISTRY APIS (CONTINUED)

GENERAL DESCRIPTION

This continues the APIs for HLO subscription lists.
See IA# 4725.

STATUS

Active

DURATION

Till Otherwise Agreed

HLOASUB1

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

$$INDEX(IEN,.PARMARY)

This function call allows an application to build an
index of its subscriptions.  This is optional, but using this function allows
the application to easily find subscriptions without storing the IEN.

VARIABLES

TYPE

VARIABLES DESCRIPTION

$$INDEX

Output

The function returns 1 on success, 0 on failure.

IEN

Input

IEN of the HLO SUBSCRIPTION REGISTRY file (#779.4)
entry.

PARMARY

Input

Array of parameters with which to build the index.
The format is: PARMARY(1)=<first parameter>, PARMARY(2)=<second parameter>  If
PARMARY(i)=null, the parameter will be translated to a single space.

$$FIND(OWNER,.PARMARY)

This function call allows an application to find a
subscription registry entry.  The application must maintain a private index in
order to utilize this function, via $$INDEX^HLOASUB1.

VARIABLES

TYPE

VARIABLES DESCRIPTION

$$FIND

Output

This function returns the IEN of the subscription
list if found, 0 otherwise.

OWNER

Input

The name of the owning application, as specified when
the subscription list was created.

PARMARY

Input

The array of parameters with which the  index was
built.  The format is: PARMARY(1)=<first parameter>, PARMARY(2)=<second
parameter>  If PARMARY(i)=null, the parameter will be translated to a single
space.