Print Page as PDF
Classic FileMan API: Data Display ICR (10004)

Classic FileMan API: Data Display    ICR (10004)

Name Value
NUMBER 10004
IA # 10004
DATE CREATED 1998/11/16
CUSTODIAL PACKAGE VA FILEMAN
CUSTODIAL ISC San Francisco
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE DIQ
NAME Classic FileMan API: Data Display
ORIGINAL NUMBER 10004
GENERAL DESCRIPTION
Provides ways to display data from file entries and
ways to convert data from one format to another.
STATUS Active
ID DIQ
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
DT
This call converts the date in Y exactly like D^DIQ.
Unlike D^DIQ, however, it also writes the date after it has been converted.
VARIABLES TYPE VARIABLES DESCRIPTION
Y Both
Input: (Required) Contains the internal date to be
converted. If this has five or six decimal places, seconds are automatically
returned.

Output: External form of the date or date/time value, e.g., JAN 01, 1998.
Y
This entry point converts the internal form of any
data element to its external form. It works for all FileMan data types, uses
output transforms, and follows pointer trails to their final resolution. The
equivalent Database Server call is $$EXTERNAL^DILFD (see DBIA #2055).
VARIABLES TYPE VARIABLES DESCRIPTION
Naked Global Reference Input
The naked global reference must be at the zero node
of the data dictionary definition which describes the data [i.e., it must be
at ^DD(File#,Field#,0)].
Y Both
Input: Set Y to the internal form of the value being
converted. This is the data that you want to convert to external form.

Output: The external form of the value. Basically, Y is changed from internal
to external.
C Input
Set C to the second piece of the zero node of the
data dictionary which defines that element.
EN
This entry point displays a range of data elements in
captioned format, to the current device.
VARIABLES TYPE VARIABLES DESCRIPTION
DIC Input
(Required) The global root of the file.
DA Input
(Required) If you are displaying an entry at the top
level of a file, set DA to the internal entry number of the file entry to
display.

If you are editing an entry in a subfile, set up DA as an array, where
DA=entry number in the subfile to display, DA(1) is the entry number at the
next higher file level,...DA(n) is the entry number at the file's top level.
DR Input
(Optional) Names the global subscript or subscripts
which are to be displayed by DIQ. If DR contains a colon (:), the range of
subscripts is understood to be specified by what precedes and follows the
colon.  Otherwise, DR is understood to be the literal name of the subscript.
All data fields stored within, and descendent from, the subscript(s) will be
displayed, even those which normally have read access security protection.
DIQ(0) Input
(Optional) You can include the following flags in
this variable to change the display of the entry:

C To display computed fields.  A To display audit records for the entry.  R To
display the entry's record number (IEN).
D
This entry point takes an internal date in the
variable Y and converts it to its external form. This call is very similar to
DD^%DT.
VARIABLES TYPE VARIABLES DESCRIPTION
Y Input
Both
Input: (Required) Contains the internal date to be
converted. If this has five or six decimal places, seconds are automatically
returned.

Output: External form of the date or date/time value, e.g., JAN 01, 1998.