FunctionPackage: cgToCDocOverviewCGDocRelNotesFAQIndexPermutedIndex
Allegro CL version 9.0
Object described on page has changed in 9.0.
8.2 version

ask-user-for-directory

Arguments: &key (prompt "Select a folder.") (stream (selected-window-or-screen)) root dont-go-below-domain browse-include-files include-edit-box new-dialog-style

Displays a dialog where the user can select an existing directory (also known as a folder). This function is intended to display the underlying windowing system's directory-selecting dialog with its native look-and-feel, and on the Windows platform it does just that. On GTK it simply calls ask-user-for-new-or-existing-directory, which is a platform-independent function written in Common Graphics. It is probably better to call the other function directly on GTK, to use its additional arguments, or on all platforms if the native behavior is not needed on Windows.

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.

Note too that it is not possible to specify the initially-selected directory or which subdirectories are initially open in the hierarchy that is presented.

The arguments are:

The similar function ask-user-for-new-or-existing-directory invokes a dialog that has more options than this function does. But this function invokes the directory dialog that is provided by the operating system and therefore may be more familiar to users of that operating system.

See also ask-user-for-existing-pathname and ask-user-for-new-pathname.


Copyright (c) 1998-2012, Franz Inc. Oakland, CA., USA. All rights reserved.
Documentation for Allegro CL version 9.0. The object described on this page has been modified in the 9.0 release; see the Release Notes.
Created 2010.1.21.

ToCDocOverviewCGDocRelNotesFAQIndexPermutedIndex
Allegro CL version 9.0
Object described on page has changed in 9.0.
8.2 version