LOOKUP / CREATE BASKET ICR (1147)

Name

Value

NUMBER

1147

IA #

1147

DATE CREATED

1995/02/20

CUSTODIAL PACKAGE

MAILMAN

CUSTODIAL ISC

San Francisco

USAGE

Supported

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

XMAD2

NAME

LOOKUP / CREATE BASKET

GENERAL DESCRIPTION

This function looks up a mail basket name and returns
its IEN.  If the basket doesn't exist, the basket will be created and the IEN
of the newly created basket will be returned.

STATUS

Active

XMAD2

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

$$BSKT

This function looks up a mail basket name and returns
its IEN.

Given a basket name and a user's DUZ, lookup the basket.  If it doesn't exist,
create it and return its IEN.  If it does exist, return its IEN.  If there's
an error, return an error message.

CRE8BSKT^XMXAPIB (DBIA 2723) can also be used to create a basket.

Usage:  S variable=$$BSKT^XMAD2(XMKN,XMDUZ)

Where:  XMKN=Basket-name
XMDUZ=DUZ (user IEN)

Examples:

W $$BSKT^XMAD2("ZZZZZ",9999)
999     (The IEN is returned when there are no errors.)

W $$BSKT^XMAD2(1,1) or W $$BSKT^XMAD2("A",1)
An error message to the effect that Basket names contain 2 to 30 chars.

W $$BSKT^XMAD2("zzzzzz",99999999)
An error message to the effect that No such MailMan user as 99999999 is
known.

S B=$$BSKT^XMAD2(X,Y)
I B<1 W !!,"MailMan found the following error: ",B
MailMan found the following error:
An error message to the effect that a certain error occurred.

VARIABLES	TYPE	VARIABLES DESCRIPTION
XMKN	Input	The name of the basket to be looked up or created. It must be the exact name. It must be 2-30 characters.
XMDUZ	Input	The DUZ of the user whose basket is being looked up or created.