VA FileMan Getting Started HTML Manual [skip navigation]

Contents: Main Chapter See Also: Getting Started Manual Advanced User Manual

Database Server (DBS) API

FIELD^DID( ): DD Field Retriever

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)
Input Parameters
FILE

(Required) File or subfile number.

FIELD

(Required) Field name or number.

FLAGS

(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 (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

    Alternatively, an "*" can be used in this Parameter to request ALL attributes.
TARGET_ROOT

(Required) The closed root of the array that should receive the attributes.

MSG_ROOT

(Optional) The name of a closed root reference that is used to pass error messages. If not passed, ^TMP("DIERR",$J) is used.

Output
TARGET_ROOT

The array is subscripted by the attribute names.

Example
    >D FIELD^DID(999000,.01,"","LABEL;TYPE","TEST1")

    >ZW TEST1
    TEST1("LABEL")=NAME
    TEST1("TYPE")=FREE TEXT
Error Codes Returned
200 There is an error in one of the variables passed.
202 Missing or invalid input parameter.
301 Flags passed are unknown or incorrect.
401 The specified file or subfile does not exist.
403 The file lacks a Header Node.
404 The file Header Node lacks a file #.
501 The field name or number does not exist.
505 The field name passed is ambiguous.
510 The data type for the specified field cannot be determined.
520 An incorrect kind of field is being processed.
537 Field has a corrupted pointer definition.


VA Home Page / OI Home Page / SD&D Home Page / IIS Site Map / Terms of Use / VA Privacy Policy

Reviewed/Updated: June 20, 2001

If you have questions, need more information, or are having accessibility problems with this website, please contact us by E-Mail: IIS Webmasters, Phone: 510-768-6800, or FAX: 510-768-6850.