PRINT A MESSAGE API ICR (1230)

Name

Value

NUMBER

1230

IA #

1230

DATE CREATED

1995/05/17

CUSTODIAL PACKAGE

MAILMAN

CUSTODIAL ISC

San Francisco

USAGE

Supported

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

XMA0

NAME

PRINT A MESSAGE API

GENERAL DESCRIPTION

The entry points in this API print messages:
- PR2^XMA0    print a message with a header
- HDR^XMA0    print a message without a header
- ENTPRT^XMA0 interactive print a message

STATUS

Active

XMA0

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

ENTPRT

This interactive API lets the user print a message
with a header.  The message to print is pre-defined, but the user may choose
the device to which to print, and which responses to print.

VARIABLES	TYPE	VARIABLES DESCRIPTION
DUZ	Input	The IEN of the user in the NEW PERSON file.
XMDUZ	Used	(optional) The DUZ of the user. Default is DUZ.
XMK	Input	The IEN of the basket in the user's mailbox in which the message to be printed is located.
XMZ	Input	Message IEN in the Message file of the message to be printed.

HDR

Headerless print a message.

Compare to PRTMSG^XMXAPI (DBIA 2729).

Usage:
IO has been defined with a KERNEL device call.
S XMK=basket IEN
S XMZ=message IEN
D HDR^XMA0  ; prints the message in its entirety
- or -
S $P(XMTYPE,";",6)=3
D HDR^XMA0  ; prints the message from response 3 to the end.

VARIABLES	TYPE	VARIABLES DESCRIPTION
DUZ	Input	The IEN of the user in the NEW PERSON file.
XMDUZ	Used	(optional) The DUZ of the user. Default is DUZ.
XMK	Input	The IEN of the basket in the user's mailbox in which the message to be printed is located.
XMZ	Input	Message IEN in the Message file of the message to be printed.
IO	Input	The device to which the message is to be printed.
XMTYPE	Used	(optional) Lets you determine from which response to start printing. If XMTYPE="^", then abort. If ";"-piece 6 is null or zero, or if '$D(XMTYPE), the message is printed in its entirety. If ";"-piece 6 is a number, the message will be printed from that response to the end. The other ";"-pieces are ignored.

PR2

Print a message with a header.

Compare to PRTMSG^XMXAPI (DBIA 2729).

Usage:
IO has been defined with a KERNEL device call.
S XMK=basket IEN
S XMZ=message IEN
D PR2^XMA0  ; prints the message in its entirety
- or -
S $P(XMTYPE,";",6)=3
D PR2^XMA0  ; prints the message from response 3 to the end.

VARIABLES	TYPE	VARIABLES DESCRIPTION
DUZ	Input	The IEN of the user in the NEW PERSON file.
XMDUZ	Used	(optional) The DUZ of the user. Default is DUZ.
XMK	Input	The IEN of the basket in the user's mailbox in which the message to be printed is located.
XMZ	Input	Message IEN in the Message file of the message to be printed.
IO	Input	The device to which the message is to be printed.
XMTYPE	Used	(optional) Lets you determine from which response to start printing. If XMTYPE="^", then abort. If ";"-piece 6 is null or zero, or if '$D(XMTYPE), the message is printed in its entirety. If ";"-piece 6 is a number, the message will be printed from that response to the end. The other ";"-pieces are ignored.