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
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
<package name="rtl">
<!--
====================================================================
errors
====================================================================
-->
<module name="errors">
<short>Convert UNIX error codes to string message</short>
<descr>
The errors unit contains routines to convert a UNIX system call error code to an error
message: <link id="StrError"/>. It is only available on UNIX platforms.
</descr>
<!-- uses unit Visibility: default -->
<element name="unixtype">
<short>Basic unix types</short>
</element>
<!-- constant Visibility: default -->
<element name="sys_errn">
<short>Number of error codes</short>
<descr>
<var>sys_errn</var> is the number of error codes for the current operating system.
It should not be used directly, instead use <link id="StrError"/>.
</descr>
<seealso>
<link id="StrError"/>
</seealso>
</element>
<!-- constant Visibility: default -->
<element name="sys_errlist">
<short>Error codes in an array</short>
<descr>
<var>sys_errn</var> is an array with then error codes for the current operating system.
It should not be used directly, instead use <link id="StrError"/>.
</descr>
<seealso>
<link id="StrError"/>
</seealso>
</element>
<!-- function Visibility: default -->
<element name="StrError">
<short>Convert an error code to a string</short>
<descr>
<var>StrError</var> will convert the error code <var>err</var> to a string.
</descr>
<errors>
If the error code is unknown or out of bounds, an 'Unknown error (err)' string
will be returned.
</errors>
<seealso>
<link id="PError"/>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="StrError.Result">
<short>Error message corresponding to error code <var>Err</var></short>
</element>
<!-- argument Visibility: default -->
<element name="StrError.err">
<short>Error code to return string from</short>
</element>
<!-- procedure Visibility: default -->
<element name="PError">
<short>Print error on standard error output</short>
<descr>
<var>PError</var> will print the error message <var>S</var> followed by the
<var>errNo</var> and the result for <var>StrError(errNo)</var> for
<var>ErrNo</var> on standard output.
</descr>
<errors>
None.
</errors>
<seealso>
<link id="StrError"/>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="PError.s">
<short>Short message to print before error number</short>
</element>
<!-- argument Visibility: default -->
<element name="PError.Errno">
<short>Error number to print, followed by corresponding error text</short>
</element>
</module> <!-- errors -->
</package>
</fpdoc-descriptions>
|
