Difference between revisions of "VA FileMan DIC"

From VistApedia
Jump to: navigation, search
 
Line 11: Line 11:
 
* <mrou>DIC</mrou> : Starts with the B cross-reference, or uses only the B cross-reference [unless K is passed in DIC(0)].  
 
* <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>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.  
+
* <mentry>MIX^DIC1</mentry> : Uses the set of cross-references you specify.
 
 
=== File Information Setup ===
 
The <mentry>DO^DIC1</mentry> 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.
 
 
DICD
 
 
  [[WAIT^DICD]]
 
 
DICN
 
 
  FILE^DICN
 
  YN^DICN
 
 
DICQ
 
 
  DQ^DICQ
 
 
DICRW
 
 
  DT^DICRW
 

Revision as of 16:54, 7 March 2005

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 searche the requested Index(es) on a file and either finds a matching entry, adds an entry to the file, or returns 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.