Print Page as PDF
ScreenMan API: Form Utilities ICR (10149)

ScreenMan API: Form Utilities    ICR (10149)

Name Value
NUMBER 10149
IA # 10149
DATE CREATED 1994/06/24
CUSTODIAL PACKAGE VA FILEMAN
CUSTODIAL ISC San Francisco
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE DDSVAL
NAME ScreenMan API: Form Utilities
ORIGINAL NUMBER 10149
GENERAL DESCRIPTION
$$GET - This extrinsic function retrieves data from a
data dictionary field.  PUT - Stuffs data into form-only fields.
STATUS Active
ID DDSVAL
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$GET
This extrinsic function retrieves data from a data
dictionary field.

Text for a word processing field is moved into a global array, and
$$GET^DDSVAL returns the closed root of that array. The array has the same
format as a FileMan word processing field.

Computed fields in FileMan files cannot be retrieved. To retrieve the value of
a computed field defined on the form, use the $$GET^DDSVALF.

Format $$GET^DDSVAL(FILE,[.]RECORD,FIELD,.ERROR,FLAGS)
VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
(Required) The global root or number of the file or
subfile. At the field level, the local variable DIE contains the current
global root.
[.]RECORD Input
(Required) The internal entry number or an array of
internal entry numbers. This parameter has the same form as the DA array. At
the field level, the local array DA contains the current array of internal
entry numbers.
FIELD Input
(Required) The field name or number, or a relational
expression that follows a forward pointer (e.g., POINTER:FIELD).
.ERROR Input
(Optional) $D(ERROR)>1, if the function call fails.
FLAGS Input
(Optional) Controls whether the internal or external
form is returned, as shown below (the I and E flags have no effect if FIELD is
a word processing field):

I Return the Internal form of the data. (Default)  E Return the External form
of the data.
PUT
This procedure stuffs data into a data dictionary
field as part of ScreenMan's transaction. The data passed to this procedure is
filed in the database only when the user explicitly saves changes.

Format PUT^DDSVAL(FILE,[.]RECORD,FIELD,VALUE,.ERROR,FLAGS)
VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
(Required) The global root or number of the file or
subfile. At the field level, the local variable DIE contains the current
global root.
[.]RECORD Input
(Required) The internal entry number or an array of
internal entry numbers. This parameter has the same form as the DA array. At
the field level, the local array DA contains the current array of record
numbers.
FIELD Input
(Required) The field name or number.
VALUE Input
(Required) The value to stuff into the data
dictionary field. If FLAGS (described below) does not contain an "I", the
value must be in the form of a valid, unambiguous user response.

If FIELD is a word processing field, VALUE must be the closed root of the
array that contains the text. The subscripts of the nodes below the root must
be positive numbers, though they need not be integers, and there can be gaps
in the sequence. The text must be in these nodes or in the 0 node descendent
from these nodes.

If FIELD is a multiple field, VALUE determines the subrecord to display to the
user as a default for selection. It is not a value that is ever filed.  VALUE
can be "FIRST", "LAST", or the specific internal entry number of the subrecord
to display. "FIRST" indicates that the subrecord with the lowest internal
entry number should be displayed, and "LAST" indicates that the subrecord with
the highest internal entry number should be displayed.
.ERROR Input
(Optional) $D(ERROR)>1, if the procedure call fails.
FLAGS Input
Indicates whether VALUE is in internal or external
form, as shown below:

A Append new word processing text to the current text. This flag can be used
only when stuffing text into word a processing field. If the A flag is not
sent, the current word processing text is completely erased before the new
text is added.  I VALUE is in Internal form; it is not validated.  E VALUE is
in External form. (Default)  (Optional) The I and E flags have no effect when
FIELD is a word processing field.