Kernel APIs: $$DEL^%ZISH

$$DEL^%ZISH(): Delete Host File

Reference Type: Supported, Category: Host Files, ICR#: 2320

Description

The $$DEL^%ZISH extrinsic function deletes Host files. You can delete one or many Host files, depending on how you set up the array whose name you pass as the second input parameter.

Format

  $$DEL^%ZISH(path,arrname)

Input Parameters

path:

(required) Full path, up to but not including the filename.

arrname:

(required) Fully resolved array name containing the files to delete as subscripts at the next descendent subscript level. For example, to delete two files, FILE1.DAT and FILE2.DAT, set up the array as:

  ARRAY("FILE1.DAT")=""
  ARRAY("FILE2.DAT")=""

Pass the array name ARRAY as the arrname parameter. Wildcard specifications cannot be used with this function.

Output

returns:

Returns:

1—Success for all deletions.
0—Failure on at least one deletion.

Example

>K FILESPEC
>S FILESPEC("TMP.DAT")=""
>S Y=$$DEL^%ZISH("\MYDIR\",$NA(FILESPEC))