Skip to main content

This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Previous sectionNext section

GETPTR

Returns print channel details.

Synopsis

GETPTR(channel)

Arguments

channel An expression that resolves to an integer specifying an existing print channel. Valid values are 0 through 255.

Description

The GETPTR function returns a string consisting of a comma-separated list of channel settings. These are the same settings defined using the SETPTR command, as described in The Caché MultiValue Spooler.

The channel can be specified as an integer from 0 through 255 (inclusive). Integers outside this range return the empty string. Fractional values are truncated to the integer portion. If channel is the empty string ("") or a non-numeric value, GETPTR returns channel settings for Channel 0.

Example

The following example uses the GETPTR function to return the channel settings for channel 1:

PRINT GETPTR(1)
Copy code to clipboard

It returns a string such as the following: 0,132,66,3,3,1, EJECT. For an explanation of these values, refer to SETPTR in The Caché MultiValue Spooler.

See Also