Mercurial > emacs
changeset 74350:501f287c0352
(Fw32_shell_execute): Doc fix.
author | Eli Zaretskii <eliz@gnu.org> |
---|---|
date | Fri, 01 Dec 2006 13:04:59 +0000 |
parents | cdbaa3a95e6c |
children | b51283822ec9 |
files | src/w32fns.c |
diffstat | 1 files changed, 33 insertions(+), 11 deletions(-) [+] |
line wrap: on
line diff
--- a/src/w32fns.c Fri Dec 01 12:24:17 2006 +0000 +++ b/src/w32fns.c Fri Dec 01 13:04:59 2006 +0000 @@ -8044,17 +8044,39 @@ doc: /* Get Windows to perform OPERATION on DOCUMENT. This is a wrapper around the ShellExecute system function, which invokes the application registered to handle OPERATION for DOCUMENT. -OPERATION is typically \"open\", \"print\" or \"explore\" (but can be -nil for the default action), and DOCUMENT is typically the name of a -document file or URL, but can also be a program executable to run or -a directory to open in the Windows Explorer. - -If DOCUMENT is a program executable, PARAMETERS can be a string -containing command line parameters, but otherwise should be nil. - -SHOW-FLAG can be used to control whether the invoked application is hidden -or minimized. If SHOW-FLAG is nil, the application is displayed normally, -otherwise it is an integer representing a ShowWindow flag: + +OPERATION is either nil or a string that names a supported operation. +What operations can be used depends on the particular DOCUMENT and its +handler application, but typically it is one of the following common +operations: + + \"open\" - open DOCUMENT, which could be a file, a directory, or an + executable program. If it is an application, that + application is launched in the current buffer's default + directory. Otherwise, the application associated with + DOCUMENT is launched in the buffer's default directory. + \"print\" - print DOCUMENT, which must be a file + \"explore\" - start the Windows Explorer on DOCUMENT + \"edit\" - launch an editor and open DOCUMENT for editing; which + editor is launched depends on the association for the + specified DOCUMENT + \"find\" - initiate search starting from DOCUMENT which must specify + a directory + nil - invoke the default OPERATION, or \"open\" if default is + not defined or unavailable + +DOCUMENT is typically the name of a document file or a URL, but can +also be a program executable to run, or a directory to open in the +Windows Explorer. + +If DOCUMENT is a program executable, the optional arg PARAMETERS can +be a string containing command line parameters that will be passed to +the program; otherwise, PARAMETERS should be nil or unspecified. + +Second optional argument SHOW-FLAG can be used to control how the +application will be displayed when it is invoked. If SHOW-FLAG is nil +or unspceified, the application is displayed normally, otherwise it is +an integer representing a ShowWindow flag: 0 - start hidden 1 - start normally