VA FileMan V. 22.2 Programmer Manual Banner

 

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

Database Server (DBS) API

FILE^DID(): DD File Retriever

Reference Type Category ICR #
Supported Database Server (DBS) 2052
Description

The FILE^DID API 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])
Input Parameters
FILE

(Required) File number (but not subfile attributes).

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:

  • 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

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

(Required) The name of a closed array reference.

MSG_ROOT

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

Output Parameter
TARGET_ROOT

The array is subscripted by the attribute names. Some attributes can have multiple sub-attributes, and these are further subscripted with a sequence number and the sub-attribute name. Attributes that contain word-processing text also have a sequence number for each line of text.
Example

Figure 163: FILE^DID API—Example: Input and Output

    >D FILE^DID(999000,"","NAME;GLOBAL NAME;REQUIRED IDENTIFIERS","TEST")

    >ZW TEST
    TEST("GLOBAL NAME")=^DIZ(999000,
    TEST("NAME")=ZZZDLTEST
    TEST("REQUIRED IDENTIFIERS")=TEST("REQUIRED IDENTIFIERS")
    TEST("REQUIRED IDENTIFIERS",1,"FIELD")=.01
    TEST("REQUIRED IDENTIFIERS",2,"FIELD")=1
Error Codes Returned

Table 51 lists the possible error codes returned with the FILE^DID API:

Table 51: FILE^DID API—Error Codes Returned

Code Description
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.

 

Reviewed/Updated: May 2026