Print Page as PDF
Data Base Server API: Misc. Data Libaray Functions ICR (2055)

Data Base Server API: Misc. Data Libaray Functions    ICR (2055)

Name Value
NUMBER 2055
IA # 2055
DATE CREATED 1997/07/02
CUSTODIAL PACKAGE VA FILEMAN
CUSTODIAL ISC San Francisco
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE DILFD
NAME Data Base Server API: Misc. Data Libaray Functions
GENERAL DESCRIPTION
Data libaray functions.

$$EXTERNAL: Converter to External $$FLDNUM: Field Number Retriever PRD:
Package Revision Data Initializer RECALL: Recall Record Number $$ROOT: File
Root Resolver $$VFIELD: Field Verifier $$VFILE: File Verifier
STATUS Active
ID DILFD
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$EXTERNAL()
This extrinsic function converts any internal value
to its external format.

Format $$EXTERNAL^DILFD(FILE,FIELD,FLAGS,INTERNAL,MSG_ROOT)
VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
(Required) The number of the file or subfile that
contains the field that describes the internal value passed in.
FIELD Input
(Required) The number of the field that describes the
internal value passed in.
FLAGS Input
(Optional) A single-character code that explains how
to handle output transforms found along pointer chains. F First. If the first
field in a pointer chain has an output transform, apply the transform to that
first field and quit. Ignore any other output transforms found along the
pointer chain. With the exception of this function, FileMan regularly handles
output transforms this way.  L Last. If the last field in a pointer chain has
an output transform, apply the transform to that last field and quit. Ignore
any other output transforms found along the pointer chain.  U Use. Use the
first output transform found on the last field in the pointer chain. Following
the pointer chain, watch for output transforms.  When one is found, remember
it, but keep following the pointer chain. When the last field in the chain is
reached, apply the remembered transform to that last field.
INTERNAL Input
(Required) The internal value that is to be converted
to its external format.
MSG_ROOT Both
(Optional) The array that should receive any error
messages. If the MSG_ROOT is not passed, errors are returned descendent from
^TMP("DIERR",$J).
$$FLDNUM()
This extrinsic function returns a field number when
passed a file number and a field name.

Format $$FLDNUM^DILFD(FILE,FIELDNAME)
VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
(Required) The file number of the field's file or
subfile.
FIELDNAME Input
(Required) The full name of the field for which you
want the number.
PRD()
This procedure sets the PACKAGE REVISION DATA
attribute for a file.

Format PRD^DILFD(FILE,DATA)
VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
(Required) File or subfile number.
DATA Input
(Required) Free text information, determined by the
developer.
RECALL()
This procedure saves a record number for later
retrieval using spacebar recall.

Format RECALL^DILFD(FILE,IENS,USER)
VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
(Required) The file or subfile number.
IENS Input
(Required) The IENS that identifies the record
selected.
USER Input
(Required) The user number (i.e., DUZ) of the user
who made the selection.
$$ROOT()
This extrinsic function resolves the file root when
passed file or subfile numbers.

Format $$ROOT^DILFD(FILE,IENS,FLAGS,ERROR_FLAG)
VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
(Required) File number or subfile number.
IENS Input
(Required when passing subfile numbers) Standard IENS
indicating internal entry number.
FLAGS Input
(Optional) If set to 1 (true), returns a closed root.
The default is to return an open root.
ERROR_FLAG Input
(Optional) If set to 1 (true), processes an error
message if error is encountered.
$$VFIELD()
This extrinsic function verifies that a field in a
specified file exists.

Format $$VFIELD^DILFD(FILE,FIELD)
VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
(Required) The number of the file or subfile in which
the field to be checked exists.
FIELD Input
(Required) The number of the field to be checked.
$$VFILE()
This extrinsic function verifies that a file exists.

Format $$VFILE^DILFD(FILE)
VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
(Required) The number of the file or subfile that you
want to check.