SAS Component Language Dictionary

OPENENTRYDIALOG

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

Category:

Selection List

Syntax
Details
Examples
	Example 1: Opening a Catalog Entry
	Example 2: Using the Advanced Button with an SCL List
See Also

Syntax

selection-item=OPENENTRYDIALOG(<type <,entry-name<,list-id>>>);

selection-item

contains the four-level name of the selected SAS file, or a blank if nothing is selected.

Type: Character

type

specifies the member types to list in the dialog window, such as CLASS, SCL, or FRAME. This can reduce the length of the list in the dialog window. If type is not used, the names of all catalog entry types in the data library are listed.

Type: Character

entry-name

is a two- or four-level name of a catalog entry to call when a user selects the Advanced button in the dialog window. The entry can be any of the following types: FRAME, SCL, PROGRAM, HELP, CBT, or MENU.

If entry-name is not specified, then the window does not contain Advanced.

Type: Character

list-id

contains the identifier of an SCL list that is passed to entry-name.

Type: Numeric or List

Details

OPENENTRYDIALOG displays a list of SAS catalog entries from which a user can make a selection. You can pass that selection to code that opens the catalog entry.

If entry-name is supplied and Advanced is selected, the item selected in the dialog window is passed to entry-name through the following variables, which are created automatically:

USERDATA: contains the list that is passed in the call to the OPENENTRYDIALOG and SAVEENTRYDIALOG functions.
LIBREF: contains the libref of the selected item.
MEMBER: contains the member name of the selected item.
ENTRY: contains the entry name of the selected item.
TYPE: contains the member type of the selected item.

List-id enables information to be passed between the calling entry and entry-name. It is passed to entry-name through the USERDATA variable.

Examples

Example 1: Opening a Catalog Entry

Select a catalog entry of type FRAME to open and display the selected entry.

selection=openentrydialog('frame');
call display(selection);

Example 2: Using the Advanced Button with an SCL List

Specify an entry to call when a user selects Advanced, as well as an SCL list that contains values to pass to the entry. The entry can be any of the following types: FRAME, SCL, PROGRAM, HELP, CBT, or MENU. If entry-name is not specified, then the window does not contain Advanced.

dcl list mydata;
mydata=makelist();
rc=insertc(mydata,'test');
selection=openentrydialog('frame',
   'mylib.mycat.myentry.frame',mydata);
if sysrc(1)=-1 then do;
   ...SCL statements to execute when
   the user cancels from the window...
   end;
else do;
   ...SCL statements to handle selections...
end;

The SCL entry for MYLIB.MYCAT.MYENTRY.FRAME contains the following program:

dcl char(8)  libref type;
dcl char(32) catalog entry;
dcl list userdata;
init:
put libref=;
put catalog=;
put entry=;
put type=;
call putlist(userdata);
return;

Note: The SCL entry must declare these exact variables, in the order specified, to properly reference the selected entry. [cautionend]

If the user selects MYLIB2.MYCAT2.MYENTRY2.FRAME in the dialog window and then selects Advanced, the output for this program is

libref=Mylib2
catalog=Mycat2
entry=Myentry2
type=Frame
('test')[1]