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

DELCOMP^XLFNAME2(): Delete Name Components Entry

Reference Type: Controlled Subscription, Category: Name Standardization, ICR#: 3066

Description

The DELCOMP^XLFNAME2 API deletes an entry in the NAME COMPONENTS (#20) file, and optionally, the value of the pointer in the source file that points to the name components entry.

NOTE: The DELCOMP^XLFNAME2 API is designed to be used in the KILL logic for the MUMPS cross-reference mentioned previously in the UPDCOMP^XLFNAME2(): Update Name Components Entry API.

Format

  DELCOMP^XLFNAME2(file,[.]record,field[,ptrfield])

Input Parameters

file:

(required) The number of the file or subfile (the "source file") that contains the name.
[.]record:

(required) The IENS or the Internal Entry Number array (that looks like the DA array) of the record in the source file that contains the name.
field:

(required) The number of the field in the source file that contains the name.
ptrfield:

(optional) The number of the POINTER field in the source file that points to the NAME COMPONENTS (#20) file. Only if this parameter is passed is the value of this POINTER field deleted.

Output

none.

Deletes record.

Example

Suppose that you have a NAME COMPONENTS (#20) file entry that contains the components of a name stored in File #1000, Record #132, Field #.01. The POINTER Field #1.1 of that File #1000 is a pointer to the NAME COMPONENTS (#20) file. To delete the entry in the NAME COMPONENTS (#20) file, and the value of the POINTER field, you can do the following:

>D DELCOMP^XLFNAME(1000,132,.01,1.1)