Classic FileMan API: File Lookup/Add New Entries    ICR (10006)

(Required) The file number or an explicit global
root.

(Required) A string of alphabetic characters which
alter how DIC responds.  At a minimum this string must be set to null. A
detailed description of these characters can be found later in this section.

Flag Short Description : A Ask the entry; if erroneous, ask again.  B Lookup
only on "B" index of cross-referenced pointed-to files for a match to X. Note:
this flag is introduced with patch DI*21*29. C Cross reference suppression is
turned off.  E Echo back information. F Forget the lookup value. I Ignore the
special lookup program. L Learning a new entry is allowed. M Multiple-index
lookup allowed. N Internal Number lookup allowed (but not forced).  O Only
find one entry if it matches exactly.  Q Question erroneous input (with two
??).  S Suppresses display of .01 (except B cross reference match).  X EXact
match required. Z Zero node returned in Y(0) and external form in Y(0,0).

Input: If DIC(0) does not contain an A, then the
variable X must be defined equal to the value you want to lookup. If the value
in X has more than one match or partial match, the lookup fails and Y=-1 is
returned.

Output: Contains the value of the field where the match occurred.

(Optional) A prompt that is displayed prior to the
reading of the X input.

(Optional) The default answer which is presented to
the user when the lookup prompt is issued.

(Optional) DIC("S") is a string of MUMPS code that
DIC executes to screen an entry from selection. DIC("S") must contain an IF
statement to set the value of $T.

(Optional) A MUMPS command string which is executed
when DIC displays each of the entries that match the user's input.

When calling DIC with LAYGO allowed, you can specify
that a certain set of fields will be asked for in the case where the user
enters a new entry.

This variable is needed to successfully add the FIRST
subentry to a multiple when the descriptor (or header) node of the multiple
does not exist.

If the .01 field is a variable pointer, it can point
to entries in more than one file. You can restrict the user's ability to input
entries from certain files by using the DIC("V") variable.

(Optional) If this variable is set equal to the file
number, then the users will be able to add a new entry to the file whether or
not they have LAYGO access to the file.

(Optional) This input variable identifies the
subscript at which the data is to be stored.

DIC always returns the variable Y. The variable Y is
returned with one of these three formats:

Y=-1 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.

This variable is only set if DIC(0) contains a Z.
When the variable is set, it is equal to the entire zero node of the entry
that was selected.

This variable is also only set if DIC(0) contains a
Z. When the variable is set, it is equal to the external form of the .01 field
of the entry.

This is only defined if DIC has timed-out waiting for
input from the user.

This is only defined if the user entered an up-arrow.

The global root of the file.

The lookup parameters as previously described for
^DIC.

The cross reference in which to start looking. If
DIC(0) contains M, then DIC will continue with further cross references. If it
does not, then the lookup is only on the single cross reference.

If DIC(0) does not contain an A, then the variable X
must be defined equal to the value you want to lookup.

This set of input variables affects the behavior of
lookup as previously described for ^DIC.

This set of input variables affects the behavior of
lookup as previously described for ^DIC.

This set of input variables affects the behavior of
lookup as previously described for ^DIC.

This set of input variables affects the behavior of
lookup as previously described for ^DIC.

This set of input variables affects the behavior of
lookup as previously described for ^DIC.

This set of input variables affects the behavior of
lookup as previously described for ^DIC.

This set of input variables affects the behavior of
lookup as previously described for ^DIC.

DIC always returns the variable Y, which can be 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.

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.

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.

This is only defined if DIC has timed-out waiting for
input from the user.

This is only defined if the user entered an up-arrow.