Procedure Syntax

Requirements: Statements other than the PROC GDEVICE statement can be used only in a non-windowing or batch environment. In these environments, at least one statement is required to give GDEVICE an action to perform. In a windowing environment, only the PROC GDEVICE statement is required. In program mode, at least one additional statement is required, and you can submit as many of each statement as you want.

Note: You must have write access to the device catalog in order to modify, add, or delete entries.

Supports: Output Delivery System (ODS LISTING).

PROC GDEVICE <CATALOG=< libref .> SAS-catalog >

• <BROWSE>

• <NOFS>;

• ADD new-device-entry

  • required-parameters

  • < optional-parameters >;

• COPY device-entry

  • <FROM=< libref .> SAS-catalog >

  • <NEWNAME= new-device-entry >;

• DELETE device-entry ;

  FS ;

  LIST device-entry _ALL_ _NEXT_ _PREV_ DUMP>;

  MODIFY device-entry

  • parameter(s)

• QUIT END STOP ;

  RENAME device-entry NEWNAME= new-entry- name ;

PROC GDEVICE Statement

Starts the procedure and determines whether it runs in windowing mode or program mode. Optionally identifies a device catalog and determines how that catalog is opened.

PROC GDEVICE <CATALOG=< libref .> SAS-catalog >

• <BROWSE>

• <NOFS>;

Options

Options used in the PROC GDEVICE statement affect the way you use the procedure.

BROWSE

• opens a catalog in browse mode. You cannot modify a catalog when you open it with the BROWSE option. If you are running in program mode when you use BROWSE, you can use only the FS, LIST, QUIT, END, or STOP statements.

CATALOG=< libref .> SAS-catalog

CAT=< libref .> SAS-catalog

C=< libref .> SAS-catalog

• specifies the catalog containing device information. If you do not specify a catalog, the procedure opens the first catalog found in the search order of catalogs in browse mode. (See About the Current Catalog on page 916. for information on how the GDEVICE procedure determines which catalog to use.)

  To edit the device entries in a catalog, you must use the CATALOG= option.

NOFS

• specifies that you are using program mode. In windowing environments, the GDEVICE windows are the default and you must specify NOFS to start GDEVICE in program mode.

ADD Statement

Adds a new device entry to the catalog selected by the CATALOG= option in the PROC GDEVICE statement. The device entry is initialized with NULL values for most parameters.

Requirements: You must have write access to the device catalog in order to add entries, and use CATALOG= in the PROC GDEVICE statement.

Restriction: Not valid in browse mode.

ADD new-device-entry

• required-parameters

• < optional-parameters >;

• required-parameters are all of the following:

  • MODULE= driver-module

  • XMAX= width <IN CM>

  • YMAX= height <IN CM>

  • XPIXELS= width-in-pixels

  • YPIXELS= height-in-pixels

• plus one or both of the following parameter pairs:

  • LCOLS= landscape- columns

  • LROWS= landscape-rows

• or

  • PCOLS= portrait-columns

  • PROWS= portrait-rows

