Difference between revisions of "VA FileMan DIC"
From VistApedia
(Added a glossary link to file) |
|||
| (One intermediate revision 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 | + | 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. | ||
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
- find a matching entry,
- add an entry to the 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:
- <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.
