VA FileMan DIC: Difference between revisions

From VistApedia
Jump to navigationJump to search
No edit summary
 
NeilArmstrong (talk | contribs)
1,798 edits
Added a glossary link to file
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
The '''VA FileMan ^DIC''' [[API]], is used to find an entry in a FileMan File.
The '''VA FileMan ^DIC''' [[API]], is used to find an entry in a FileMan [[File~|file]].


there are several main entry points:
there are several main entry points:
Line 5: Line 5:
These routines use local variables in the symbol table as the parameter passing style.
These routines use local variables in the symbol table as the parameter passing style.
=== Lookup/Add ===
=== 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.
Given a lookup value, these entry points search the requested Index(es) on a [[file~|file]] and either  
# find a matching entry,  
# add an entry to the [[file!|file]], or  
# 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:
There are three APIs to lookup an entry in a [[file~|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)].  
* <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

Latest revision as of 17:43, 10 June 2013

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.
Retrieved from "https://vistapedia.com/index.php?title=VA_FileMan_DIC&oldid=15776"