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

DELCOMP^XLFNAME2(): Delete Name Components Entry

Reference Type: Controlled Subscription, Category: Name Standardization, Integration Agreement: 3066

Description

This API deletes an entry in the NAME COMPONENTS file, and optionally, the value of the pointer in the source file that points to the name components entry.

NOTE: This 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 file (#20). Only if this parameter is passed will the value of this pointer field be deleted.

Output

none

Deletes record.

Example

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

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

 


VA (Internet) / VA(Intranet) / OI / PD / Site Map / Terms of Use / VA Privacy Policy / Accessibility

Reviewed/Updated: August 26, 2011

If you have questions, need more information, or are having accessibility problems with this website, please contact us by E-Mail: Webmasters, Phone: 510-768-6800, or FAX: 510-768-6850.