Print Page as PDF
Classic FileMan API: Custom Lookup & File Info. Setup ICR (10007)

Classic FileMan API: Custom Lookup & File Info. Setup    ICR (10007)

Name Value
NUMBER 10007
IA # 10007
DATE CREATED 1998/11/18
CUSTODIAL PACKAGE VA FILEMAN
CUSTODIAL ISC San Francisco
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE DIC1
NAME Classic FileMan API: Custom Lookup & File Info. Setup
ORIGINAL NUMBER 10007
GENERAL DESCRIPTION 
Entry point DO sets up certain file information.  Entry
point MIX does multi-index nonstandard order lookup.
STATUS Active
ID DIC1
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
DO 
Retrieve's 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.
VARIABLES TYPE VARIABLES DESCRIPTION
DIC Input 
The global root of the file.
DIC(0) Input 
The lookup parameters as previously described for
^DIC (see DBIA #10006).
DO Output 
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.
DO(2) Output 
File number and specifiers. This is the second ^piece
of DO. +DO(2) will always equal the file number.
DIC("W") Output 
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.
DO("SCR") Output 
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 lookups. The value for this variable comes from
^DD(+DO(2),0,"SCR") and the specifier "s" must be in DO(2).
MIX 
This entry point is similar to ^DIC and IX^DIC (see
DBIA #10006) except on how it uses cross-references to do lookup.
VARIABLES TYPE VARIABLES DESCRIPTION
DIC Input 
The global root of the file.
DIC(0) Input 
The lookup parameters as previously described for
^DIC (see DBIA #10006).
D Input 
The list of cross references, separated by up-arrows,
to be searched, e.g., D="SSN^WARD^B". This variable is killed by VA FileMan;
it is undefined when the MIX^DIC1 call is complete.

Make sure DIC(0) contains M; otherwise, only the first cross reference in D
will be used for the lookup.
X Input 
If DIC(0) does not contain an A, then the variable X
must be defined equal to the value you want to look up.
DIC("A") Input 
This set of input variables affects the behavior of
lookup as previously described for ^DIC (see DBIA #10006).
DIC("B") Input 
This set of input variables affects the behavior of
lookup as previously described for ^DIC (see DBIA #10006).
DIC("DR") Input 
This set of input variables affects the behavior of
lookup as previously described for ^DIC (see DBIA #10006).
DUC('
DIC("P") Input 
This set of input variables affects the behavior of
lookup as previously described for ^DIC (see DBIA #10006).
DIC("S") Input 
This set of input variables affects the behavior of
lookup as previously described for ^DIC (see DBIA #10006).
DIC("V") Input 
This set of input variables affects the behavior of
lookup as previously described for ^DIC (see DBIA #10006).
DIC("W") Input 
This set of input variables affects the behavior of
lookup as previously described for ^DIC (see DBIA #10006).
Y Output 
DIC always returns the variable Y in one of the three
following formats:

Y=-1 Indicates the lookup was unsuccessful.

Y=N^S N is the Internal Number of the entry in the file and S is the value of
the .01 field for that entry.

Y=N^S^1 N and S are defined as above and the 1 indicates that this entry has
just been added to the file.
Y(0) Output 
This variable is only set if DIC(0) contains a Z.
When it is set, it is equal to the entire zero node of the entry that was
selected.
Y(0,0) Output 
This variable is also only set if DIC(0) contains a
Z. When it is set, it is equal to the external form of the .01 field of the
entry.
DTOUT Output 
This is only defined if DIC has timed-out waiting for
input from the user.
DUOUT Output 
This is only defined if the user entered an up-arrow.