Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.SystemUtilities.OSUtilities.html
src/eric7/Documentation/Source/eric7.SystemUtilities.OSUtilities.html
- branch
- eric7
- changeset 10479
- 856476537696
- parent 10431
- 64157aeb0312
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.SystemUtilities.OSUtilities</h1> | 9 <h1>eric7.SystemUtilities.OSUtilities</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing Operating System related utility functions. | 11 Module implementing Operating System related utility functions. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | |
| 16 <table> | 15 <table> |
| 17 <tr><td>None</td></tr> | 16 <tr><td>None</td></tr> |
| 18 </table> | 17 </table> |
| 18 | |
| 19 <h3>Classes</h3> | 19 <h3>Classes</h3> |
| 20 | |
| 21 <table> | 20 <table> |
| 22 <tr><td>None</td></tr> | 21 <tr><td>None</td></tr> |
| 23 </table> | 22 </table> |
| 23 | |
| 24 <h3>Functions</h3> | 24 <h3>Functions</h3> |
| 25 | |
| 26 <table> | 25 <table> |
| 27 | |
| 28 <tr> | 26 <tr> |
| 29 <td><a href="#getEnvironmentEntry">getEnvironmentEntry</a></td> | 27 <td><a href="#getEnvironmentEntry">getEnvironmentEntry</a></td> |
| 30 <td>Module function to get an environment entry.</td> | 28 <td>Module function to get an environment entry.</td> |
| 31 </tr> | 29 </tr> |
| 32 <tr> | 30 <tr> |
| 72 <tr> | 70 <tr> |
| 73 <td><a href="#win32_getRealName">win32_getRealName</a></td> | 71 <td><a href="#win32_getRealName">win32_getRealName</a></td> |
| 74 <td>Function to get the user's real name (aka.</td> | 72 <td>Function to get the user's real name (aka.</td> |
| 75 </tr> | 73 </tr> |
| 76 </table> | 74 </table> |
| 75 | |
| 77 <hr /> | 76 <hr /> |
| 78 <hr /> | 77 <hr /> |
| 79 <a NAME="getEnvironmentEntry" ID="getEnvironmentEntry"></a> | 78 <a NAME="getEnvironmentEntry" ID="getEnvironmentEntry"></a> |
| 80 <h2>getEnvironmentEntry</h2> | 79 <h2>getEnvironmentEntry</h2> |
| 81 <b>getEnvironmentEntry</b>(<i>key, default=None</i>) | 80 <b>getEnvironmentEntry</b>(<i>key, default=None</i>) |
| 82 | |
| 83 <p> | 81 <p> |
| 84 Module function to get an environment entry. | 82 Module function to get an environment entry. |
| 85 </p> | 83 </p> |
| 84 | |
| 86 <dl> | 85 <dl> |
| 87 | 86 |
| 88 <dt><i>key</i> (str)</dt> | 87 <dt><i>key</i> (str)</dt> |
| 89 <dd> | 88 <dd> |
| 90 key of the requested environment entry | 89 key of the requested environment entry |
| 111 <hr /> | 110 <hr /> |
| 112 <hr /> | 111 <hr /> |
| 113 <a NAME="getHomeDir" ID="getHomeDir"></a> | 112 <a NAME="getHomeDir" ID="getHomeDir"></a> |
| 114 <h2>getHomeDir</h2> | 113 <h2>getHomeDir</h2> |
| 115 <b>getHomeDir</b>(<i></i>) | 114 <b>getHomeDir</b>(<i></i>) |
| 116 | |
| 117 <p> | 115 <p> |
| 118 Function to get a users home directory. | 116 Function to get a users home directory. |
| 119 </p> | 117 </p> |
| 118 | |
| 120 <dl> | 119 <dl> |
| 121 <dt>Return:</dt> | 120 <dt>Return:</dt> |
| 122 <dd> | 121 <dd> |
| 123 home directory | 122 home directory |
| 124 </dd> | 123 </dd> |
| 133 <hr /> | 132 <hr /> |
| 134 <hr /> | 133 <hr /> |
| 135 <a NAME="getRealName" ID="getRealName"></a> | 134 <a NAME="getRealName" ID="getRealName"></a> |
| 136 <h2>getRealName</h2> | 135 <h2>getRealName</h2> |
| 137 <b>getRealName</b>(<i></i>) | 136 <b>getRealName</b>(<i></i>) |
| 138 | |
| 139 <p> | 137 <p> |
| 140 Function to get the real name of the user. | 138 Function to get the real name of the user. |
| 141 </p> | 139 </p> |
| 140 | |
| 142 <dl> | 141 <dl> |
| 143 <dt>Return:</dt> | 142 <dt>Return:</dt> |
| 144 <dd> | 143 <dd> |
| 145 real name of the user | 144 real name of the user |
| 146 </dd> | 145 </dd> |
| 155 <hr /> | 154 <hr /> |
| 156 <hr /> | 155 <hr /> |
| 157 <a NAME="getUserName" ID="getUserName"></a> | 156 <a NAME="getUserName" ID="getUserName"></a> |
| 158 <h2>getUserName</h2> | 157 <h2>getUserName</h2> |
| 159 <b>getUserName</b>(<i></i>) | 158 <b>getUserName</b>(<i></i>) |
| 160 | |
| 161 <p> | 159 <p> |
| 162 Function to get the user name. | 160 Function to get the user name. |
| 163 </p> | 161 </p> |
| 162 | |
| 164 <dl> | 163 <dl> |
| 165 <dt>Return:</dt> | 164 <dt>Return:</dt> |
| 166 <dd> | 165 <dd> |
| 167 user name | 166 user name |
| 168 </dd> | 167 </dd> |
| 177 <hr /> | 176 <hr /> |
| 178 <hr /> | 177 <hr /> |
| 179 <a NAME="hasEnvironmentEntry" ID="hasEnvironmentEntry"></a> | 178 <a NAME="hasEnvironmentEntry" ID="hasEnvironmentEntry"></a> |
| 180 <h2>hasEnvironmentEntry</h2> | 179 <h2>hasEnvironmentEntry</h2> |
| 181 <b>hasEnvironmentEntry</b>(<i>key</i>) | 180 <b>hasEnvironmentEntry</b>(<i>key</i>) |
| 182 | |
| 183 <p> | 181 <p> |
| 184 Module function to check, if the environment contains an entry. | 182 Module function to check, if the environment contains an entry. |
| 185 </p> | 183 </p> |
| 184 | |
| 186 <dl> | 185 <dl> |
| 187 | 186 |
| 188 <dt><i>key</i> (str)</dt> | 187 <dt><i>key</i> (str)</dt> |
| 189 <dd> | 188 <dd> |
| 190 key of the requested environment entry | 189 key of the requested environment entry |
| 206 <hr /> | 205 <hr /> |
| 207 <hr /> | 206 <hr /> |
| 208 <a NAME="isFreeBsdPlatform" ID="isFreeBsdPlatform"></a> | 207 <a NAME="isFreeBsdPlatform" ID="isFreeBsdPlatform"></a> |
| 209 <h2>isFreeBsdPlatform</h2> | 208 <h2>isFreeBsdPlatform</h2> |
| 210 <b>isFreeBsdPlatform</b>(<i></i>) | 209 <b>isFreeBsdPlatform</b>(<i></i>) |
| 211 | |
| 212 <p> | 210 <p> |
| 213 Function to check, if this is a BSD (FreeBSD) platform. | 211 Function to check, if this is a BSD (FreeBSD) platform. |
| 214 </p> | 212 </p> |
| 213 | |
| 215 <dl> | 214 <dl> |
| 216 <dt>Return:</dt> | 215 <dt>Return:</dt> |
| 217 <dd> | 216 <dd> |
| 218 flag indicating BSD platform | 217 flag indicating BSD platform |
| 219 </dd> | 218 </dd> |
| 228 <hr /> | 227 <hr /> |
| 229 <hr /> | 228 <hr /> |
| 230 <a NAME="isLinuxPlatform" ID="isLinuxPlatform"></a> | 229 <a NAME="isLinuxPlatform" ID="isLinuxPlatform"></a> |
| 231 <h2>isLinuxPlatform</h2> | 230 <h2>isLinuxPlatform</h2> |
| 232 <b>isLinuxPlatform</b>(<i></i>) | 231 <b>isLinuxPlatform</b>(<i></i>) |
| 233 | |
| 234 <p> | 232 <p> |
| 235 Function to check, if this is a Linux platform. | 233 Function to check, if this is a Linux platform. |
| 236 </p> | 234 </p> |
| 235 | |
| 237 <dl> | 236 <dl> |
| 238 <dt>Return:</dt> | 237 <dt>Return:</dt> |
| 239 <dd> | 238 <dd> |
| 240 flag indicating Linux platform | 239 flag indicating Linux platform |
| 241 </dd> | 240 </dd> |
| 250 <hr /> | 249 <hr /> |
| 251 <hr /> | 250 <hr /> |
| 252 <a NAME="isMacPlatform" ID="isMacPlatform"></a> | 251 <a NAME="isMacPlatform" ID="isMacPlatform"></a> |
| 253 <h2>isMacPlatform</h2> | 252 <h2>isMacPlatform</h2> |
| 254 <b>isMacPlatform</b>(<i></i>) | 253 <b>isMacPlatform</b>(<i></i>) |
| 255 | |
| 256 <p> | 254 <p> |
| 257 Function to check, if this is a Mac platform. | 255 Function to check, if this is a Mac platform. |
| 258 </p> | 256 </p> |
| 257 | |
| 259 <dl> | 258 <dl> |
| 260 <dt>Return:</dt> | 259 <dt>Return:</dt> |
| 261 <dd> | 260 <dd> |
| 262 flag indicating Mac platform | 261 flag indicating Mac platform |
| 263 </dd> | 262 </dd> |
| 272 <hr /> | 271 <hr /> |
| 273 <hr /> | 272 <hr /> |
| 274 <a NAME="isWindowsPlatform" ID="isWindowsPlatform"></a> | 273 <a NAME="isWindowsPlatform" ID="isWindowsPlatform"></a> |
| 275 <h2>isWindowsPlatform</h2> | 274 <h2>isWindowsPlatform</h2> |
| 276 <b>isWindowsPlatform</b>(<i></i>) | 275 <b>isWindowsPlatform</b>(<i></i>) |
| 277 | |
| 278 <p> | 276 <p> |
| 279 Function to check, if this is a Windows platform. | 277 Function to check, if this is a Windows platform. |
| 280 </p> | 278 </p> |
| 279 | |
| 281 <dl> | 280 <dl> |
| 282 <dt>Return:</dt> | 281 <dt>Return:</dt> |
| 283 <dd> | 282 <dd> |
| 284 flag indicating Windows platform | 283 flag indicating Windows platform |
| 285 </dd> | 284 </dd> |
| 294 <hr /> | 293 <hr /> |
| 295 <hr /> | 294 <hr /> |
| 296 <a NAME="win32_GetUserName" ID="win32_GetUserName"></a> | 295 <a NAME="win32_GetUserName" ID="win32_GetUserName"></a> |
| 297 <h2>win32_GetUserName</h2> | 296 <h2>win32_GetUserName</h2> |
| 298 <b>win32_GetUserName</b>(<i></i>) | 297 <b>win32_GetUserName</b>(<i></i>) |
| 299 | |
| 300 <p> | 298 <p> |
| 301 Function to get the user name under Win32. | 299 Function to get the user name under Win32. |
| 302 </p> | 300 </p> |
| 301 | |
| 303 <dl> | 302 <dl> |
| 304 <dt>Return:</dt> | 303 <dt>Return:</dt> |
| 305 <dd> | 304 <dd> |
| 306 user name | 305 user name |
| 307 </dd> | 306 </dd> |
| 316 <hr /> | 315 <hr /> |
| 317 <hr /> | 316 <hr /> |
| 318 <a NAME="win32_Kill" ID="win32_Kill"></a> | 317 <a NAME="win32_Kill" ID="win32_Kill"></a> |
| 319 <h2>win32_Kill</h2> | 318 <h2>win32_Kill</h2> |
| 320 <b>win32_Kill</b>(<i>pid</i>) | 319 <b>win32_Kill</b>(<i>pid</i>) |
| 321 | |
| 322 <p> | 320 <p> |
| 323 Function to provide an os.kill equivalent for Win32. | 321 Function to provide an os.kill equivalent for Win32. |
| 324 </p> | 322 </p> |
| 323 | |
| 325 <dl> | 324 <dl> |
| 326 | 325 |
| 327 <dt><i>pid</i> (int)</dt> | 326 <dt><i>pid</i> (int)</dt> |
| 328 <dd> | 327 <dd> |
| 329 process id | 328 process id |
| 345 <hr /> | 344 <hr /> |
| 346 <hr /> | 345 <hr /> |
| 347 <a NAME="win32_getRealName" ID="win32_getRealName"></a> | 346 <a NAME="win32_getRealName" ID="win32_getRealName"></a> |
| 348 <h2>win32_getRealName</h2> | 347 <h2>win32_getRealName</h2> |
| 349 <b>win32_getRealName</b>(<i></i>) | 348 <b>win32_getRealName</b>(<i></i>) |
| 350 | |
| 351 <p> | 349 <p> |
| 352 Function to get the user's real name (aka. display name) under Win32. | 350 Function to get the user's real name (aka. display name) under Win32. |
| 353 </p> | 351 </p> |
| 352 | |
| 354 <dl> | 353 <dl> |
| 355 <dt>Return:</dt> | 354 <dt>Return:</dt> |
| 356 <dd> | 355 <dd> |
| 357 real name of the current user | 356 real name of the current user |
| 358 </dd> | 357 </dd> |
