ScreenMan API: Form Utilities ICR (2610)

Name

Value

NUMBER

2610

IA #

2610

DATE CREATED

1998/10/14

CUSTODIAL PACKAGE

VA FILEMAN

CUSTODIAL ISC

San Francisco

USAGE

Supported

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

DDSVALF

NAME

ScreenMan API: Form Utilities

GENERAL DESCRIPTION

$$GET() - This extrinsic function retrieves data from a
form-only field or a computed field.  PUT() - This procedure stuffs data into
a form-only field.

STATUS

Active

DDSVALF

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

$$GET()

This extrinsic function retrieves data from a
form-only field or a computed field.

Format $$GET^DDSVALF(FIELD,BLOCK,PAGE,FLAGS,IENS)

VARIABLES	TYPE	VARIABLES DESCRIPTION
FIELD	Input	(Required) The Field Order number, Caption, or Unique Name of the form-only field.
BLOCK	Input	(Required at the page and form levels) The Block Order or Block Name. The default is the current block.
PAGE	Input	(Required at the form level) The Page Number or Page Name. The default is the current page.
FLAGS	Input	(Optional) Controls whether the internal or external form is returned, as shown below: I Return the Internal form of the data. (Default) E Return the External form of the data.
IENS	Input	(Required at the page and form levels) The standard IENS that identifies the entry or subentry associated with the form-only field. The default is the current entry or subentry.

PUT()

This procedure stuffs data into a form-only field.

Format PUT^DDSVALF(FIELD,BLOCK,PAGE,VALUE,FLAGS,IENS)

VARIABLES	TYPE	VARIABLES DESCRIPTION
FIELD	Input	(Required) The Field Order number, Caption, or Unique Name of the form-only field.
BLOCK	Input	(Required at the page and form levels) The Block Order or Block Name. The default is the current block.
PAGE	Input	(Required at the form level) The Page Number or Page Name. The default is the current page.
VALUE	Input	(Required) The value to stuff into the form-only field. If FLAGS (described below) does not contain an "I", the value must be in the form of a valid, unambiguous user response.
FLAGS	Input	(Optional) Indicates whether VALUE is in internal or external form, as shown below: I VALUE is in Internal form; it is not validated. E VALUE is in External form (default).
IENS	Input	(Required at the page and form levels) The standard IENS that identifies the entry or subentry associated with the form-only field. The default is the current entry or subentry.