ZREMOVE

Without an Argument

ZREMOVE without an argument erases the entire current routine. The following Terminal session shows this operation:

USER>DO ^myroutine

USER>ZLOAD myroutine

USER>WRITE $ZNAME
myroutine
USER>ZREMOVE

USER>WRITE $ZNAME

USER>

With Arguments

ZREMOVE with arguments erases code lines in the current routine. ZREMOVE lineref1 erases the specified line. ZREMOVE lineref1:lineref2 erases the range for lines starting with the first line reference and ending with the second line reference, inclusive.

The following Terminal session shows this operation. This example uses a dummy routine (^myroutine) in which each line sets a variable to a string naming that line:

USER>DO ^myroutine

USER>ZLOAD myroutine

USER>PRINT +8
SET x="this is line 8"
USER>ZREMOVE +8

USER>PRINT +8
SET x="this is line 9"
USER>

pc

An optional postconditional expression. Caché executes the command if the postconditional expression is true (evaluates to a nonzero numeric value). Caché does not execute the command if the postconditional expression is false (evaluates to zero). For further details, refer to Command Postconditional Expressions in Using Caché ObjectScript.

lineref1

The line to be removed, or the first in a range of lines to be removed. It can take any of the following formats:

A label may be longer than 31 characters, but must be unique within the first 31 characters. ZREMOVE matches only the first 31 characters of a specified label. Label names are case-sensitive, and may contain Unicode characters.

You can use lineref1 to specify a single line of code to remove. You specify the code line either as an offset from the beginning of the routine (+lineref1) or as an offset from a specified label (module2+lineref1).

• ZREMOVE +7: removes the 7th line counting from the beginning of the routine.

• ZREMOVE +0: performs no operation, generates no error.

• ZREMOVE +999: if 999 is greater than the number of lines in the routine, performs no operation, generates no error.

• ZREMOVE Test1: removes the label line Test1.

• ZREMOVE Test1+0: removes the label line Test1.

• ZREMOVE Test1+1: removes the first line following label line Test1.

• ZREMOVE Test1+999: removes the 999th line following label line Test1. This line may be in another labeled module. If 999 is greater than the number of lines from label Test1 to the end of the routine, performs no operation, generates no error.

Labels are counted as code lines in a line offset. Whitespace lines are not counted as code lines in line offset. Comments are not counted as code lines in a line offset, with one exception. A single-line comment delimited by ;; is counted as a code line for the purposes of line offset.

lineref2

The last line in a range of lines to be removed. Specify lineref2 in any of the formats used for lineref1. The colon prefix (:) is mandatory.

You specify a range of lines as +lineref1:+lineref2. ZREMOVE removes the range of lines, inclusive of lineref1 and lineref2. If lineref1 and lineref2 refer to the same line, ZREMOVE removes a that single line.

If lineref2 appears earlier in the routine code than lineref1, no operation is performed and no error is generated. For example: ZREMOVE +7:+2, ZREMOVE Test1+1:Test1, ZREMOVE Test2:Test1 would perform no operation.