VA FileMan V. 22.2 Programmer Manual Banner

 

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

Database Server (DBS) API

$$GET1^DID(): Attribute Retriever

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

The $$GET1^DID extrinsic function retrieves a single attribute from a single file or field.

Format
$$GET1^DID(file[,field][,flags],attribute[,target-root][,msg-root])
Input Parameters
FILE

(Required) File number.

FIELD

(Optional with exceptions) Field number or name.

Required only when field attributes are being requested; otherwise, this function assumes a file attribute is being requested.
FLAGS

(Optional) Flag to control processing:
Z Zero nodes on word-processing attributes are included in the array subscripts.
ATTRIBUTE

(Required) A list of data dictionary attribute names separated by semicolons. Full attribute names must be used.

REF: For a list of file attributes that you can use, see FILE ATTRIBUTES.

For a list of the field attributes that you can use, see FIELD ATTRIBUTES.
TARGET-ROOT

(Optional with exceptions) Closed array reference where multi-lined attributes are returned.

Required only when multi-line values are returned, such as word-processing attributes like "DESCRIPTION".
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

A successful call returns the attribute requested. This can either be set into a variable or written to the output device.

Examples

Example 1

Figure 165: $$GET1^DID API—Example 1: Input and Output

    >S X=$$GET1^DID(999000,"","","DESCRIPTION","ARRAY","ERR") ZW @X
    ARRAY(1)=This is the description of the file (ZZZDLTEST).
    ARRAY(2)=And this is the second line of the description.

Example 2

Figure 166: $$GET1^DID API—Example 2: Input and Output

    >W $$GET1^DID(999000,"","","GLOBAL NAME")
    ^DIZ(999000,

Example 3

Figure 167: $$GET1^DID API—Example 3: Input and Output

    >W $$GET1^DID(999000,.01,"","LABEL")
    NAME

Example 4

Figure 168: $$GET1^DID API—Example 4: Input and Output

    >S X=$$GET1^DID(999000,.01,"Z","DESCRIPTION","ARRAY","ERR") ZW @X
    ARRAY(1,0)=This is the description of the .01 field
    ARRAY(2,0)=in file 999000.

    >W X
    ARRAY
Error Codes Returned

Table 52 lists the possible error codes returned with the $$GET1^DID API:

Table 52: $$GET1^DID API—Error Codes Returned

Code Description
200 Parameter is invalid or missing.
202 Specified parameter in missing or invalid.
505 Ambiguous field.
Details and Features
File/Field

This attribute retriever call differentiates whether the request is for a file or a field by the second parameter:

 

Reviewed/Updated: May 2026