aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorEli Zaretskii2006-12-01 13:04:59 +0000
committerEli Zaretskii2006-12-01 13:04:59 +0000
commit1dccd4544e4a818ee8824ef5c3168f6e3478862a (patch)
tree6bd897ce60d5c9fc6b8c2d7dba03dd0cb07f49b2 /src
parentccff391f3c315e865a805ec7def535f5a5267084 (diff)
downloademacs-1dccd4544e4a818ee8824ef5c3168f6e3478862a.tar.gz
emacs-1dccd4544e4a818ee8824ef5c3168f6e3478862a.zip
(Fw32_shell_execute): Doc fix.
Diffstat (limited to 'src')
-rw-r--r--src/w32fns.c42
1 files changed, 32 insertions, 10 deletions
diff --git a/src/w32fns.c b/src/w32fns.c
index 0a46a4ed0ed..6313afe7867 100644
--- a/src/w32fns.c
+++ b/src/w32fns.c
@@ -8044,17 +8044,39 @@ DEFUN ("w32-shell-execute", Fw32_shell_execute, Sw32_shell_execute, 2, 4, 0,
8044 doc: /* Get Windows to perform OPERATION on DOCUMENT. 8044 doc: /* Get Windows to perform OPERATION on DOCUMENT.
8045This is a wrapper around the ShellExecute system function, which 8045This is a wrapper around the ShellExecute system function, which
8046invokes the application registered to handle OPERATION for DOCUMENT. 8046invokes the application registered to handle OPERATION for DOCUMENT.
8047OPERATION is typically \"open\", \"print\" or \"explore\" (but can be
8048nil for the default action), and DOCUMENT is typically the name of a
8049document file or URL, but can also be a program executable to run or
8050a directory to open in the Windows Explorer.
8051 8047
8052If DOCUMENT is a program executable, PARAMETERS can be a string 8048OPERATION is either nil or a string that names a supported operation.
8053containing command line parameters, but otherwise should be nil. 8049What operations can be used depends on the particular DOCUMENT and its
8054 8050handler application, but typically it is one of the following common
8055SHOW-FLAG can be used to control whether the invoked application is hidden 8051operations:
8056or minimized. If SHOW-FLAG is nil, the application is displayed normally, 8052
8057otherwise it is an integer representing a ShowWindow flag: 8053 \"open\" - open DOCUMENT, which could be a file, a directory, or an
8054 executable program. If it is an application, that
8055 application is launched in the current buffer's default
8056 directory. Otherwise, the application associated with
8057 DOCUMENT is launched in the buffer's default directory.
8058 \"print\" - print DOCUMENT, which must be a file
8059 \"explore\" - start the Windows Explorer on DOCUMENT
8060 \"edit\" - launch an editor and open DOCUMENT for editing; which
8061 editor is launched depends on the association for the
8062 specified DOCUMENT
8063 \"find\" - initiate search starting from DOCUMENT which must specify
8064 a directory
8065 nil - invoke the default OPERATION, or \"open\" if default is
8066 not defined or unavailable
8067
8068DOCUMENT is typically the name of a document file or a URL, but can
8069also be a program executable to run, or a directory to open in the
8070Windows Explorer.
8071
8072If DOCUMENT is a program executable, the optional arg PARAMETERS can
8073be a string containing command line parameters that will be passed to
8074the program; otherwise, PARAMETERS should be nil or unspecified.
8075
8076Second optional argument SHOW-FLAG can be used to control how the
8077application will be displayed when it is invoked. If SHOW-FLAG is nil
8078or unspceified, the application is displayed normally, otherwise it is
8079an integer representing a ShowWindow flag:
8058 8080
8059 0 - start hidden 8081 0 - start hidden
8060 1 - start normally 8082 1 - start normally