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

SY^XTLKMGR(): Add Terms and Synonyms to the Local Synonym File

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

Description

The SY^XTLKMGR API adds Terms and Synonyms to the LOCAL SYNONYM (#8984.3) file.

Format

  SY^XTLKMGR(xtlk1,xtlk2,xtlk3)

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 Parameters

xtlk1:

(required) Associated file.
xtlk2:

(required) Term.
xtlk3:

(required) Synonym (or optional array for multiple synonyms per term).

NOTE: Use one-dimensional arrays wherever supported in ^XTLKMGR as in the following example:

     SYN(1)=<first synonym>
     SYN(2)=<second synonym>
     SYN(3)=<third synonym>
     >D SY^ROUTINE(XTLK1,XTLK2,.SYN)

 

Output Variables

XTLKER(1,FILENAME):

File not defined in the LOCAL LOOKUP (#8984.4) file.
XTLKER(2,TERM):

The term could not be added.
XTLKER(3,SYNONYM):

The synonym could not be added.