VA FileMan DIC

From VistApedia
Revision as of 17:43, 10 June 2013 by NeilArmstrong (talk | contribs) (Added a glossary link to file)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

The VA FileMan ^DIC API, is used to find an entry in a FileMan file.

there are several main entry points:

Classic FileMan

These routines use local variables in the symbol table as the parameter passing style.

Lookup/Add

Given a lookup value, these entry points search the requested Index(es) on a file and either

  1. find a matching entry,
  2. add an entry to the file, or
  3. return a condition indicating that the lookup was unsuccessful.

There are three APIs to lookup an entry in a file, they only differ in the way they use cross-references to do lookup. The three entry points perform lookups as follows:

  • <mrou>DIC</mrou> : Starts with the B cross-reference, or uses only the B cross-reference [unless K is passed in DIC(0)].
  • <mentry>IX^DIC</mentry> : Starts with the cross-reference you specify, or uses only the cross-reference you specify.
  • <mentry>MIX^DIC1</mentry> : Uses the set of cross-references you specify.