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

$$GATF^%ZISH(): Copy Global to Host File

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

Description

The $$GATF^%ZISH extrinsic function is used in the same way as the $$GTF^%ZISH API. The one difference is that if the file already exists, $$GATF^%ZISH appends global nodes to the existing file rather than truncating the existing file first.

REF: For more information, see the $$GTF^%ZISH API API description.

Format

  $$GATF^%ZISH(global_ref,inc_subscr,path,filename)

Input Parameters

global_ref:

(required) Global to READ lines from, fully resolved in closed root form.
inc_subscr:

(required) Identifies the incrementing subscript level. For example, if you pass ^TMP(115,1,1,0) as the global_ref parameter, and pass 3 as the inc_subscr parameter, $$GATF^%ZISH increments the third subscript [e.g., ^TMP(115,1,)], but READs nodes at the full global reference
[e.g., ^TMP(115,1,x,0)].
path:

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

(required) Name of the file to open.

Output

returns:

Returns:

  • 1—Success.

  • 0—Failure.