Chapter Contents

Previous

Next
SAS Component Language: Reference

SCL Language Elements by Category

SCL Elements by Category
Category Element Name Description
Array ASORT
Sorts an array

COMPAREARRAY
Allows you to compare two arrays for size and data equality

COPYARRAY
Allows you to copy data from one array into another array

DELARRAY
Deletes a dynamic array

MAKEARRAY
Creates an array of the given size with all elements in the array initialized to missing for numerics or blank for characters

REDIM
Resizes a dynamic array
Catalog CATLIST
Displays a host selector window that lists entries in a SAS catalog, and returns user selections

CATNAME
Defines a concatenated catalog, which contains a logical combination of the entries in two or more catalogs

CEXIST
Verifies the existence of a SAS catalog or SAS catalog entry

CONTENTS
Displays the attributes of a SAS Table

IMPORT
Defines a search path for references to CLASS entries

SEARCH
Creates or manipulates the current catalog search path

SEARCHPATH
Reports the complete pathname of a SAS catalog entry
Character CENTER
Returns a centered character string

LEFT
Returns a left-aligned character string

LENGTH
Returns the length of a trimmed character string

MLENGTH
Returns the maximum length of a variable

RIGHT
Returns a right-aligned character value
Command EXECCMD
Executes one or more commands when control returns to the application

EXECCMDI
Executes one or more global commands immediately before processing the next statement, or executes one non-global command when control returns to the application

LASTCMD
Returns the text of the last command that was issued from the application window

LOOKUPC
Searches for a string among a list of valid tokens

NEXTCMD
Discards the current command on the command line

NEXTWORD
Deletes the current word and advances to the next word in the current command

SYSTEM
Issues a host system command

WORD
Returns a word from a command that was issued with the command line, function keys, command processing, or a control

WORDTYPE
Identifies the word type of a word on the command line
Control Flow CATCH
Processes an exception that has been thrown with the THROW statement

CONTINUE
Stops processing the current DO loop and resumes with the next iteration of that DO loop

CONTROL
Controls the execution of labeled program sections and the formatting of submit blocks

DO
Designates a group of statements to be executed as a unit

ENDCATCH
Ends a CATCH statement block

GOTO
Branches immediately to another entry

LEAVE
Stops processing the current DO group and resumes with the next statement in sequence

RETURN
Stops executing statements in the program section that is currently executing and may return a value to the caller

RUN
Stops executing statements in the program section that is currently executing

SELECT
Executes one of several statements or groups of statements

STOP
Stops executing statements in the program section that is currently executing

THROW
Raises an exception

WAIT
Suspends execution of the next program statement
Control or Field ACTIVATE
Activates or grays either a Version 6 check box or radio box widget, or a station in a choice group

CLRFLD
Clears the value from variables whose values match a specified value

DISPLAYED
Reports whether a control or field is currently visible

ERROR
Reports whether a FRAME entry control or field contains an invalid value

ERROROFF
Clears the error flag on one or more FRAME entry controls or fields

ERRORON
Sets the error flag for one or more FRAME entry controls or fields

GRAY
Grays FRAME entry controls and stations of a choice group

HOME
Positions the cursor on a window's command area

ISACTIVE
Returns the number of the active button in a radio box or check box or the active station in a choice group

ISGRAY
Reports whether a FRAME entry control or choice group is grayed

MODIFIED
Reports whether a field or FRAME entry control has been modified

PROTECT
Assigns protection to a FRAME entry control or field

SETCR
Controls the cursor's response to the carriage-return key

SETFLD
Assigns a value to up to ten blank variables

UNGRAY
Ungrays a window element

UNPROTECT
Removes protection from a FRAME entry control or a field
Cursor CURFLD
Returns the name of the FRAME or PROGRAM entry control or field on which the cursor is currently positioned
Declarative Statement ARRAY
Defines elements of an explicit array

DECLARE
Declares variables and specifies their data types

LENGTH
Declares variables and specifies their length and whether their data type is numeric or character
Directory DCLOSE
Closes a directory

DINFO
Returns information about a directory

DNUM
Returns the number of members in a directory

DOPEN
Opens a directory

DOPTNAME
Returns the name of a directory attribute

DOPTNUM
Returns the number of information items that are available for a directory

DREAD
Returns the name of a directory member

MOPEN
Opens a member file in a directory
Extended Table CURTOP
Returns the number of the row that is currently displayed at the top of an extended table

ENDTABLE
Stops the processing of the getrow section of a dynamic extended table

