| XMD |
Create and send a new message. If no recipients are
defined (in XMY), and '$D(ZTQUEUED), then prompt for them. Addressing
restrictions are automatically waived, so there is no need to set XMDF.
Compare to SENDMSG^XMXAPI (DBIA 2729).
Usage:
Set up the input variables
D ^XMD
Check the output variables
More extensive definitions of the I/O variables can be found in the General
Description.
Core input variables:
DUZ (optional) User DUZ.
XMDUZ (optional) Message is from other than DUZ.
XMSUB Message subject.
XMTEXT Message text.
XMY (optional) Message addressees. If none, and '$D(ZTQUEUED), the user
will be prompted for them. If none, and $D(ZTQUEUED), the message will be
created, but it won't be sent, and XMMG will not be defined.
Additional input variables:
DIFROM (optional) Specifically for FileMan package
XMMG (optional) If there are no recipients in XMY, and the job is running
in the foreground, XMMG may contain the default recipient presented to the
user. If XMMG is not defined, then the default recipient is the user, as
defined by XMDUZ.
XMROU (optional) Array of routines to be loaded in a PackMan message. For
each routine, set XMROU(x)="", where x is the routine name.
XMSTRIP (optional) Characters to be removed from the message text
Output variables:
XMMG This is the variable which the calling program should check to see
whether or not the call was successful. If XMMG is undefined, then the call
was successful. If the call failed, then XMMG contains the error message.
XMZ If the call was successful, then XMZ is the message IEN of the
message which was created. If the call failed, then XMZ is unchanged or
undefined.
Variables killed upon exit:
If the call is successful, XMSUB, XMTEXT, XMY, XMSTRIP, XMMG will be killed.
If the call fails, those variables may or may not be killed, except for XMMG,
which will contain an error message.
WARNING: If calling XMD in a Pre-init or Post-init, you MUST NEW DIFROM prior
to the call or your message will NOT be delivered.
|
ENT1 |
Forward a message. Addressing restrictions are
automatically waived, so there is no need to set XMDF.
Compare to FWDMSG^XMXAPI (DBIA 2729).
Usage:
Set up the input variables
D ENT1^XMD
More extensive definitions of the I/O variables can be found in the General
Description.
Input variables:
DUZ (optional) User DUZ.
XMDUZ (optional) Message is forwarded by other than DUZ.
XMY Addressees to forward to
XMZ Message IEN in MESSAGE file (3.9), of message to forward.
Output variables:
None.
Variables killed upon exit:
XMDUZ,XMY
|
ENT2 |
Forward a message. If '$D(ZTQUEUED), prompt for
additional recipients, whether or not any are already defined.
Usage:
Set up the input variables
D ENT2^XMD
More extensive definitions of the I/O variables can be found in the General
Description.
Input variables:
DUZ (optional) User DUZ.
XMDUZ (optional) Message is forwarded by other than DUZ.
XMDF (optional) If $D(XMDF), all addressing restrictions are waived.
XMY (optional) Addressees to forward to. If '$D(ZTQUEUED) (job running
in the foreground), the user will be prompted for additional recipients.
XMZ Message IEN in MESSAGE file (3.9), of message to forward.
Output variables:
None.
Variables killed upon exit:
XMDUZ,XMY
|
ENT |
Place this entry point in an interactive option for
the process to send a message. It can be put onto many menus. It is the same
as XMSEND, the Send a Message option. It requires that the Entry Action and
Exit Action be specified. Set up the option as follows:
Entry Action: S XMMENU(0)=<name of the menu option>
Routine: ENT^XMD
Exit Action: K XMMENU D CHECKOUT^XM
Compare to SENDMSG^XMXAPIU (DBIA 2774).
Input Variables:
DUZ User's DUZ
Output Variables:
none
|
ENL |
Add text to an existing message.
Usage:
Set up the input variables
D ENL^XMD
More extensive definitions of the I/O variables can be found in the General
Description.
Core input variables:
DUZ User DUZ.
XMTEXT Message text.
XMZ Message IEN in the MESSAGE file (3.9).
Additional input variables:
XMSTRIP (optional) Characters to be removed from the message text
Output variables:
none
Variables killed upon exit:
XMSTRIP
|
EN1 |
Add text to a message, and address it and send it.
If no recipients are defined (in XMY), and '$D(ZTQUEUED), then prompt the user
for them.
Usage:
Set up the input variables
D EN1^XMD
More extensive definitions of the I/O variables can be found in the General
Description.
Core input variables:
DUZ User DUZ.
XMTEXT Message text.
XMY (optional) Message addressees. If none, and '$D(ZTQUEUED), the user
will be prompted for them. If none, and $D(ZTQUEUED), the message will be
created, but it won't be sent, and XMMG will not be defined.
XMZ Message IEN in the MESSAGE file (3.9).
Additional input variables:
DIFROM (optional) Specifically for FileMan package
XMMG (optional) If there are no recipients in XMY, and the job is running
in the foreground, XMMG may contain the default recipient presented to the
user. If XMMG is not defined, then the default recipient is the user, as
defined by DUZ.
XMROU (optional) Array of routines to be loaded in a PackMan message. For
each routine, set XMROU(x)="", where x is the routine name.
XMSTRIP (optional) Characters to be removed from the message text
Output variables:
none
Variables killed upon exit:
XMTEXT, XMY, XMSTRIP, XMMG
|