--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.SystemUtilities.OSUtilities.html Sun Dec 18 19:33:46 2022 +0100 @@ -0,0 +1,301 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.SystemUtilities.OSUtilities</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.SystemUtilities.OSUtilities</h1> + +<p> +Module implementing Operating System related utility functions. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Functions</h3> + +<table> + +<tr> +<td><a href="#getEnvironmentEntry">getEnvironmentEntry</a></td> +<td>Module function to get an environment entry.</td> +</tr> +<tr> +<td><a href="#getHomeDir">getHomeDir</a></td> +<td>Function to get a users home directory.</td> +</tr> +<tr> +<td><a href="#getRealName">getRealName</a></td> +<td>Function to get the real name of the user.</td> +</tr> +<tr> +<td><a href="#getUserName">getUserName</a></td> +<td>Function to get the user name.</td> +</tr> +<tr> +<td><a href="#hasEnvironmentEntry">hasEnvironmentEntry</a></td> +<td>Module function to check, if the environment contains an entry.</td> +</tr> +<tr> +<td><a href="#isLinuxPlatform">isLinuxPlatform</a></td> +<td>Function to check, if this is a Linux platform.</td> +</tr> +<tr> +<td><a href="#isMacPlatform">isMacPlatform</a></td> +<td>Function to check, if this is a Mac platform.</td> +</tr> +<tr> +<td><a href="#isWindowsPlatform">isWindowsPlatform</a></td> +<td>Function to check, if this is a Windows platform.</td> +</tr> +<tr> +<td><a href="#win32_GetUserName">win32_GetUserName</a></td> +<td>Function to get the user name under Win32.</td> +</tr> +<tr> +<td><a href="#win32_Kill">win32_Kill</a></td> +<td>Function to provide an os.kill equivalent for Win32.</td> +</tr> +<tr> +<td><a href="#win32_getRealName">win32_getRealName</a></td> +<td>Function to get the user's real name (aka.</td> +</tr> +</table> +<hr /> +<hr /> +<a NAME="getEnvironmentEntry" ID="getEnvironmentEntry"></a> +<h2>getEnvironmentEntry</h2> +<b>getEnvironmentEntry</b>(<i>key, default=None</i>) + +<p> + Module function to get an environment entry. +</p> +<dl> + +<dt><i>key</i></dt> +<dd> +key of the requested environment entry (string) +</dd> +<dt><i>default</i></dt> +<dd> +value to be returned, if the environment doesn't contain + the requested entry (string) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +the requested entry or the default value, if the entry wasn't + found (string or None) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="getHomeDir" ID="getHomeDir"></a> +<h2>getHomeDir</h2> +<b>getHomeDir</b>(<i></i>) + +<p> + Function to get a users home directory. +</p> +<dl> +<dt>Return:</dt> +<dd> +home directory (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="getRealName" ID="getRealName"></a> +<h2>getRealName</h2> +<b>getRealName</b>(<i></i>) + +<p> + Function to get the real name of the user. +</p> +<dl> +<dt>Return:</dt> +<dd> +real name of the user (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="getUserName" ID="getUserName"></a> +<h2>getUserName</h2> +<b>getUserName</b>(<i></i>) + +<p> + Function to get the user name. +</p> +<dl> +<dt>Return:</dt> +<dd> +user name (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="hasEnvironmentEntry" ID="hasEnvironmentEntry"></a> +<h2>hasEnvironmentEntry</h2> +<b>hasEnvironmentEntry</b>(<i>key</i>) + +<p> + Module function to check, if the environment contains an entry. +</p> +<dl> + +<dt><i>key</i> (str)</dt> +<dd> +key of the requested environment entry +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating the presence of the requested entry +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="isLinuxPlatform" ID="isLinuxPlatform"></a> +<h2>isLinuxPlatform</h2> +<b>isLinuxPlatform</b>(<i></i>) + +<p> + Function to check, if this is a Linux platform. +</p> +<dl> +<dt>Return:</dt> +<dd> +flag indicating Linux platform +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="isMacPlatform" ID="isMacPlatform"></a> +<h2>isMacPlatform</h2> +<b>isMacPlatform</b>(<i></i>) + +<p> + Function to check, if this is a Mac platform. +</p> +<dl> +<dt>Return:</dt> +<dd> +flag indicating Mac platform +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="isWindowsPlatform" ID="isWindowsPlatform"></a> +<h2>isWindowsPlatform</h2> +<b>isWindowsPlatform</b>(<i></i>) + +<p> + Function to check, if this is a Windows platform. +</p> +<dl> +<dt>Return:</dt> +<dd> +flag indicating Windows platform +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="win32_GetUserName" ID="win32_GetUserName"></a> +<h2>win32_GetUserName</h2> +<b>win32_GetUserName</b>(<i></i>) + +<p> + Function to get the user name under Win32. +</p> +<dl> +<dt>Return:</dt> +<dd> +user name (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="win32_Kill" ID="win32_Kill"></a> +<h2>win32_Kill</h2> +<b>win32_Kill</b>(<i>pid</i>) + +<p> + Function to provide an os.kill equivalent for Win32. +</p> +<dl> + +<dt><i>pid</i></dt> +<dd> +process id (integer) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +result of the kill (boolean) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="win32_getRealName" ID="win32_getRealName"></a> +<h2>win32_getRealName</h2> +<b>win32_getRealName</b>(<i></i>) + +<p> + Function to get the user's real name (aka. display name) under Win32. +</p> +<dl> +<dt>Return:</dt> +<dd> +real name of the current user (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file