ISSEL
Returns the selection number for a specified row of a selection list

NSELECT
Returns the number of rows that have been selected in a selection list

SELECT
Selects a specified row of a selection list

SELECTED
Returns the number of the row that corresponds to a user's choice in a selection list

SETROW
Determines the characteristics of extended tables

TOPROW
Scrolls a row to the top of an extended table

UNSELECT
Deselects a specified row of a selection list
External File DCREATE
Creates an external directory

FAPPEND
Appends the current record to the end of an external file

FCLOSE
Closes an external file, a directory, or a directory member

FCOL
Returns the current column position from the File Data Buffer (FDB)

FDELETE
Deletes an external file

FEXIST
Verifies the existence of the external file that is associated with the specified fileref

FGET
Copies data from the File Data Buffer (FDB)

FILEDIALOG
Displays a selection window that lists external files

FILEEXIST
Verifies the existence of an external file, a directory, or a SAS data library by its physical name

FILENAME
Assigns or deassigns a fileref for an external file, a directory, an output device, or a catalog entry

FILEREF
Verifies that a fileref has been assigned for the current SAS session or process

FINFO
Returns a file information item

FNOTE
Identifies the last record that was read

FOPEN
Opens an external file

FOPTNAME
Returns the name of an item of information for a file

FOPTNUM
Returns the number of information items that are available for an external file

FPOINT
Positions the "read" pointer on the next record to be read

FPOS
Sets the position of the column pointer in the File Data Buffer

FPUT
Moves data to the File Data Buffer (FDB) for an external file, starting at the FDB's current column position

FREAD
Reads a record from an external file into the File Data Buffer (FDB)

FREWIND
Positions the file pointer at the beginning of the file

FRLEN
Returns the size of the last record read, or, if the file is opened for output, returns the current record size

FSEP
Sets the token delimiters for the FGET function

FSLIST
Displays an external file for browsing

FWRITE
Writes a record to an external file

PATHNAME
Returns the physical name of a SAS data library or an external file
Formatting FORMAT
Verifies that the specified format is valid

INFORMAT
Verifies that the specified informat is valid

INPUTC and INPUTN
Read a character value using an informat

PUTC and PUTN
Return a formatted value, using the specified format
Image IMGCTRL
Performs control operations on the Image window

IMGINIT
Starts an image task

IMGOP
Performs image operations

IMGTERM
Terminates an image task

LNAMECHK
Validates a path string

LNAMEGET
Decodes a path string

LNAMEMK
Makes a path string for an image file

PICCLOSE
Closes the graphics environment

PICDELETE
Deletes a region

PICFILL
Defines a region and fills it with an image

PICOPEN
Initializes the graphics environment
Interface to SAS Software RLINK
Reports whether a link exists between the current SAS session and a remote SAS session

RSESSION
Returns the name, description, and SAS software version of a remote session

RSTITLE
Defines a description for an existing connection to a remote session

SASTASK
Determines whether a SAS procedure is running
Keys EVENT
Reports whether a user has pressed a function key, ENTER key, or mouse button

FKEYNAME
Returns the name of the specified function key

GETFKEY
Returns the command that is assigned to a function key

LASTKEY
Returns the number of the last function key that was pressed from the application window

NUMFKEYS
Returns the number of function keys that are available for the device

SETFKEY
Assigns a command to a function key
Legend ENDLEGEND
Closes the LEGEND window

LEGEND
Displays a legend window or refreshes the current LEGEND window

POPLEGEND
Restores to the LEGEND window the last contents saved with the PUSHLEGEND routine

PUSHLEGEND
Saves the contents of the LEGEND window

PUTLEGEND
Specifies the contents of one line in the LEGEND window
List CLEARLIST
Clears the items from an SCL list without deleting the list and optionally clears all sublist items

COMPARELIST
Compares two SCL lists

COPYLIST
Copies or merges the contents of an SCL list into an existing list or a new list

CURLIST
Designates or reports the current result SCL list

DELITEM
Deletes an item from an SCL list

DELLIST
Deletes a list and optionally deletes all of its sublists

DELNITEM
Deletes a named item from an SCL list

DESCRIBE
Fills an SCL list with items of system information about a SAS table, view, or catalog entry

ENVLIST
Returns the list identifier of an SCL environment list

FILLIST
Fills an SCL list with text and data

GETITEMC, GETITEML, GETITEMN, and GETITEMO
Returns a value that is identified by its position in an SCL list

GETLATTR
Returns the attributes of either an SCL list or an item in the list

