src/eric7/Documentation/Source/eric7.SystemUtilities.OSUtilities.html

branch
eric7
changeset 10431
64157aeb0312
parent 10340
548b4c7f410e
child 10479
856476537696
equal deleted inserted replaced
10430:e440aaf179ce 10431:64157aeb0312
83 <p> 83 <p>
84 Module function to get an environment entry. 84 Module function to get an environment entry.
85 </p> 85 </p>
86 <dl> 86 <dl>
87 87
88 <dt><i>key</i></dt> 88 <dt><i>key</i> (str)</dt>
89 <dd> 89 <dd>
90 key of the requested environment entry (string) 90 key of the requested environment entry
91 </dd> 91 </dd>
92 <dt><i>default</i></dt> 92 <dt><i>default</i> (str)</dt>
93 <dd> 93 <dd>
94 value to be returned, if the environment doesn't contain 94 value to be returned, if the environment doesn't contain the
95 the requested entry (string) 95 requested entry
96 </dd> 96 </dd>
97 </dl> 97 </dl>
98 <dl> 98 <dl>
99 <dt>Return:</dt> 99 <dt>Return:</dt>
100 <dd> 100 <dd>
101 the requested entry or the default value, if the entry wasn't 101 the requested entry or the default value, if the entry wasn't found
102 found (string or None) 102 </dd>
103 </dl>
104 <dl>
105 <dt>Return Type:</dt>
106 <dd>
107 str
103 </dd> 108 </dd>
104 </dl> 109 </dl>
105 <div align="right"><a href="#top">Up</a></div> 110 <div align="right"><a href="#top">Up</a></div>
106 <hr /> 111 <hr />
107 <hr /> 112 <hr />
113 Function to get a users home directory. 118 Function to get a users home directory.
114 </p> 119 </p>
115 <dl> 120 <dl>
116 <dt>Return:</dt> 121 <dt>Return:</dt>
117 <dd> 122 <dd>
118 home directory (string) 123 home directory
124 </dd>
125 </dl>
126 <dl>
127 <dt>Return Type:</dt>
128 <dd>
129 str
119 </dd> 130 </dd>
120 </dl> 131 </dl>
121 <div align="right"><a href="#top">Up</a></div> 132 <div align="right"><a href="#top">Up</a></div>
122 <hr /> 133 <hr />
123 <hr /> 134 <hr />
129 Function to get the real name of the user. 140 Function to get the real name of the user.
130 </p> 141 </p>
131 <dl> 142 <dl>
132 <dt>Return:</dt> 143 <dt>Return:</dt>
133 <dd> 144 <dd>
134 real name of the user (string) 145 real name of the user
146 </dd>
147 </dl>
148 <dl>
149 <dt>Return Type:</dt>
150 <dd>
151 str
135 </dd> 152 </dd>
136 </dl> 153 </dl>
137 <div align="right"><a href="#top">Up</a></div> 154 <div align="right"><a href="#top">Up</a></div>
138 <hr /> 155 <hr />
139 <hr /> 156 <hr />
145 Function to get the user name. 162 Function to get the user name.
146 </p> 163 </p>
147 <dl> 164 <dl>
148 <dt>Return:</dt> 165 <dt>Return:</dt>
149 <dd> 166 <dd>
150 user name (string) 167 user name
168 </dd>
169 </dl>
170 <dl>
171 <dt>Return Type:</dt>
172 <dd>
173 str
151 </dd> 174 </dd>
152 </dl> 175 </dl>
153 <div align="right"><a href="#top">Up</a></div> 176 <div align="right"><a href="#top">Up</a></div>
154 <hr /> 177 <hr />
155 <hr /> 178 <hr />
278 Function to get the user name under Win32. 301 Function to get the user name under Win32.
279 </p> 302 </p>
280 <dl> 303 <dl>
281 <dt>Return:</dt> 304 <dt>Return:</dt>
282 <dd> 305 <dd>
283 user name (string) 306 user name
307 </dd>
308 </dl>
309 <dl>
310 <dt>Return Type:</dt>
311 <dd>
312 str
284 </dd> 313 </dd>
285 </dl> 314 </dl>
286 <div align="right"><a href="#top">Up</a></div> 315 <div align="right"><a href="#top">Up</a></div>
287 <hr /> 316 <hr />
288 <hr /> 317 <hr />
293 <p> 322 <p>
294 Function to provide an os.kill equivalent for Win32. 323 Function to provide an os.kill equivalent for Win32.
295 </p> 324 </p>
296 <dl> 325 <dl>
297 326
298 <dt><i>pid</i></dt> 327 <dt><i>pid</i> (int)</dt>
299 <dd> 328 <dd>
300 process id (integer) 329 process id
301 </dd> 330 </dd>
302 </dl> 331 </dl>
303 <dl> 332 <dl>
304 <dt>Return:</dt> 333 <dt>Return:</dt>
305 <dd> 334 <dd>
306 result of the kill (boolean) 335 result of the kill
336 </dd>
337 </dl>
338 <dl>
339 <dt>Return Type:</dt>
340 <dd>
341 bool
307 </dd> 342 </dd>
308 </dl> 343 </dl>
309 <div align="right"><a href="#top">Up</a></div> 344 <div align="right"><a href="#top">Up</a></div>
310 <hr /> 345 <hr />
311 <hr /> 346 <hr />
317 Function to get the user's real name (aka. display name) under Win32. 352 Function to get the user's real name (aka. display name) under Win32.
318 </p> 353 </p>
319 <dl> 354 <dl>
320 <dt>Return:</dt> 355 <dt>Return:</dt>
321 <dd> 356 <dd>
322 real name of the current user (string) 357 real name of the current user
358 </dd>
359 </dl>
360 <dl>
361 <dt>Return Type:</dt>
362 <dd>
363 str
323 </dd> 364 </dd>
324 </dl> 365 </dl>
325 <div align="right"><a href="#top">Up</a></div> 366 <div align="right"><a href="#top">Up</a></div>
326 <hr /> 367 <hr />
327 </body></html> 368 </body></html>

eric ide

mercurial