VA FileMan V. 22.0 Programmer Manual Banner


Main Chapter Getting Started Manual Advanced User Manual

Classic VA FileMan API

DO^DIC1: File Information Setup

This entry point retrieves a file's file header node, code to execute its identifiers and its screen (if any), and puts them into local variables for use during lookup into a file.

If $D(DO) is greater than zero, DO^DIC1 will QUIT immediately. If DIC("W") is defined before calling DO^DIC1, it will not be changed.

Input Variables
DIC The global root of the file, e.g., ^DIZ(16000.1,.
DIC(0) The lookup parameters as previously described for ^DIC.
Output Variables

File name^file number and specifiers. This is the file header node.

NOTE: Use the letter O, not the number zero, in this variable name.


File number and specifiers. This is the second ^piece of DO. +DO(2) will always equal the file number.


This is an executable variable which contains the write logic for identifiers. When an entry is displayed, the execution of this variable shows other information to help identify the entry. This variable is created by $ORDERing through the data dictionary ID level, for example:


NOTE: The specifier, I, must be in DO(2) for VA FileMan to even look at the ID-nodes.


An executable variable which contains a file's screen (if any). The screen is an IF-statement that can screen out certain entries in the file. This differs from DIC("S") in that it is used on every lookup regardless of input or output; that is, the screen is applied to inquiries and printouts as well as to lookups. The value for this variable comes from ^DD(+DO(2),0,"SCR") and the specifier "s"must be in DO(2).


Reviewed/Updated: March 8, 2007