GETNITEMC, GETNITEML, GETNITEMN, and GETNITEMO
Return a value identified by its item name in an SCL list

HASATTR
Reports whether an SCL list or a list item has a specified attribute

INSERTC, INSERTL, INSERTN, and INSERTO
Insert a value into an SCL list

ITEMTYPE
Reports the type of an item in an SCL list

LISTLEN
Reports the length of an SCL list

LVARLEVEL
Fills an SCL list with the unique values of a column from a SAS table

MAKELIST
Creates an SCL list

MAKENLIST
Creates an SCL list that contains named items

NAMEDITEM
Returns the index of a named item in a list

NAMEITEM
Returns and optionally replaces the name of an item in an SCL list

POPC, POPL, POPN, and POPO
Removes an item from an SCL list and returns the value of the item

POPMENU
Displays a pop-up menu that contains character items from an SCL list

PUTLIST
Displays the contents of an SCL list in the LOG window

REVLIST
Reverses the order of the items in an SCL list

ROTLIST
Rotates the items in an SCL list

SAVELIST
Stores SCL list items in a SAS catalog entry or in an external file

SEARCHC, SEARCHL, SEARCHN, and SEARCHO
Search for a value in an SCL list and return its position number

SETITEMC, SETITEML, SETITEMN, and SETITEMO
Store a value at an indexed position in an SCL list

SETLATTR
Sets the attributes of an SCL list or an item in a list

SETNITEMC, SETNITEML, SETNITEMN, and SETNITEMO
Assign a value to a named item in an SCL list

SORTLIST
Sorts the items in an SCL list by value or by name
Macro SYMGET and SYMGETN
Return the value stored in a macro variable

SYMPUT and SYMPUTN
Store a value in a SAS macro variable
Message STDMSG
Displays the text of the SAS software message that is generated by an unknown command

SYSMSG
Returns the text of SCL error messages or warning messages

SYSRC
Returns a system error number or the exit status of the most recently called entry
Modular Programming CBT
Runs a CBT entry

DISPLAY
Runs a catalog entry that was created with SAS/AF software

ENDMETHOD
Ends a METHOD statement block

ENTRY
Receives parameters from the DISPLAY function or routine

GETPARMID
Returns the numeric value stored by the SETPARMID routine

METHOD
Executes a method block that is defined in an SCL entry

METHOD
Defines a method that can be called by the METHOD routine

NOCHANGE
Causes the called program to return the original values for the variables that it received as parameters in an ENTRY statement

SETPARMID
Makes the value of an SCL numeric variable available between SCL programs
Object Oriented APPLY
Invokes a method whose arguments are passed from an SCL list

CBT
Runs a CBT entry

CLASS
Creates a class using SCL code

CREATESCL
Writes class or interface information to an SCL entry

DIALOG
Runs a FRAME entry that was created with SAS/AF software and disables all other windows

DISPLAY
Runs a catalog entry that was created with SAS/AF software

ENDCLASS
Ends a CLASS statement block

ENDMETHOD
Ends a METHOD statement block

ENDPACKAGE
Ends a PACKAGE statement block

ENDUSECLASS
Ends a USECLASS statement block

ENTRY
Receives parameters from the DISPLAY function or routine

GETPARMID
Returns the numeric value stored by the SETPARMID routine

IMPORT
Defines a search path for references to CLASS entries

INSTANCE
Creates an object and returns its identifier

INTERFACE
Defines a group of abstract methods shared by the related classes

ITEM
Specifies the classes on the server that can be accessed by applications on the client

LOADCLASS
Loads a class and returns its identifier number

LOADRES
Loads a RESOURCE entry

METHOD
Defines a method that can be called by the METHOD routine

METHOD
Executes a method block that is defined in an SCL entry

_NEO_
Creates an object

_NEW_
Creates an object and runs an associated class constructor

NOCHANGE
Causes the called program to return the original values for the variables that it received as parameters in an ENTRY statement

NOTIFY
Sends a method to a control that is identified by its name

PACKAGE
Defines a group of classes whose metadata must be recognized by objects defined on the client

SEND
Sends a method to an object using its identifier and can return a value from a called method

SETPARMID
Makes the value of an SCL numeric variable available between SCL programs

SUPAPPLY
Invokes the inherited definition of a method and passes the method's arguments in an SCL list

SUPER
Invokes the inherited definition of a method

USECLASS
Implements methods for a class and binds them to the class definition
SAS System Option COMAMID
Returns the list of communications access methods for an operating system

GETFOOT
Returns the text of a footnote definition