• optional-parameters can be one or more of the following:

  • ASPECT= scaling-factor

  • AUTOCOPY=Y N

  • AUTOFEED=Y N

  • CBACK= background- color

  • CELL =Y N

  • CHARACTERS =Y N

  • CHARREC=( charrec-list(s) )

  • CHARTYPE= hardware-font-chartype

  • CIRCLEARC=Y N

  • CMAP=( from-color : to-color < , from-color-n : to-color-n >)

  • COLORS=(< colors-list >)

  • COLORTYPE=NAME RGB HLS GRAY CMY CMYK HSV HSB

  • DASH=Y N

  • DASHLINE= dashed-line-hex-string X

  • DESCRIPTION= text-string

  • DEVMAP= device-map-name NONE

  • DEVOPTS= hardware-capabilities-hex-string X

  • DEVTYPE= device-type

  • DRVINIT1= system-command(s)

  • DRVINIT2= system-command(s)

  • DRVQRY NODRVQRY

  • DRVTERM1= system-command(s)

  • DRVTERM2= system-command(s)

  • ERASE=Y N

  • FILECLOSE=DRIVERTERM GRAPHEND

  • FILL=Y N

  • FILLINC=0 9999

  • FORMAT=CHARACTER BINARY

  • GACCESS= output-format output-format > destination

  • GCOPIES= current-copies

  • GEND= string < string-n >

  • GEPILOG= string < string-n >

  • GPROLOG= string < string-n >

  • GPROTOCOL= module-name

  • GSFLEN= record-length

  • GSFMODE=APPEND REPLACE PORT

  • SFNAME= fileref

  • GSIZE= lines

  • GSTART= string < string-n >

  • HANDSHAKE=HARDWARE NONE SOFTWARE XONXOFF

  • HEADER= command

  • HEADERFILE= fileref

  • ORIGIN= horizontal-offset <IN CM>

  • HOSTSPEC= text string

  • HSIZE= horizontal- size <IN CM>

  • ID= description

  • INTERACTIVE= USER GRAPH PROC

  • LFACTOR= line- thickness -factor

  • MAXCOLORS= number-of-colors

  • MAXPOLY= number-of-vertices

  • MODEL= model-number

  • NAK= negative-handshake-response X

  • PAPERFEED= feed-increment <IN CM>

  • PATH= angle-increment

  • PENSORT=Y N

  • PIEFILL=Y N

  • POLYGONFILL=Y N

  • POSTGRAPH1= system-command(s)

  • POSTGRAPH2= system-command(s)

  • PREGRAPH1= system-command(s)

  • PREGRAPH2= system-command(s)

  • PROCESS= command

  • PROCESSINPUT= fileref

  • PROCESSOUTPUT= fileref

  • PROMPT=0 7

  • PROMPTCHARS= prompt-chars-hex-string X

  • QMSG NOQMSG

  • RECTFILL= rectangle-fill-hex-string X

  • REPAINT= redraw -factor

  • ROTATE=LANDSCAPE PORTRAIT

  • ROTATION= angle-increment

  • SPEED= pen-speed

  • SWAP=Y N

  • SYMBOL=Y N

  • SYMBOLS= hardware-symbols-hex-string X

  • TRAILER= command

  • TRAILERFILE= fileref

  • TRANTAB= table

  • user-defined-table

  • TYPE= CAMERA CRT EXPORT PLOTTER PRINTER

  • UCC= control-characters-hex-string X

  • VORIGIN= vertical-offset <IN CM>

  • VSIZE= vertical-size <IN CM>

Required Arguments

new-device-entry

• specifies the one-level name of the new device entry. New-device-entry must be a valid name for a SAS catalog entry for your operating environment and cannot already exist in the current catalog.

required-parameters

• all required parameters for the ADD statement correspond to device parameters of the same name. Refer to Chapter 8, Graphics Options and Device Parameters Dictionary, on page 261 for a description of each parameter.

Options

All optional parameters for the ADD statement correspond to device parameters of the same name. Refer to Chapter 8, Graphics Options and Device Parameters Dictionary, on page 261 for a description of each parameter.

Note: The COLORS= device parameter is not required; the device entry will be created if you do not use it. However, the GDEVICE procedure issues an error message if you do not specify at least one color for COLORS=.

Details

The ADD statement is rarely used because it initializes parameter values to NULL and you have to set values for all the parameters. The best way to add a new driver is to copy an existing driver and modify it.

COPY Statement

Copies a device entry and places the copy in the current catalog. The original device entry can be either in the current catalog or in a different catalog.

Requirements: You must have write access to the catalog to which the device entry is being copied .

Restriction: Not valid in browse mode.

See also: Creating or Modifying Device Entries on page 934

Featured in: Example 1 on page 936

COPY device-entry where ;

• Where where must be one or both of the following:

  • FROM=< libref .> SAS-catalog

  • NEWNAME= new-device-entry

Required Arguments

device-entry

• specifies the one-level name of the device entry to copy. The entry must exist in either the current catalog (the default) or the catalog specified by FROM=.

FROM=< libref .> SAS-catalog

• names the catalog from which to copy device-entry .

NEWNAME= new-device-entry

