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

$$MV^%ZISH(): Rename Host File

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

Description

The $$MV^%ZISH extrinsic function renames a Host file. The function performs the renaming, regardless of the underlying operating system, by first copying the file to the new name/location and then deleting the original file at the old name/location.

Format

  $$MV^%ZISH([path1,]filename1[,path2],filename2)

Input Parameters

path1:

(optional) Full path of the original file, up to but not including the filename. If NULL, it defaults to $$DEFDIR^%ZISH.
filename1:

(required) Name of the original file.
path2:

(optional) Full path of renamed file, up to but not including the filename. If NULL, it defaults to $$DEFDIR^%ZISH.
filename2:

(required) Name of the renamed file.

Output

returns:

Returns:

  • 1—Success.

  • 0—Failure.

 

Example

>S Y=$$MV^%ZISH("","TMP.DAT","","ZXG"_I_".DAT")