GETTITLE
Returns the text of a title definition

GGLOBAL
Returns the text of a SYMBOL, PATTERN, LEGEND, or AXIS statement

GGLOBALE
Deletes an internal table of SYMBOL, PATTERN, LEGEND, or AXIS definitions

GGLOBALN
Returns the number of SYMBOL, PATTERN, LEGEND, or AXIS statements that are currently defined

OPTGETC and OPTGETN
Return the current setting of a SAS system option

OPTSETC and OPTSETN
Assign a value to a SAS system option

SETFOOT
Sets the text of a footnote definition

SETTITLE
Sets the text of a title definition
SAS Table APPEND
Appends a new row to a SAS table

ATTRC and ATTRN
Return the value of an attribute for a SAS table

CLOSE
Closes a SAS table

CONTENTS
Displays the attributes of a SAS table

CUROBS
Returns the number of the current row in a SAS table

DATALISTC and DATALISTN
Displays a selection list window that contains the values of particular columns from rows in a SAS table and returns user selections

DELOBS
Deletes a row from a SAS table

DROPNOTE
Deletes a note marker from either a SAS table or an external file

DSID
Searches for a SAS table name and returns the table identifier

DSNAME
Returns the SAS table name that is associated with a table identifier

EXIST
Verifies the existence of a member of a SAS data library

FETCH
Reads the next nondeleted row from a SAS table into the Table Data Vector (TDV)

FETCHOBS
Reads a specified row from a SAS table into the Table Data Vector (TDV)

FSEDIT
Displays a SAS table by row

FSVIEW
Displays a SAS table in tabular format

GETVARC and GETVARN
Assign the value of a SAS table column to an SCL variable

GETVARF
Assigns the formatted value of a SAS table column to a character SCL variable

ICCREATE
Creates integrity constraints on a SAS table

ICDELETE
Drops an integrity constraint from a SAS table

ICREATE
Creates an index for a SAS table

ICTYPE
Returns the type of integrity constraint that is assigned to a SAS table

ICVALUE
Returns the column names or the condition associated with an integrity constraint

IDELETE
Deletes an index from a SAS table

IMPORT
Creates a SAS table from an external file

INITROW
Initializes the Table Data Vector (TDV) for a SAS table to missing values

IOPTION
Returns options for index columns and key columns

ISINDEX
Returns the type of index for a SAS table column

IVARLIST
Returns the column names for an index key

KEYCOUNT
Returns the number of rows that meet the criteria specified by an index key

LIBLIST
Displays a host selection window that lists the currently assigned librefs, and returns user's selections

LIBNAME
Assigns or deassigns a libref for a SAS data library

LIBREF
Verifies that a libref has been assigned

LOCATEC and LOCATEN
Search a SAS table for a row that contains a specified value

LOCK
Locks or unlocks a SAS table or a SAS catalog entry

NEW
Defines a new SAS table interactively

NEWVAR
Adds a column to a new SAS table

NOTE
Returns an identifier for the current row of a SAS table

OBSINFO
Returns information about the current row in an FSEDIT application

OPEN
Opens a SAS table

POINT
Locates a row that is identified by the NOTE function

PUTVARC and PUTVARN
Write a value to the Table Data Vector (TDV) for a SAS table

REWIND
Positions the table pointer at the beginning of a SAS table

SET
Links SAS table columns to SCL variables of the same name and data type

SETKEY
Defines an index key for retrieving rows from a SAS table

SORT
Sorts a SAS table by one or more columns

UNLOCK
Releases a lock on the current row

UPDATE
Writes values from the Table Data Vector (TDV) to the current row in a SAS table

VARLIST
Displays a dialog window that lists the columns in a SAS table, and returns the user's selections

WHERE
Applies a WHERE clause to a SAS table
Selection List CATLIST
Displays a host selector window that lists entries in a SAS catalog, and returns user selections

COLORLIST
Displays a selection list of the names of a device's valid colors and returns user selections

DEVLIST
Displays a selection list of graphic hardware devices and returns user selections

DIRLIST
Opens a host selection list window that lists members of one or more SAS data libraries, and returns a user's selections

FILELIST
Displays a host selection window that lists the currently assigned filerefs, and returns user selections

FONTSEL
Opens the selector window for host fonts or for portable fonts

LISTC and LISTN
Display a selection list window containing values stored in a catalog entry

OPENENTRYDIALOG
Displays a dialog window that lists catalog entries, and returns the user's selection

OPENSASFILEDIALOG
Displays a dialog window that lists SAS files, and returns the user's selection

