VA FileMan V. 22.0 Programmer Manual Banner


Main Chapter Getting Started Manual Advanced User Manual

Filegrams API

EN^DIFGG: Generator

The Filegram process consists of the following three components:

  1. Filegram generator (the DIFGG routines)

  2. Filegram installer (the DIFG routines)

  3. FILEGRAM template (stored in the PRINT template file)

You, as a programmer, will find that the only routines necessary to process a Filegram are the installer and the generator routines.

The key variables DUZ, DUZ(0), and DT must be present in addition to the required variables described below.

In order to create (or generate) a Filegram, D EN^DIFGG with the key variables just above and the required input variables listed below. DUZ should refer to a valid user. The optional input variables can be used to customize the Filegram.

Input Variables

(Required) This variable must equal the internal entry number in the PRINT template file of the FILEGRAM template that defines the data to be sent.


(Required) This variable must equal the internal number in the base file of the entry to be sent.


(Required) This variable must equal A, M, L, or D. The meanings of these codes, which indicate the mode of the Filegram, are:

A ADD (force an add)

(Optional) Set this variable equal to the root of the global or local array in which the Filegram will be built. The default is ^UTILITY("DIFG",$J, if this variable is not defined.


(Optional) One fewer than the first subscript to generate. Default=0.


(Optional) Initial indentation level for Filegram text.

Output Variables

This output variable is defined if an error has occurred. Its possible values are:

  • A required variable was not passed.

  • A variable's format is invalid.

  • A variable's content is invalid.


Reviewed/Updated: March 10, 2007