• specifies a name for the copy of the device entry that is placed in the current catalog. New-device-entry must be a valid name for a SAS catalog entry and cannot already exist in the current catalog.

  If you copy device entries across catalogs and you do not specify a new name, the GDEVICE procedure uses the original name for the new device entry.

DELETE Statement

Deletes the device entry from the current catalog.

Requirements: You must have write access to the current catalog to delete a device entry from it, and use CATALOG= in the PROC GDEVICE statement.

Restriction: Not valid in browse mode.

Caution: A device entry cannot be restored once it has been deleted. Depending on the environment in which you are using the GDEVICE procedure, you may be asked to verify that you really want to delete the entry.

DELETE device-entry ;

Required Arguments

device-entry

• specifies the one-level name of device entry to delete. The entry must exist in the current catalog.

FS Statement

Switches from program mode to the GDEVICE windows.

Requirements: You must be running SAS software in a windowing environment.

FS ;

Options

No options.

LIST Statement

Lists all of the parameters of the specified device entry in the Output window.

Default: _ALL_

See also: Program Mode on page 918

LIST < device-entry >

• <_ALL_>

• <_NEXT_>

• <_PREV_>

• <DUMP>;

Options

device-entry

• specifies the one-level name of the device entry whose contents you want to list. The entry must exist in the current catalog.

_ALL_

• lists only the name, description, and creation date of all device entries in the current catalog. This is the default. If no entries exist in the catalog, the GDEVICE procedure issues a message.

_NEXT_

• lists the contents of the next device entry. The GDEVICE procedure lists the first entry in the catalog if no entries have been previously listed.

_PREV_

• lists the contents of the previous device entry. If you have not previously listed the contents of a device entry, the GDEVICE procedure issues the following message:

   No objects preceding current object. 

DUMP

• lists detailed information on all device entries in the current catalog. Depending on the number of device entries in the catalog, the DUMP option can create a large amount of output.

MODIFY Statement

Changes the values in a device entry.

Requirements: You must have write access to the current catalog to modify a device entry, and use CATALOG= in the PROC GDEVICE statement.

Restriction: Not valid in browse mode.

See also: Creating or Modifying Device Entries on page 934

Featured in: Example 1 on page 936

MODIFY device-entry

• parameter(s) ;

Required Arguments

device-entry

• specifies the one-level name of the device entry that you want to modify. The entry must exist in the current catalog.

parameter(s)

• are the parameters you want to modify. These can be any of the parameters listed in the ADD statement, whether listed as required or optional for ADD. See ADD Statement on page 921 for a complete list. Refer to Chapter 8, Graphics Options and Device Parameters Dictionary, on page 261 for a description of each parameter.

Details

To modify a device entry, create your own catalog and then copy the device entries you need into it. You can then change your personal copies of the device entries without affecting the original drivers in SASHELP.DEVICES. (To copy device entries, use the COPY statement, the COPY command available after you choose Import Device Entry from the DIRECTORY window's File menu, or the CATALOG procedure, which is part of base SAS.

CAUTION:

• Be careful when modifying device entries in program mode. In program mode, you cannot cancel any modifications you have just made. To change a value you have modified, you must use another MODIFY statement to replace the original value or reset it to its default. (In the GDEVICE windows, you can type the CANCEL command in the command line to cancel changes you have made to the fields.)

QUIT Statement

Saves all modifications made to device entries during the procedure and exits the GDEVICE procedure.

QUIT END STOP ;

Options

No options.

RENAME Statement

Changes the name of the device entry to the name specified in the statement.

Requirements: You must have write access to the current catalog to rename a device entry, and use CATALOG= in the PROC GDEVICE statement.

Restriction: Not valid in browse mode.

RENAME device-entry

• NEWNAME= new-entry-name ;

Required Arguments

device-entry

• specifies the one-level name of the device entry that you want to rename. The entry must exist in the current catalog.

NEWNAME= new-entry-name

• specifies the new entry name. New-entry-name must be a valid name for a SAS catalog entry and cannot already exist in the current catalog. If the name already exists, the GDEVICE procedure issues an error message.