Francois Gouget : shell32: Add some documentation for FindExecutableW().

[Alexandre Julliard]

Module: wine
Branch: master
Commit: 2538fa319a9247d12bfeb46ed6bb21f1deabe451
URL:    http://source.winehq.org/git/wine.git/?a=commit;h=2538fa319a9247d12bfeb46ed6...

Author: Francois Gouget <fgouget(a)codeweavers.com>
Date:   Wed Dec 13 18:07:21 2006 +0100

shell32: Add some documentation for FindExecutableW().

---

 dlls/shell32/shlexec.c |   22 ++++++++++++++++++++++
 1 files changed, 22 insertions(+), 0 deletions(-)

diff --git a/dlls/shell32/shlexec.c b/dlls/shell32/shlexec.c
index 0d29395..2950ad8 100644
--- a/dlls/shell32/shlexec.c
+++ b/dlls/shell32/shlexec.c
@@ -981,6 +981,28 @@ HINSTANCE WINAPI FindExecutableA(LPCSTR
 
 /*************************************************************************
  * FindExecutableW			[SHELL32.@]
+ *
+ * This function returns the executable associated with the specified file
+ * for the default verb.
+ *
+ * PARAMS
+ *  lpFile   [I] The file to find the association for. This must refer to
+ *               an existing file otherwise FindExecutable fails and returns
+ *               SE_ERR_FNF.
+ *  lpResult [O] Points to a buffer into which the executable path is
+ *               copied. This parameter must not be NULL otherwise
+ *               FindExecutable() segfaults. The buffer must be of size at
+ *               least MAX_PATH characters.
+ *
+ * RETURNS
+ *  A value greater than 32 on success, less than or equal to 32 otherwise.
+ *  See the SE_ERR_* constants.
+ *
+ * NOTES
+ *  On Windows XP and 2003, FindExecutable() seems to first convert the
+ *  filename into 8.3 format, thus taking into account only the first three
+ *  characters of the extension, and expects to find an association for those.
+ *  However other Windows versions behave sanely.
  */
 HINSTANCE WINAPI FindExecutableW(LPCWSTR lpFile, LPCWSTR lpDirectory, LPWSTR lpResult)
 {