VA FileMan V. 22.2 Programmer Manual Banner

 

Contents: Main Chapter See Also: Getting Started Manual Advanced User Manual

Database Server (DBS) API

DELIX^DDMOD(): Traditional Cross-Reference Delete

Reference Type Category ICR #
Supported Database Server (DBS) 2916
Description

The DELIX^DDMOD API deletes a traditional cross-reference definition from the data dictionary of a file. Optionally, it deletes the data in the index or executes the KILL logic for all entries in the file. Compiled INPUT templates that contain the field on which the cross-reference is defined are recompiled. If cross-references on the file are compiled, they are recompiled.

DELIX^DDMOD can be used in the pre-install or post-install routine of a Kernel Installation and Distribution System (KIDS) Build. For example, to delete a traditional cross-reference from the installing site.

REF: For information on the call to delete a New-Style index definition, see DELIXN^DDMOD.

Format
DELIX^DDMOD(file,field,cross_ref[,flags][,output_root][,msg_root])
Input Parameters
FILE (Required) File or subfile number.
FIELD (Required) Field number.
CROSS_REF

(Required) Cross-reference number. Traditional cross-references are defined in the data dictionary under ^DD(file#,field#,1,cross-reference number).
FLAGS

(Optional) Flags to control processing. The possible values are:
K

For Regular, KWIC, Mnemonic, and Soundex-type cross-references, delete the data in the index. For MUMPS and Trigger-type cross-references, execute the KILL logic of the cross-reference for all entries in the file. For Bulletin-type cross-references, the "K" flag is ignored; the KILL logic for Bulletin-type cross-references is never executed by this procedure.

W

WRITE messages to the current device as the index is deleted and cross-references and INPUT templates are recompiled.
OUTPUT_ROOT

(Optional) The name of the array that should receive information about INPUT templates and cross-references that may have been recompiled and a flag to indicate that the deletion was audited in the DD AUDIT (#.6) file.

REF: See the “Output Parameters” section.

This must be a closed root, either local or global.
MSG_ROOT (Optional) The name of the array that should receive any error messages. This must be a closed root, either local or global. If not passed, errors are returned descendent from ^TMP("DIERR",$J).
Output Parameters
OUTPUT_ROOT

See the OUTPUT_ROOT parameter under "Input Parameters."

If the field on which the deleted cross-reference was defined is used in any compiled INPUT templates, those INPUT templates are recompiled. Information about the recompiled INPUT templates is stored descendant from OUTPUT_ROOT("DIEZ"):

OUTPUT_ROOT("DIEZ",INPUT template #) =
INPUT template name ^ file # ^
compiled routine name

If cross-references for the file are compiled, they are recompiled, and the compiled routine name is stored in OUTPUT_ROOT("DIKZ"):

OUTPUT_ROOT("DIKZ") = compiled routine name

If the data dictionary for the file is audited, an entry is made in the DD AUDIT (#.6) file and OUTPUT_ROOT("DDAUD") is set to 1:

OUTPUT_ROOT("DDAUD") = 1
Examples

Example 1

In this example (Figure 114), regular cross-reference #4 (the "C" index), defined on Field #12 in (fictitious) File #16200, is deleted. The "K" flag indicates that the entire ^DIZ(16200,"C") index should be removed from the file.

Figure 114: DELIX^DDMOD API—Example 1: Input and Output

    >D DELIX^DDMOD(16200,12,4,"K","MYOUT")

    >ZW MYOUT

    MYOUT("DDAUD")=1
    MYOUT("DIEZ",100)=ZZTEST EDIT^16200^ZZIT
    MYOUT("DIKZ")=ZZCR

The MYOUT output array indicates that the deletion was recorded in the DD AUDIT (#.6) file. The INPUT template ZZTEST EDIT (#100) was recompiled into the ZZIT namespaced routines, because Field #12 is used in that template. Cross-references on (fictitious) File #16200 are recompiled under the ZZCR namespace.

Example 2

In this example (Figure 115), the whole-file regular cross-reference #7 (the "N" index), defined on Field #15 within Subfile #16200.075, is deleted:

Figure 115: DELIX^DDMOD API—Example 2: Input and Output

    >D DELIX(16200.075,15,7,"KW")

    Removing index ...
    Deleting cross-reference definition ...


    Compiling ZZ TEST CR Input Template of File 16200...
    'ZZIT1' ROUTINE FILED..
    'ZZIT' ROUTINE FILED....
    'ZZIT2' ROUTINE FILED.

    Compiling Cross-Reference(s) 16200 of File 16200.

    ...SORRY, HOLD ON...

    'ZZCR1' ROUTINE FILED.
    'ZZCR2' ROUTINE FILED.
    'ZZCR3' ROUTINE FILED.
    'ZZCR4' ROUTINE FILED.
    'ZZCR5' ROUTINE FILED.
    'ZZCR' ROUTINE FILED.
Error Codes Returned

Table 39 lists the possible error codes returned with the DELIX^DDMOD API.

Table 39: DELIX^DDMOD API—Error Codes Returned

Code Description
202 The specified parameter is missing or invalid.
301 The passed flags are incorrect.
401 The file does not exist.
406 The file has no .01 definition.
407 A word-processing field is not a file.
501 The file does not contain the specified field.

 

Reviewed/Updated: May 2026