Print Page as PDF
ScreenMan API: Form Processor ICR (10031)

ScreenMan API: Form Processor    ICR (10031)

Name Value
NUMBER 10031
IA # 10031
DATE CREATED 1998/11/18
CUSTODIAL PACKAGE VA FILEMAN
CUSTODIAL ISC San Francisco
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE DDS
NAME ScreenMan API: Form Processor
ORIGINAL NUMBER 10031
GENERAL DESCRIPTION
You can call this entry point directly from a MUMPS
routine to invoke the specified form.
STATUS Active
ID DDS
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
DDS
This routine invokes a ScreenMan form attached to the
specified file.  ScreenMan automatically uses incremental locks to lock all
records accessed during an editing session.
VARIABLES TYPE VARIABLES DESCRIPTION
DDSFILE Input
(Required) The number or global root of the Primary
File of the form.
DR Input
(Required) The name of the form (an entry in the Form
file) enclosed in square brackets.
DA Input
(Optional) The record number of the file entry to
display or edit. If DA is null or undefined, the form must either contain no
data dictionary fields or have a Record Selection page, which is the first
page ScreenMan presents to the user and is where the user can select a record
from the file.
DDSPAGE Input
(Optional) The Page Number of the first page to
display to the user. If '$G(DDSPAGE), a page with a Page Number equal to 1
must exist on the form, and that is the first page ScreenMan presents to the
user.
DDSPARM Input
(Optional) A string of alphabetic characters that
control ScreenMan's behavior are listed below:

C Return the variable DDSCHANG=1 if ScreenMan detects that the user saved a
Change to the database.  E Return Error messages in ^TMP("DIERR",$J), and
return DIERR if ScreenMan encounters problems when initially trying to load
the form. If DDSPARM does not contain an "E", ScreenMan prints messages
directly on the screen, and returns the variable DIMSG equal to null.  S
Return the variable DDSSAVE=1 if the user pressed <PF1>S or <PF1>E, or entered
an "Exit" or "Save" command from the Command Line, whether or not any changes
were actually made on the form.
DDSFILE(1) Input
(Required) Contains the subfile number or the global
root of the subfile.
DA(1) ... DA(n) Input
The DA array, where DA is the subrecord number at the
deepest level and DA(n) is the record number at the top level.
DDSCHANG Output
$G(DDSCHANG)=1, if the DDSPARM input variable to ^DDS
contains a "C" and ScreenMan detects that the user saved a change to the
database.
DDSSAVE Output
$G(DDSSAVE)=1, if the DDSPARM input variable to ^DDS
contains an "S" and the user pressed <PF1>E or <PF1>S, or issued the "Save" or
"Exit" command from the Command Line.
DIMSG Output
$D(DIMSG)>0, if the form could not be loaded, and the
DDSPARM input variable to ^DDS does not contain an "E".
DTOUT Output
$D(DTOUT)>0, if the user times out during the editing
session.