Documentation/Source/eric6.Utilities.__init__.html

changeset 5332
41b32e1636e1
parent 5020
d0afdfd8e45b
child 5586
0e5421d679e7
diff -r 8d607cd52f26 -r 41b32e1636e1 Documentation/Source/eric6.Utilities.__init__.html
--- a/Documentation/Source/eric6.Utilities.__init__.html	Fri Nov 18 18:34:34 2016 +0100
+++ b/Documentation/Source/eric6.Utilities.__init__.html	Fri Nov 18 18:53:31 2016 +0100
@@ -151,6 +151,9 @@
 <td><a href="#getUserName">getUserName</a></td>
 <td>Function to get the user name.</td>
 </tr><tr>
+<td><a href="#getWindowsExecutablePath">getWindowsExecutablePath</a></td>
+<td>Function to build the full path of an executable file from the environment on Windows platforms.</td>
+</tr><tr>
 <td><a href="#get_coding">get_coding</a></td>
 <td>Function to get the coding of a text.</td>
 </tr><tr>
@@ -1084,6 +1087,31 @@
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
+<a NAME="getWindowsExecutablePath" ID="getWindowsExecutablePath"></a>
+<h2>getWindowsExecutablePath</h2>
+<b>getWindowsExecutablePath</b>(<i>file</i>)
+<p>
+    Function to build the full path of an executable file from the environment
+    on Windows platforms.
+</p><p>
+    First an executable with the extension .exe is searched for, thereafter one
+    with the extension .bat and finally the given file name as is. The first
+    match is returned.
+</p><dl>
+<dt><i>file</i></dt>
+<dd>
+filename of the executable to check (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+full executable name, if the executable file is accessible
+        via the searchpath defined by the PATH environment variable, or an
+        empty string otherwise.
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
 <a NAME="get_coding" ID="get_coding"></a>
 <h2>get_coding</h2>
 <b>get_coding</b>(<i>text</i>)

eric ide

mercurial