1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
|
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lazutils">
<!--
====================================================================
UTF8Process
====================================================================
-->
<module name="UTF8Process">
<short>Defines a version of FPC TProcess that allows UTF-8-encoded arguments</short>
<descr></descr>
<!-- class Visibility: default -->
<element name="TProcessUTF8" link="#fcl.Process.TProcess">
<short>
Implements a version of FPC TProcess that allows UTF-8-encoded arguments
</short>
<descr></descr>
<errors></errors>
<seealso></seealso>
</element>
<!-- variable Visibility: private -->
<element name="TProcessUTF8.FApplicationNameUTF8" link="#fcl.Process.TProcess.ApplicationName">
<short></short>
</element>
<!-- variable Visibility: private -->
<element name="TProcessUTF8.FCommandLineUTF8" link="#fcl.Process.TProcess.CommandLine">
<short></short>
</element>
<!-- variable Visibility: private -->
<element name="TProcessUTF8.FConsoleTitleUTF8" link="#fcl.Process.TProcess.ConsoleTitle">
<short></short>
</element>
<!-- variable Visibility: private -->
<element name="TProcessUTF8.FCurrentDirectoryUTF8" link="#fcl.Process.TProcess.CurrentDirectory">
<short></short>
</element>
<!-- variable Visibility: private -->
<element name="TProcessUTF8.FDesktopUTF8" link="#fcl.Process.TProcess.Desktop">
<short></short>
</element>
<!-- variable Visibility: private -->
<element name="TProcessUTF8.FEnvironmentUTF8" link="#fcl.Process.TProcess.Environment">
<short></short>
</element>
<!-- variable Visibility: private -->
<element name="TProcessUTF8.FExecutableUTF8" link="#fcl.Process.TProcess.Executable">
<short></short>
</element>
<!-- variable Visibility: private -->
<element name="TProcessUTF8.FParametersUTF8" link="#fcl.Process.TProcess.Parameters">
<short></short>
</element>
<!-- procedure Visibility: private -->
<element name="TProcessUTF8.SetApplicationNameUTF8" link="#fcl.Process.TProcess.ApplicationName">
<short></short>
<descr></descr>
<errors></errors>
<seealso></seealso>
</element>
<!-- argument Visibility: default -->
<element name="TProcessUTF8.SetApplicationNameUTF8.AValue">
<short></short>
</element>
<!-- procedure Visibility: private -->
<element name="TProcessUTF8.SetCommandLineUTF8" link="#fcl.Process.TProcess.CommandLine">
<short></short>
<descr>
<p>
SetCommandLineUTF8 is the write access specifier for the CommandLine property.
</p>
</descr>
<errors></errors>
<seealso></seealso>
</element>
<!-- argument Visibility: default -->
<element name="TProcessUTF8.SetCommandLineUTF8.AValue">
<short></short>
</element>
<!-- procedure Visibility: private -->
<element name="TProcessUTF8.SetConsoleTitleUTF8" link="#fcl.Process.TProcess.ConsoleTitle">
<short></short>
<descr></descr>
<errors></errors>
<seealso></seealso>
</element>
<!-- argument Visibility: default -->
<element name="TProcessUTF8.SetConsoleTitleUTF8.AValue">
<short></short>
</element>
<!-- procedure Visibility: private -->
<element name="TProcessUTF8.SetCurrentDirectoryUTF8" link="#fcl.Process.TProcess.CurrentDirectory">
<short></short>
<descr></descr>
<errors></errors>
<seealso></seealso>
</element>
<!-- argument Visibility: default -->
<element name="TProcessUTF8.SetCurrentDirectoryUTF8.AValue">
<short></short>
</element>
<!-- procedure Visibility: private -->
<element name="TProcessUTF8.SetDesktopUTF8" link="#fcl.Process.TProcess.Desktop">
<short></short>
<descr></descr>
<errors></errors>
<seealso></seealso>
</element>
<!-- argument Visibility: default -->
<element name="TProcessUTF8.SetDesktopUTF8.AValue">
<short></short>
</element>
<!-- procedure Visibility: private -->
<element name="TProcessUTF8.SetEnvironmentUTF8" link="#fcl.Process.TProcess.Environment">
<short></short>
<descr></descr>
<errors></errors>
<seealso></seealso>
</element>
<!-- argument Visibility: default -->
<element name="TProcessUTF8.SetEnvironmentUTF8.AValue">
<short></short>
</element>
<!-- procedure Visibility: private -->
<element name="TProcessUTF8.SetExecutableUTF8" link="#fcl.Process.TProcess.Executable">
<short></short>
<descr></descr>
<errors></errors>
<seealso></seealso>
</element>
<!-- argument Visibility: default -->
<element name="TProcessUTF8.SetExecutableUTF8.AValue">
<short></short>
</element>
<!-- procedure Visibility: private -->
<element name="TProcessUTF8.SetParametersUTF8" link="#fcl.Process.TProcess.Parameters">
<short></short>
<descr></descr>
<errors></errors>
<seealso></seealso>
</element>
<!-- argument Visibility: default -->
<element name="TProcessUTF8.SetParametersUTF8.AValue">
<short></short>
</element>
<!-- procedure Visibility: private -->
<element name="TProcessUTF8.UpdateEnvironment">
<short>
Ensure values in Environment and Parameters are updated in the ancestor class
</short>
<descr>
<p>
UpdateEnvironment ensures that UTF-8-encoded values in both the Environment and the Parameters properties are converted to system format, and stored in the ancestor class. UpdateEnvironment is used in Execute immediately prior to calling the inherited Execute method.
</p>
</descr>
<seealso></seealso>
</element>
<!-- constructor Visibility: public -->
<element name="TProcessUTF8.Create" link="#fcl.Process.TProcess.Create">
<short>
Constructor for the class instance
</short>
<descr>
<p>
Create is the constructor for the class instance, Create calls the inherited constructor using AOwner as the owner of the class instance. Create ensures that resources are allocated for the Environment and Parameters properties.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument Visibility: default -->
<element name="TProcessUTF8.Create.AOwner">
<short>Owner of the class instance</short>
</element>
<!-- destructor Visibility: public -->
<element name="TProcessUTF8.Destroy" link="#fcl.Process.TProcess.Destroy">
<short>
Destructor for the class instance
</short>
<descr>
<p>
Destroy is the destructor for the class instance. Destroy frees resource allocated for the Environment and Parameters properties. Destroy calls the inherited method.
</p>
</descr>
<seealso></seealso>
</element>
<!-- procedure Visibility: public -->
<element name="TProcessUTF8.Execute" link="#fcl.Process.TProcess.Execute">
<short>
Starts execution of the process
</short>
<descr>
<p>
Execute causes the Executable for the process to be started with the Parameters and Environment specified in the respective properties. Execute calls the UpdateEnvironment method to pass the values in Parameters and Environment to the ancestor class. Execute calls gthe inherited Execute method.
</p>
</descr>
<errors></errors>
<seealso></seealso>
</element>
<!-- property Visibility: public -->
<element name="TProcessUTF8.ApplicationName" link="#fcl.Process.TProcess.ApplicationName">
<short>
</short>
<descr>
<!-- Note: deprecated in TProcess 2.5.1-->
<remarks>
Please note that ApplicationName has been deprecated in TProcess (the ancestor class) since FPC version 2.5.1. ApplicationName has been superseded by the Executable and Parameters properties.
</remarks>
</descr>
<seealso></seealso>
</element>
<!-- property Visibility: public -->
<element name="TProcessUTF8.CommandLine" link="#fcl.Process.TProcess.CommandLine">
<short>
Command line with options to execute in the process
</short>
<descr>
<!-- Note: deprecated in TProcess 2.5.1-->
<p>
Setting the value in CommandLine causes the value in Executable to be updated, and the value in Parameters is cleared and reloaded as necessary.
</p>
<remarks>
Please note that CommandLine has been deprecated in TProcess (the ancestor class) since FPC version 2.5.1. To avoid problems with command line options with spaces in them, and the quoting problems that this entails, it has been superseded by the Executable and Parameters properties. Use these properties instead of CommandLine.
</remarks>
</descr>
<seealso></seealso>
</element>
<!-- property Visibility: public -->
<element name="TProcessUTF8.ConsoleTitle" link="#fcl.Process.TProcess.ConsoleTitle">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property Visibility: public -->
<element name="TProcessUTF8.CurrentDirectory" link="#fcl.Process.TProcess.CurrentDirectory">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property Visibility: public -->
<element name="TProcessUTF8.Desktop" link="#fcl.Process.TProcess.Desktop">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property Visibility: public -->
<element name="TProcessUTF8.Environment" link="#fcl.Process.TProcess.Environment">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property Visibility: public -->
<element name="TProcessUTF8.Executable" link="#fcl.Process.TProcess.Executable">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property Visibility: public -->
<element name="TProcessUTF8.Parameters" link="#fcl.Process.TProcess.Parameters">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TProcessUTF8.SetProcessHandle" link="#fcl.Process.TProcess.ProcessHandle">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TProcessUTF8.SetProcessHandle.aProcessHandle">
<short></short>
</element>
<element name="TProcessUTF8.SetThreadHandle" link="#fcl.Process.TProcess.ThreadHandle">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TProcessUTF8.SetThreadHandle.aThreadHandle">
<short></short>
</element>
<element name="TProcessUTF8.SetProcessID" link="#fcl.Process.TProcess.ProcessID">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TProcessUTF8.SetProcessID.aProcessID">
<short></short>
</element>
<element name="TProcessUTF8.ParseCmdLine">
<short>
Separates values in CommandLine into the Executable and Parameters properties
</short>
<descr>
<p>
ParseCmdLine is used to separate the values in CommandLine into the values used in the Executable and Parameters properties.
</p>
</descr>
<seealso></seealso>
</element>
<element name="TProcessUTF8.ParseCmdLine.CmdLine">
<short></short>
</element>
<element name="TProcessUTF8.ParseCmdLine.ReadBackslash">
<short></short>
</element>
<element name="SNoCommandLine">
<descr>
Exception message raised when a process has no executable or command-line
</descr>
</element>
<element name="SErrCannotExecute">
<descr>
Exception message raised when a process cannot be created for the executable or command-line
</descr>
</element>
<!-- procedure Visibility: default -->
<element name="RunCmdFromPath">
<short>
Executes a command found in the current PATH environment
</short>
<descr>
<p>
RunCmdFromPath is used to execute a command which can be found in the current PATH environment. For example, the following locates and executes the /bin/ls command with the specified arguments:
</p>
<code>
RunCmdFromPath('ls', '-l /home');
</code>
<p>
An exception will be raised if the program file cannot be located, or cannot be executed.
</p>
<p>
RunCmdFromPath creates an instance of TProcessUTF8 to execute the program using the specified arguments.
</p>
</descr>
<errors>
<dl>
<dt>EFOpenError</dt>
<dd>
Raised with the message in lrsProgramFileNotFound
</dd>
<dt>EFOpenError</dt>
<dd>
Raised with the message in lrsCanNotExecute
</dd>
</dl>
</errors>
<seealso></seealso>
</element>
<!-- argument Visibility: default -->
<element name="RunCmdFromPath.ProgramFilename">
<short>Name of the program to execute</short>
</element>
<!-- argument Visibility: default -->
<element name="RunCmdFromPath.CmdLineParameters">
<short>Command line parameters for the process</short>
</element>
<!-- function Visibility: default -->
<element name="FindFilenameOfCmd">
<short></short>
<descr></descr>
<errors></errors>
<seealso></seealso>
</element>
<!-- function result Visibility: default -->
<element name="FindFilenameOfCmd.Result">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="FindFilenameOfCmd.ProgramFilename">
<short></short>
</element>
<!-- function Visibility: default -->
<element name="GetSystemThreadCount">
<short>
Gets a default value for the number of threads on the system
</short>
<descr>
<p>
GetSystemThreadCount is an Integer function used to get the default value for the number of threads on the system. The implementation for GetSystemThreadCount is platform- and/or OS-specific. For the Windows environment, the total number of processors available (including logical hyperthreaded processors) are returned using the GetProcessAffinityMask API. When GetProcessAffinityMask is unavailable, the total number of processors from GetSystemInfo is used. For UNIX-like environments, either the sysconf or the fpsysctl function is used. For other environments, the value is 1.
</p>
</descr>
<seealso></seealso>
</element>
<element name="GetSystemThreadCount.Result">
<short>Default for the number of threads on the system</short>
</element>
<!-- procedure Visibility: default -->
<element name="Register">
<short></short>
</element>
</module>
<!-- UTF8Process -->
</package>
</fpdoc-descriptions>
|
