Updated source docu.

Fri, 18 Nov 2016 18:53:31 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 18 Nov 2016 18:53:31 +0100
changeset 5332
41b32e1636e1
parent 5331
8d607cd52f26
child 5337
d478270045b2

Updated source docu.

APIs/Python3/eric6.api file | annotate | diff | comparison | revisions
Documentation/Help/source.qch file | annotate | diff | comparison | revisions
Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Utilities.__init__.html file | annotate | diff | comparison | revisions
--- a/APIs/Python3/eric6.api	Fri Nov 18 18:34:34 2016 +0100
+++ b/APIs/Python3/eric6.api	Fri Nov 18 18:53:31 2016 +0100
@@ -9029,6 +9029,7 @@
 eric6.Utilities.getRealName?4()
 eric6.Utilities.getTestFileName?4(fn)
 eric6.Utilities.getUserName?4()
+eric6.Utilities.getWindowsExecutablePath?4(file)
 eric6.Utilities.get_coding?4(text)
 eric6.Utilities.get_codingBytes?4(text)
 eric6.Utilities.hasEnvironmentEntry?4(key)
Binary file Documentation/Help/source.qch has changed
--- a/Documentation/Help/source.qhp	Fri Nov 18 18:34:34 2016 +0100
+++ b/Documentation/Help/source.qhp	Fri Nov 18 18:53:31 2016 +0100
@@ -16459,6 +16459,7 @@
       <keyword name="getViewManager" id="getViewManager" ref="eric6.Preferences.__init__.html#getViewManager" />
       <keyword name="getWebBrowser" id="getWebBrowser" ref="eric6.Preferences.__init__.html#getWebBrowser" />
       <keyword name="getWebEngineVersions" id="getWebEngineVersions" ref="eric6.WebBrowser.Tools.WebBrowserTools.html#getWebEngineVersions" />
+      <keyword name="getWindowsExecutablePath" id="getWindowsExecutablePath" ref="eric6.Utilities.__init__.html#getWindowsExecutablePath" />
       <keyword name="get_class_members" id="get_class_members" ref="eric6.DebugClients.Python.FlexCompleter.html#get_class_members" />
       <keyword name="get_coding" id="get_coding" ref="eric6.Utilities.__init__.html#get_coding" />
       <keyword name="get_codingBytes" id="get_codingBytes" ref="eric6.Utilities.__init__.html#get_codingBytes" />
--- 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