SAVEENTRYDIALOG
Opens a dialog window that lists catalog entries, and returns the name of the selected entry

SAVESASFILEDIALOG
Displays a dialog window that lists SAS files, and returns the name of the selected file

SELECTICON
Displays a dialog window that contains a list of icons, and returns the value of the selected icon

SHOWLIST
Displays a selection list window that contains up to 13 items, and returns the user's selections
Submit Block


ENDSUBMIT
Ends statements to be submitted to SAS software for execution

PREVIEW
Manipulates an application's preview buffer

REPLACE
Substitutes a replacement string for a reference to an SCL variable in the SUBMIT block

SUBMIT
Submits statements or commands to SAS for execution

SUBMITCLEAR
Aborts a pending submit transaction
System Variable _BLANK_
Special missing value

_CFRAME_
Contains the identifier of the FRAME entry that is currently executing

_CURCOL_
Contains the value of the leftmost column in an extended table control in a FRAME entry

_CURROW_
Contains the number of the current row in an extended table

_EVENT_
Contains the type of event that occurred on a FRAME entry control

_FRAME_
Contains the identifier of either the FRAME entry that contains the control or the FRAME entry that is being used as a method

_METHOD_
Contains the name of the method that is currently executing

_MSG_
Contains the text to display on the window's message line the next time the window is refreshed

_SELF_
Contains the identifier of the control for the currently executing method, or the identifier of the FRAME entry if the FRAME entry is not running as a method

_STATUS_
Contains the status of program execution or overrides the normal flow of control

_VALUE_
Contains the value of a FRAME entry component
Utility ALARM
Sounds an alarm on a device when the current window is refreshed or redisplayed.

BUILD
Invokes the BUILD window in SAS/AF software

COPY
Copies a SAS table, view, catalog, or catalog entry

DELETE
Deletes a member of a SAS data library or an external file or directory

LETTER
Displays the FSLETTER window or sends a letter that was created with the FSLETTER procedure

LIBREF
Verifies that a libref has been assigned

MESSAGEBOX
Displays a host message window with a specified text and icon

NAMEDIVIDE
Returns the number of parts of a compound name as well as the values of each part

NAMEMERGE
Returns a compound name by merging name parts

PUT
Writes text to the LOG window

RENAME
Renames a member of a SAS data library, an external file, or a directory

RGBDM
Returns the name supported by the SAS windowing environment for a color

SASNAME
Verifies that a name is a valid SAS name

TRACEBACK
Displays traceback information for an SCL execution stack

UNIQUENUM
Returns a unique number

WAIT
Suspends execution of the next program statement
Variable MODVAR
Changes the name, label, format, or informat of a column in a SAS table

VARFMT
Returns the format that is assigned to a SAS table column

VARINFMT
Returns the informat that is assigned to a SAS table column

VARLABEL
Returns the label that is assigned to a SAS table column

VARLEN
Returns the length of a SAS table column

VARLEVEL
Reports the unique values of a SAS table column

VARNAME
Returns the name of a SAS table column

VARNUM
Returns the number of a SAS table column

VARSTAT
Calculates simple statistics for SAS table columns

VARTYPE
Returns the data type of a SAS table column
Widget or Field CURSOR
Positions the cursor in a specified widget or field of a FRAME entry

CURWORD
Returns the word that is at the cursor position

FIELD
Performs an action on or reports the state of FRAME entry widgets or fields

FLDATTR
Changes the color and display attributes of a field, text entry widget, or text label widget to those stored in an attribute string

FLDCOLOR
Changes the color and display attributes of a field, text entry widget, or text label widget to those stored in an attribute string

STRATTR
Defines a string for color and display attributes
Window BLOCK
Displays a menu containing up to 12 choice blocks and returns the number of the user's choice

DMWINDOW
Sets the color and highlighting for lines in the OUTPUT and LOG windows

ENDBLOCK
Closes the window that is created by the BLOCK function

ICON
Associates an icon with a window

PMENU
Changes the PMENU for an application

REFRESH
Redisplays a window using current field or control values

SAVESCREEN
Saves the values of data entry fields without exiting from the window

SCREENNAME
Returns the name of the current window

WDEF
Resizes the active window

WINFO
Returns information about the current window

WNAME
Specifies a name for the active window

WOUTPUT
Manipulates the OUTPUT window

WREGION
Defines the boundaries for the next window that is displayed


Chapter Contents

Previous

Next

Top of Page

Copyright 1999 by SAS Institute Inc., Cary, NC, USA. All rights reserved.