You are here: Function Reference > Alphabetical Listing > A > AddDocusaveComment

AddDocusaveComment

Use this procedure to add a Docusave comment to the print stream. Docusave uses comments in the print stream as an archive key.

You should only call this procedure from a script loaded via the DocusaveScript specified in the AFP, Metacode, or PCL printer control group.

If you call this procedure from the GenData program, DAL will return an internal error.

Syntax

AddDocusaveComment (Comment, Convert)

Parameter

Description

Comment

Enter the string to be written as a comment in the print stream.

Convert

(Optional) Choose from these options:

0 - (zero) convert the string to EBCDIC

1 - convert the string to ASCII

2 - do not convert the string.

For Docusave, you will always want EBCDIC comments.

The default is zero (0).

Example

Here are some examples:

AddDocusaveComment('This is an example')

AddDocusaveComment(@('INSURED NAME',,, GROUPNAME()))

See also