Kernel Toolkit 7.3 APIs Banner
Office of Information and Technology (OIT) Banner
[skip navigation]

XTLKKWL^XTLKKWL: Perform Supported VA FileMan Calls on Files Configured for MTLU

Reference Type: Supported, Category: Toolkit—Multi-Term Look-Up (MTLU), ICR#: 10122

Description

The XTLKKWL^XTLKKWL API lets developers perform any supported VA FileMan calls on files configured for MTLU. To ignore the special lookup routine, XTLKDICL, be sure that DIC(0) includes an I. Alternatively, multi-term lookups can be performed on any VA FileMan file, even if it has not been configured for primary use by MTLU. Using the API, the lookup can be performed using any index contained within the file, such as a VA FileMan Key Word In Context (KWIC) cross-reference.

Format

  XTLKKWL^XTLKKWL

Make sure to perform the following steps before calling this API:

  1. NEW all non-namespaced variables.

  2. Set all input variables.

  3. Call the API.

Input Variables

(XTLKGBL, XTLKKSCH(“GBL”)):

(required) This is the global root (same as DIC).
XTLKKSCH(“DSPLY”):

(required) This variable displays the routine. For example:

     DGEN^XTLKKWLD
XTLKKSCH(“INDEX”):

(required) Cross-reference selected by the developer for performing a MTLU.
XTLKX:

(required) This is the user input.
XTLKSAY:

(optional) XTLKSAY values:

  • 1—MTLU displays details during the lookup.

  • 0.

NOTE: The purpose of XTLKSAY variable is to control the degree of output to the screen, not the amount of “file information” displayed.
XTLKHLP:

(optional) XTLKHLP=Executable code to display custom help.