ask-user-for-directory

Function

Package: common-graphics

Arguments: &key prompt stream root dont-go-below-domain browse-include-files

Displays a dialog showing directories. The chosen directory is returned as a pathname object. Note that the pathname of the directory is stored in a buffer and if the buffer is too small, an error will be signaled. The buffer size is determined by file-selection-buffer-size. The default size is large enough to hold at least 12 pathnames so this should not be a problem for this function, which returns one pathname only.

The arguments are:

prompt: an informational string to be printed in the dialog.
stream: the window or screen that will serve as the owner of the dialog. Defaults to the currently selected top-level window if any, and otherwise to the screen.
root: a pathname, path namestring, or nil, indicating the directory that will appear as the root node in the dialog's directory tree. Only this directory and its subdirectory descendents will be presented for selection by the end user. nil means to include all available file systems. Note that if a namestring is passed, backslashes must be used rather than forward slashes. The final slash is optional when either a pathname or namstring is passed.
dont-go-below-domain: if true, then network folders below the domain level, (as defined by MSDN), will be excluded from the tree of choices.
browse-include-files: if true, the dialog will display regular files in addition to directories, and either a directory or other file may be chosen by the end user and returned.

Common Graphics and IDE documentation is described in About Common Graphics and IDE documentation in cgide.htm.

The documentation is described in introduction.htm and the index is in index.htm.

Created 2000.10.5.