Print Page as PDF
Data Base Server API: Data Retriever Utilities ICR (2056)

Data Base Server API: Data Retriever Utilities    ICR (2056)

Name Value
NUMBER 2056
IA # 2056
DATE CREATED 1997/07/02
CUSTODIAL PACKAGE VA FILEMAN
CUSTODIAL ISC San Francisco
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE DIQ
NAME Data Base Server API: Data Retriever Utilities
GENERAL DESCRIPTION
Data retriever utilities.

$$GET1: Single Data Retriever GETS: Multiple Data Retriever
STATUS Active
ID DIQ
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$GET1()
This procedure retrieves one or more fields of data
from a record or sub-record(s) and places the values in a target array.

Format GETS^DIQ(FILE,IENS,FIELD,FLAGS,TARGET_ROOT,MSG_ROOT)
VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
(Required) File or subfile number.
IENS Input
(Required) Standard IENS indicating internal entry
numbers.
FIELD Input
(Required) Can be one of the following:

A single field number A list of field numbers, separated by semicolons A range
of field numbers, in the form M:N, where M and N are the end points of the
inclusive range. All field numbers within this range are retrieved. * for all
fields at the top level (no sub-multiple record). ** for all fields including
all fields and data in sub-multiple fields. Field number of a multiple
followed by an * to indicate all fields and records in the sub-multiple for
that field.
FLAGS Input
(Optional) Flags to control processing. The possible
values are:

E Returns External values in nodes ending with "E".  I Returns Internal values
in nodes ending with "I". (Otherwise, external is returned).  N Does not
return Null values.  R Resolves field numbers to field names in target array
subscripts.  Z Word processing fields include Zero nodes.
TARGET_ROOT Both
(Required) The name of a closed root reference.

Output: The output array is in the FDA format, i.e.,
TARGET_ROOT(FILE,IENS,FIELD)=DATA. WP fields have data descendent from the
field nodes in the output array.
MSG_ROOT Both
(Optional) The name of a closed root reference that
is used to pass error messages.
GETS()
This procedure retrieves one or more fields of data
from a record or sub-record(s) and places the values in a target array.

Format GETS^DIQ(FILE,IENS,FIELD,FLAGS,TARGET_ROOT,MSG_ROOT)
VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
(Required) File or subfile number.
IENS Input
(Required) Standard IENS indicating internal entry
numbers.
FIELD Input
(Required) Can be one of the following:

A single field number A list of field numbers, separated by semicolons A range
of field numbers, in the form M:N, where M and N are the end points of the
inclusive range. All field numbers within this range are retrieved. * for all
fields at the top level (no sub-multiple record). ** for all fields including
all fields and data in sub-multiple fields. Field number of a multiple
followed by an * to indicate all fields and records in the sub-multiple for
that field.
FLAGS Input
(Optional) Flags to control processing. The possible
values are:

E Returns External values in nodes ending with "E".  I Returns Internal values
in nodes ending with "I". (Otherwise, external is returned).  N Does not
return Null values.  R Resolves field numbers to field names in target array
subscripts.  Z Word processing fields include Zero nodes.
TARGET_ROOT Both
(Required) The name of a closed root reference.

Output: The output array is in the FDA format, i.e.,
TARGET_ROOT(FILE,IENS,FIELD)=DATA. WP fields have data descendent from the
field nodes in the output array.
MSG_ROOT Both
(Optional) The name of a closed root reference that
is used to pass error messages.