| FIELD() |
This procedure retrieves the values of the specified
field-level attributes for the specified field.
Format FIELD^DID(FILE,FIELD,FLAGS,ATTRIBUTES,TARGET_ROOT,MSG_ROOT)
|
| VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
FILE |
Input |
(Required) File or subfile number.
|
FIELD |
Input |
(Required) Field name or number.
|
FLAGS |
Input |
(Optional) Flags to control processing. The possible
values are:
N No entry in the target array is created if the attribute is null. Z Word
processing attributes include "0" nodes with text.
|
ATTRIBUTES |
Input |
(Required) A list of attribute names separated by
semicolons. Full attribute names must be used. Following are the attributes
that can be requested: AUDIT AUDIT CONDITION COMPUTE ALGORITHM COMPUTED FIELDS
USED DATE FIELD LAST EDITED DECIMAL DEFAULT DELETE ACCESS DESCRIPTION FIELD
LENGTH GLOBAL SUBSCRIPT LOCATION HELP-PROMPT INPUT TRANSFORM LABEL
MULTIPLE-VALUED OUTPUT TRANSFORM POINTER READ ACCESS SOURCE SPECIFIER
TECHNICAL DESCRIPTION TITLE TYPE WRITE ACCESS XECUTABLE HELP
|
TARGET_ROOT |
Both |
(Required) The closed root of the array that should
receive the attributes.
|
MSG_ROOT |
Both |
(Optional) The name of a closed root reference that
is used to pass error messages. If not passed, ^TMP("DIERR",$J) is used.
|
|
FIELDLST() |
This procedure returns a list of field-level
attributes that are supported by FileMan. It shows specifically which
attributes the Data Dictionary retriever calls can return.
Format FIELDLST^DID(TARGET_ROOT)
|
| VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
TARGET_ROOT |
Both |
(Required) The root of an output array.
Output TARGET_ROOT The descendants of the array root are subscripted by the
attribute names. "WP" nodes indicate that the attribute consists of a word
processing field.
|
|
FILE() |
This procedure retrieves the values of the file-level
attributes for the specified file. It does not return subfile attributes.
Format FILE^DID(FILE,FLAGS,ATTRIBUTES,TARGET_ROOT,MSG_ROOT)
|
| VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
FILE |
Input |
(Required) File number (but not subfile attributes).
|
FLAGS |
Input |
(Optional) Flags to control processing. The possible
values are:
N No entry in the target array is created if the attribute is null. Z Word
processing attributes include Zero (0) nodes with text.
|
ATTRIBUTES |
Input |
(Required) A list of attribute names separated by
semicolons. Full attribute names must be used:
ARCHIVE FILE AUDIT ACCESS DATE DD ACCESS DEL ACCESS DESCRIPTION DEVELOPER
DISTRIBUTION PACKAGE ENTRIES GLOBAL NAME LAYGO ACCESS LOOKUP PROGRAM NAME
PACKAGE REVISION DATA REQUIRED IDENTIFIERS RD ACCESS VERSION WR ACCESS
|
TARGET_ROOT |
Both |
(Required) The name of a closed array reference.
|
MSG_ROOT |
Both |
(Optional) The name of a closed root array reference
that is used to pass error messages. If not passed, messages are returned in
^TMP("DIERR",$J).
|
|
FILELST() |
DD File List Retriever
|
|
$$GET1() |
This extrinsic function retrieves a single attribute
from a single file or field.
Format $$GET1^DID(FILE,FIELD,FLAGS,ATTRIBUTE,TARGET_ROOT,MSG_ROOT)
|
| VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
FILE |
Input |
(Required) File number.
|
FIELD |
Input |
Field number or name. (Required only when field
attributes are being requested, otherwise this function assumes a file
attribute is being requested).
|
FLAGS |
Input |
(Optional) Flag to control processing:
Z Zero nodes on word processing attributes are included in the array
subscripts.
|
ATTRIBUTE |
Input |
(Required) Data dictionary attribute name.
|
TARGET-ROOT |
Both |
Closed array reference where multi-lined attributes
will be returned. (Required only when multi-line values are returned, such as
word processing attributes like "DESCRIPTION").
|
MSG-ROOT |
Both |
(Optional) The name of a closed root reference that
is used to pass error messages. If not passed, ^TMP("DIERR",$J) is used.
|
|