paweld/fpc
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/fpc/source.git synced 2025-09-11 00:10:11 +02:00
Code Issues Packages Projects Releases Wiki Activity

+ Updates for missing identifiers

Browse Source
This commit is contained in:
michael 2004-12-10 00:40:16 +00:00
parent f7a1ba2fe0
commit 46de50bee4
7 changed files with 8404 additions and 510 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

408
docs/baseunix.xml
View File

@ -1124,6 +1124,50 @@ implement the functionality in this unit for the new platform.
<short>Pointer to <link id="TOff64"/> type.</short>
</element>
<element name="MAP_PRIVATE">
<short><link id="FpMMap"/> map type: Changes are private</short>
</element>
<element name="MAP_ANONYMOUS">
<short><link id="FpMMap"/> map type: Don't use a file</short>
</element>
<element name="MAP_GROWSDOWN">
<short><link id="FpMMap"/> option: Memory grows downward (like a stack)</short>
</element>
<element name="MAP_DENYWRITE">
<short><link id="FpMMap"/> option: Ignored.</short>
</element>
<element name="MAP_EXECUTABLE">
<short><link id="FpMMap"/> option: Ignored.</short>
</element>
<element name="MAP_LOCKED">
<short><link id="FpMMap"/> option: lock the pages in memory.</short>
</element>
<element name="MAP_NORESERVE">
<short><link id="FpMMap"/> option: Do not reserve swap pages for this memory.</short>
</element>
<element name="MAP_SHARED">
<short><link id="FpMMap"/> map type: Share changes</short>
</element>
<element name="MAP_TYPE">
<short><link id="FpMMap"/> map type: Bitmask for type of mapping</short>
</element>
<element name="MAP_FIXED">
<short><link id="FpMMap"/> map type: Interpret addr exactly</short>
</element>
<element name="PROT_READ">
<short><link id="FpMMap"/> memory access: page can be read</short>
</element>
<element name="PROT_WRITE">
<short><link id="FpMMap"/> memory access: page can be written</short>
</element>
<element name="PROT_EXEC">
<short><link id="FpMMap"/> memory access: page can be executed</short>
</element>
<element name="PROT_NONE">
<short><link id="FpMMap"/> memory access: page can not be accessed</short>
</element>
<element name="utsname">
<short>Record used to return kernel information in <link id="fpUName"/> function.</short>
<descr>
@ -1536,12 +1580,12 @@ directly.
<!-- constant Visibility: default -->
<element name="WNOHANG">
<short><link id="fpWaitpid"/> option: Do not wait for processes to terminate.</short>
<short><link id="#rtl.baseunix.fpWaitpid"/> option: Do not wait for processes to terminate.</short>
</element>
<!-- constant Visibility: default -->
<element name="WUNTRACED">
<short><link id="fpWaitpid"/> option: Also report children wich were stopped but not yet reported</short>
<short><link id="#rtl.baseunix.fpWaitpid"/> option: Also report children wich were stopped but not yet reported</short>
</element>
<element name="F_GetFd">
@ -2043,7 +2087,7 @@ entry.</dd>
</dl>
</errors>
<seealso>
<link id="#rtl.unix.fpSymLink"/>
<link id="fpSymLink"/>
<link id="fpUnLink"/>
</seealso>
<example file="bunixex/ex21"/>
@ -3159,7 +3203,7 @@ directory containing it.</dd>
</errors>
<seealso>
<link id="FpLink"/>
<link id="#rtl.unix.FpSymLink"/>
<link id="FpSymLink"/>
</seealso>
</element>
@ -3274,7 +3318,7 @@ Extended error information can be retrieved using <link id="fpGetErrno"/>.
</errors>
<seealso>
<link id="FpStat"/>
<link id="#rtl.unix.FpLStat"/>
<link id="FpLStat"/>
</seealso>
<example file="bunixex/ex28"/>
</element>
@ -3301,7 +3345,7 @@ Extended error information can be retrieved using <link id="fpGetErrno"/>.
</errors>
<seealso>
<link id="FpStat"/>
<link id="#rtl.unix.FpLStat"/>
<link id="FpLStat"/>
</seealso>
<example file="bunixex/ex28"/>
</element>
@ -4224,6 +4268,358 @@ call this function.
</seealso>
</element>
<!-- function Visibility: default -->
<element name="FpMMap">
<short>Create memory map of a file</short>
<descr>
<p>
<var>FpMMap</var> maps or unmaps files or devices into memory. The different
arguments determine what and how the file is mapped:
</p>
<dl>
<dt>adr</dt>
<dd> Address where to mmap the device. This address is a hint,
and may not be followed.</dd>
<dt>len</dt><dd> Size (in bytes) of area to be mapped.</dd>
<dt>prot</dt>
<dd>
<p> Protection of mapped memory. This is a OR-ed combination of the
following constants:</p>
<dl>
<dt>PROT_EXEC</dt><dd> The memory can be executed.</dd>
<dt>PROT_READ</dt><dd> The memory can be read.</dd>
<dt>PROT_WRITE</dt><dd> The memory can be written.</dd>
<dt>PROT_NONE</dt><dd> The memory can not be accessed.</dd>
</dl>
</dd>
<dt>flags</dt><dd><p>Contains some options for the mmap call. It is an OR-ed
combination of the following constants:</p>
<dl>
<dt>MAP_FIXED</dt>
<dd> Do not map at another address than the given address. If the
address cannot be used, <var>MMap</var> will fail.</dd>
<dt>MAP_SHARED</dt>
<dd> Share this map with other processes that map this object.</dd>
<dt>MAP_PRIVATE</dt>
<dd> Create a private map with copy-on-write semantics.</dd>
<dt>MAP_ANONYMOUS</dt>
<dd> <var>fd</var> does not have to be a file descriptor.</dd>
</dl>
<p>
One of the options <var>MAP_SHARED</var> and <var>MAP_PRIVATE</var> must be present,
but not both at the same time.
</p>
</dd>
<dt>fd</dt><dd> File descriptor from which to map.</dd>
<dt>off</dt><dd> Offset to be used in file descriptor <var>fd</var>.</dd>
</dl>
<p>
The function returns a pointer to the mapped memory, or a -1 in case of en
error.
</p>
</descr>
<errors>
<p>
On error, -1 is returned and extended error information is returned by the <link id="fpGetErrno">FpGetErrno</link> function.
</p>
<dl>
<dt>Sys_EBADF</dt>
<dd> <var>fd</var> is not a valid file descriptor and
<var>MAP_ANONYMOUS</var> was not specified.</dd>
<dt>Sys_EACCES</dt>
<dd><var>MAP_PRIVATE</var> was specified, but <var>fd</var> is not open for
reading. Or <var>MAP_SHARED</var> was asked and <var>PROT_WRITE</var> is set, fd
is not open for writing</dd>
<dt>Sys_EINVAL</dt>
<dd> One of the record fields <var>Start</var>, <var>length</var> or
<var>offset</var> is invalid.</dd>
<dt>Sys_ETXTBUSY</dt>
<dd><var>MAP_DENYWRITE</var> was set but the object specified
by fd is open for writing.</dd>
<dt>Sys_EAGAIN</dt>
<dd><var>fd</var> is locked, or too much memory is locked.</dd>
<dt>Sys_ENOMEM</dt>
<dd> Not enough memory for this operation.</dd>
</dl>
</errors>
<seealso>
<link id="FpMUnMap"/>
</seealso>
<example file="unixex/ex66"/>
</element>
<!-- function Visibility: default -->
<element name="Fpmunmap">
<short>Unmap previously mapped memory block</short>
<descr>
<p>
<var>FpMUnMap</var> unmaps the memory block of size <var>Len</var>, pointed to by
<var>Adr</var>, which was previously allocated with <link id="FpMMap"/>.
</p>
<p>
The function returns <var>True</var> if successful, <var>False</var> otherwise.
</p>
<p>
For an example, see <link id="FpMMap"/>.
</p>
</descr>
<errors>
In case of error the function returns a nonzero value,
extended error information is returned by the <link id="fpGetErrno">FpGetErrno</link> function.
See <link id="FpMMap"/> for possible error values.
</errors>
<seealso>
<link id="FpMMap"/>
</seealso>
</element>
<!-- function Visibility: default -->
<element name="fpLstat">
<short>Return information about symbolic link. Do not follow the link</short>
<descr>
<var>FpLstat</var> gets information about the link specified in <var>Path</var>
(or <var>FileName</var>, and stores it in <var>Info</var>, which points to a
record of type <var>TStat</var>. Contrary to <link id="FpFStat">FpFstat</link>, it stores
information about the link, not about the file the link points to.
The function returns zero if the call was succesful, a nonzero return value
indicates failure.
failed.
</descr>
<errors>
<p>
Extended error information is returned by the <link id="fpGetErrno">FpGetErrno</link>
function.
</p>
<dl>
<dt>sys_enoent</dt><dd> <var>Path</var> does not exist.</dd>
</dl>
</errors>
<seealso>
<link id="FpFStat"/>
<link id="#rtl.unix.StatFS"/>
</seealso>
<example file="unixex/ex29"/>
</element>
<!-- function Visibility: default -->
<element name="fpNice">
<short>Set process priority</short>
<descr>
<p>
<var>Nice</var> adds <var>-N</var> to the priority of the running process. The lower the
priority numerically, the less the process is favored.
Only the superuser can specify a negative <var>N</var>, i.e. increase the rate at
which the process is run.
</p>
<p>
If the function is succesful, zero is returned. On error, a nonzero value is returned.
</p>
</descr>
<errors>
<p>
Extended error information is returned by the <link id="fpGetErrno">FpGetErrno</link> function.
</p>
<dl>
<dt>sys_eperm</dt><dd> A non-superuser tried to specify a negative <var>N</var>, i.e.
do a priority increase.</dd>
</dl>
</errors>
<seealso>
<link id="FpGetPriority"/>
<link id="FpSetPriority"/>
</seealso>
<example file="unixex/ex15"/>
</element>
<!-- function Visibility: default -->
<element name="fpGetPriority">
<short>Return process priority</short>
<descr>
<p>
GetPriority returns the priority with which a process is running.
Which process(es) is determined by the <var>Which</var> and <var>Who</var> variables.
<var>Which</var> can be one of the pre-defined <var>Prio_Process</var>,
<var>Prio_PGrp</var>, <var>Prio_User</var>, in which case <var>Who</var> is the process ID, Process group ID or
User ID, respectively.
</p>
<p>
For an example, see <link id="FpNice"/>.
</p>
</descr>
<errors>
<p>
Error information is returned solely by the <link id="fpGetErrno">FpGetErrno</link>
function: a priority can be a positive or negative value.
</p>
<dl>
<dt>sys_esrch</dt>
<dd> No process found using <var>which</var> and <var>who</var>. </dd>
<dt>sys_einval</dt>
<dd> <var>Which</var> was not one of <var>Prio_Process</var>,
<var>Prio_Grp</var> or <var>Prio_User</var>.</dd>
</dl>
</errors>
<seealso>
<link id="FpSetPriority"/>
<link id="FpNice"/>
</seealso>
</element>
<!-- function Visibility: default -->
<element name="fpSetPriority">
<short>Set process priority</short>
<descr>
<p>
<var>fpSetPriority</var> sets the priority with which a process is running.
Which process(es) is determined by the <var>Which</var> and <var>Who</var> variables.
<var>Which</var> can be one of the pre-defined constants:
</p>
<dl>
<dt>Prio_Process</dt><dd><var>Who</var> is interpreted as process ID</dd>
<dt>Prio_PGrp</dt><dd><var>Who</var> is interpreted as process group ID</dd>
<dt>Prio_User</dt><dd><var>Who</var> is interpreted as user ID</dd>
</dl>
<p>
<var>Prio</var> is a value in the range -20 to 20.
</p>
<p>
For an example, see <link id="FpNice"/>.
</p>
<p>
The function returns zero on success, -1 on failure
</p>
</descr>
<errors>
<p>
Extended error information is returned by the <link id="fpGetErrno">FpGetErrno</link>
function.
</p>
<dl>
<dt>sys_esrch</dt>
<dd>No process found using <var>which</var> and <var>who</var>.</dd>
<dt>sys_einval</dt>
<dd> <var>Which</var> was not one of <var>Prio_Process</var>,
<var>Prio_Grp</var> or <var>Prio_User</var>.</dd>
<dt>sys_eperm</dt>
<dd>A process was found, but neither its effective or real
user ID match the effective user ID of the caller.</dd>
<dt>sys_eacces</dt>
<dd>A non-superuser tried to a priority increase.</dd>
</dl>
</errors>
<seealso>
<link id="FpGetPriority"/>
<link id="FpNice"/>
</seealso>
</element>
<!-- function Visibility: default -->
<element name="fpSymlink">
<short>Create a symbolic link</short>
<descr>
<p>
<var>SymLink</var> makes <var>NewName</var> point to the file in
<var>OldName</var>, which doesn't necessarily exist. The two files
DO NOT have the same inode number. This is known as a 'soft' link.
</p>
<p>The permissions of the link are irrelevant, as they are not used when
following the link. Ownership of the file is only checked in case of removal
or renaming of the link.
</p>
<p>
The function returns zero if the call was succesful, a nonzero value if the call
failed.
</p>
</descr>
<errors>
<p>
Extended error information is returned by the <link id="fpGetErrno">FpGetErrno</link>
function.
</p>
<dl>
<dt>sys_eperm</dt>
<dd>The filesystem containing oldpath and newpath does not
support linking files.</dd>
<dt>sys_eaccess</dt>
<dd>Write access for the directory containing <var>Newpath</var>
is disallowed, or one of the directories in <var>OldPath</var> or
<var>NewPath</var> has no search (=execute) permission.</dd>
<dt>sys_enoent</dt>
<dd>A directory entry in <var>OldPath</var> or <var>NewPath</var> does
not exist or is a symbolic link pointing to a non-existent directory.</dd>
<dt>sys_enotdir</dt>
<dd>A directory entry in <var>OldPath</var> or <var>NewPath</var> is
nor a directory.</dd>
<dt>sys_enomem</dt><dd>Insufficient kernel memory.</dd>
<dt>sys_erofs</dt><dd>The files are on a read-only filesystem.</dd>
<dt>sys_eexist</dt><dd><var>NewPath</var> already exists.</dd>
<dt>sys_eloop</dt>
<dd> <var>OldPath</var> or <var>NewPath</var> has a reference to a circular
symbolic link, i.e. a symbolic link, whose expansion points to itself.
</dd>
<dt>sys_enospc</dt>
<dd>The device containing <var>NewPath</var> has no room for another entry.</dd>
</dl>
</errors>
<seealso>
<link id="FpLink"/>
<link id="FpUnLink"/>
<link id="FpReadLink"/>
</seealso>
<example file="unixex/ex22"/>
</element>
<!-- function Visibility: default -->
<element name="fpReadLink">
<short>Read destination of symbolic link</short>
<descr>
<p>
<var>FpReadLink</var> returns the file the symbolic link <var>name</var> is pointing
to. The first form of this function accepts a buffer <var>linkname</var> of
length <var>maxlen</var> where the filename will be stored. It returns the
actual number of characters stored in the buffer.
</p>
<p>
The second form of the function returns simply the name of the file.
</p>
</descr>
<errors>
<p>
On error, the first form of the function returns -1; the second one returns
an empty string.
Extended error information is returned by the <link id="fpGetErrno">FpGetErrno</link>
function.
</p>
<dl>
<dt>SYS_ENOTDIR</dt>
<dd>A part of the path in <var>Name</var> is not a directory.</dd>
<dt>SYS_EINVAL</dt>
<dd>maxlen is not positive, or the file is not a symbolic link.</dd>
<dt>SYS_ENAMETOOLONG</dt>
<dd>A pathname, or a component of a pathname, was too long.</dd>
<dt>SYS_ENOENT</dt>
<dd>the link <var>name</var> does not exist.</dd>
<dt>SYS_EACCES</dt>
<dd>No permission to search a directory in the path</dd>
<dt>SYS_ELOOP</dt>
<dd>Too many symbolic links were encountered in translating the pathname.</dd>
<dt>SYS_EIO</dt>
<dd>An I/O error occurred while reading from the file system.</dd>
<dt>SYS_EFAULT</dt>
<dd>The buffer is not part of the the process's memory space.</dd>
<dt>SYS_ENOMEM</dt>
<dd>Not enough kernel memory was available.</dd>
</dl>
</errors>
<seealso>
<link id="FpSymLink"/>
</seealso>
<example file="unixex/ex62"/>
</element>
</module> <!-- BaseUnix -->
</package>
</fpdoc-descriptions>

583
docs/math.xml
View File

@ -209,7 +209,7 @@ is used in functions that accept an array of values of arbitrary length.
</element>
<element name="arccos">
<short></short>
<short>Return inverse cosine</short>
<descr>
<var>Arccos</var> returns the inverse cosine of its argument <var>x</var>. The
argument <var>x</var> should lie between -1 and 1 (borders included).
@ -228,7 +228,7 @@ If the argument <var>x</var> is not in the allowed range, an
</element>
<element name="arcosh">
<short></short>
<short>Return inverse hyperbolic cosine</short>
<descr>
<var>Arcosh</var> returns the inverse hyperbolic cosine of its argument <var>x</var>.
The argument <var>x</var> should be larger than 1.
@ -252,7 +252,7 @@ exception is raised.
</element>
<element name="arcsin">
<short></short>
<short>Return inverse sine</short>
<descr>
<var>Arcsin</var> returns the inverse sine of its argument <var>x</var>. The
argument <var>x</var> should lie between -1 and 1.
@ -272,7 +272,7 @@ exception is raised.
<element name="arctan2">
<short></short>
<short>Return arctangent of (y/x)</short>
<descr>
<var>arctan2</var> calculates <var>arctan(y/x)</var>, and returns an angle in the
correct quadrant. The returned angle will be in the range $-\pi$ to
@ -296,7 +296,7 @@ If <var>x</var> is zero, an overflow error will occur.
</element>
<element name="arsinh">
<short></short>
<short>Return inverse hyperbolic sine</short>
<descr>
<var>arsinh</var> returns the inverse hyperbolic sine of its argument <var>x</var>.
@ -317,7 +317,7 @@ None.
<element name="artanh">
<short></short>
<short>Return inverse hyperbolic tangent</short>
<descr>
<var>artanh</var> returns the inverse hyperbolic tangent of its argument <var>x</var>,
where <var>x</var> should lie in the interval [-1,1], borders included.
@ -339,7 +339,7 @@ exception is raised.
<element name="ceil">
<short></short>
<short>Return the lowest integer number greater than or equal to argument</short>
<descr>
<var>Ceil</var> returns the lowest integer number greater than or equal to <var>x</var>.
The absolute value of <var>x</var> should be less than <var>maxint</var>.
@ -355,7 +355,7 @@ occur.
</element>
<element name="cosh">
<short></short>
<short>Return hyperbolic cosine</short>
<descr>
<var>Cosh</var> returns the hyperbolic cosine of it's argument {x}.
</descr>
@ -372,7 +372,7 @@ None.
<element name="cotan">
<short></short>
<short>Return cotangent</short>
<descr>
<var>Cotan</var> returns the cotangent of it's argument <var>x</var>. <var>x</var> should
be different from zero.
@ -388,7 +388,7 @@ If <var>x</var> is zero then a overflow error will occur.
<element name="cycletorad">
<short></short>
<short>Convert cycle angle to radians angle</short>
<descr>
<var>Cycletorad</var> transforms it's argument <var>cycle</var>
(an angle expressed in cycles) to radians.
@ -409,7 +409,7 @@ None.
<element name="degtograd">
<short></short>
<short>Convert degree angle to grads angle</short>
<descr>
<var>Degtograd</var> transforms it's argument <var>deg</var> (an angle in degrees)
to grads.
@ -431,7 +431,7 @@ None.
<element name="degtorad">
<short></short>
<short>Convert degree angle to radians angle.</short>
<descr>
<var>Degtorad</var> converts it's argument <var>deg</var> (an angle in degrees) to
radians.
@ -453,7 +453,7 @@ None.
<element name="floor">
<short></short>
<short>Return the largest integer smaller than or equal to argument</short>
<descr>
<var>Floor</var> returns the largest integer smaller than or equal to <var>x</var>.
The absolute value of <var>x</var> should be less than <var>maxint</var>.
@ -469,7 +469,7 @@ If <var>x</var> is larger than <var>maxint</var>, an overflow will occur.
<element name="frexp">
<short></short>
<short>Return mantissa and exponent.</short>
<descr>
<var>Frexp</var> returns the mantissa and exponent of it's argument
<var>x</var> in <var>mantissa</var> and <var>exponent</var>.
@ -484,7 +484,7 @@ None
<element name="gradtodeg">
<short></short>
<short>Convert grads angle to degrees angle</short>
<descr>
<var>Gradtodeg</var> converts its argument <var>grad</var> (an angle in grads)
to degrees.
@ -507,7 +507,7 @@ None.
<element name="gradtorad">
<short></short>
<short>Convert grads angle to radians angle</short>
<descr>
<var>Gradtorad</var> converts its argument <var>grad</var> (an angle in grads)
to radians.
@ -530,7 +530,7 @@ None.
<element name="hypot">
<short></short>
<short>Return hypotenuse of triangle</short>
<descr>
<var>Hypot</var> returns the hypotenuse of the triangle where the sides
adjacent to the square angle have lengths <var>x</var> and <var>y</var>.
@ -547,7 +547,7 @@ None.
<element name="intpower">
<short></short>
<short>Return integer power.</short>
<descr>
<var>Intpower</var> returns <var>base</var> to the power <var>exponent</var>,
where exponent is an integer value.
@ -564,9 +564,9 @@ overflow error will occur.
<element name="ldexp">
<short></short>
<short>Return (2 to the power p) times x</short>
<descr>
<var>Ldexp</var> returns $2^p x$.
<var>Ldexp</var> returns (2 to the power <var>p</var>) times <var>x</var>.
</descr>
<errors>
None.
@ -582,7 +582,7 @@ None.
<element name="lnxp1">
<short></short>
<short>Return natural logarithm of 1+X</short>
<descr>
<var>Lnxp1</var> returns the natural logarithm of <var>1+X</var>. The result
is more precise for small values of <var>x</var>. <var>x</var> should be larger
@ -601,7 +601,7 @@ If $x\leq -1$ then an <var>EInvalidArgument</var> exception will be raised.
</element>
<element name="log10">
<short></short>
<short>Return 10-Based logarithm.</short>
<descr>
<var>Log10</var> returns the 10-base logarithm of <var>X</var>.
</descr>
@ -620,7 +620,7 @@ will occur.
<element name="log2">
<short></short>
<short>Return 2-based logarithm</short>
<descr>
<var>Log2</var> returns the 2-base logarithm of <var>X</var>.
</descr>
@ -639,7 +639,7 @@ will occur.
<element name="logn">
<short></short>
<short>Return N-based logarithm.</short>
<descr>
<var>Logn</var> returns the n-base logarithm of <var>X</var>.
</descr>
@ -657,7 +657,7 @@ will occur.
</element>
<element name="max">
<short></short>
<short>Return largest of 2 values</short>
<descr>
<var>Max</var> returns the maximum of <var>Int1</var> and <var>Int2</var>.
</descr>
@ -673,13 +673,16 @@ None.
</element>
<element name="maxIntValue">
<short></short>
<short>Return largest element in integer array</short>
<descr>
<p>
<var>MaxIntValue</var> returns the largest integer out of the <var>Data</var>
array.
</p>
<p>
This function is provided for Delphi compatibility, use the <link id="maxvalue"/>
function instead.
</p>
</descr>
<errors>
None.
@ -694,14 +697,17 @@ None.
<element name="maxvalue">
<short></short>
<short>Return largest value in array</short>
<descr>
<p>
<var>Maxvalue</var> returns the largest value in the <var>data</var>
array with integer or float values. The return value has
the same type as the elements of the array.
</p>
<p>
The third and fourth forms accept a pointer to an array of <var>N</var>
integer or float values.
</p>
</descr>
<errors>
None.
@ -715,7 +721,7 @@ None.
</element>
<element name="mean">
<short></short>
<short>Return mean value of array</short>
<descr>
<var>Mean</var> returns the average value of <var>data</var>.
@ -733,7 +739,7 @@ None.
</element>
<element name="meanandstddev">
<short></short>
<short>Return mean and standard deviation of array</short>
<descr>
<var>meanandstddev</var> calculates the mean and standard deviation of <var>data</var>
and returns the result in <var>mean</var> and <var>stddev</var>, respectively.
@ -755,7 +761,7 @@ None.
<element name="min">
<short></short>
<short>Return smallest of two values.</short>
<descr>
<var>min</var> returns the smallest value of <var>Int1</var> and <var>Int2</var>;
</descr>
@ -769,12 +775,15 @@ None.
</element>
<element name="minIntValue">
<short></short>
<short>Return smallest value in integer array</short>
<descr>
<p>
<var>MinIntvalue</var> returns the smallest value in the <var>Data</var> array.
</p>
<p>
This function is provided for Delphi compatibility, use <var>minvalue</var>
instead.
</p>
</descr>
<errors>
None
@ -789,14 +798,17 @@ None
<element name="minvalue">
<short></short>
<short>Return smallest value in array</short>
<descr>
<p>
<var>Minvalue</var> returns the smallest value in the <var>data</var>
array with integer or float values. The return value has
the same type as the elements of the array.
</p>
<p>
The third and fourth forms accept a pointer to an array of <var>N</var>
integer or float values.
</p>
</descr>
<errors>
None.
@ -811,7 +823,7 @@ None.
<element name="momentskewkurtosis">
<short></short>
<short>Return 4 first moments of distribution</short>
<descr>
<var>momentskewkurtosis</var> calculates the 4 first moments of the distribution
of valuesin <var>data</var> and returns them in <var>m1</var>,<var>m2</var>,<var>m3</var> and
@ -828,12 +840,15 @@ None.
</element>
<element name="norm">
<short></short>
<short>Return Euclidian norm</short>
<descr>
<p>
<var>Norm</var> calculates the Euclidian norm of the array of data.
This equals <var>sqrt(sumofsquares(data))</var>.
</p>
<p>
The second form accepts a pointer to an array of <var>N</var> values.
</p>
</descr>
<errors>
None.
@ -846,13 +861,16 @@ None.
<element name="popnstddev">
<short></short>
<short>Return population variance</short>
<descr>
<p>
<var>Popnstddev</var> returns the square root of the population variance of
the values in the <var>Data</var> array. It returns zero if there is only one value.
</p>
<p>
The second form of this function accepts a pointer to an array of <var>N</var>
values.
</p>
</descr>
<errors>
None.
@ -861,7 +879,7 @@ None.
<link id="popnvariance"/>
<link id="mean"/>
<link id="meanandstddev"/>
<link id="stddev"/>,
<link id="stddev"/>
<link id="momentskewkurtosis"/>
</seealso>
<example file="mathex/ex35"/>
@ -869,13 +887,16 @@ None.
<element name="popnvariance">
<short></short>
<short>Return population variance</short>
<descr>
<p>
<var>Popnvariance</var> returns the square root of the population variance of
the values in the <var>Data</var> array. It returns zero if there is only one value.
</p>
<p>
The second form of this function accepts a pointer to an array of <var>N</var>
values.
</p>
</descr>
<errors>
None.
@ -892,7 +913,7 @@ None.
<element name="power">
<short></short>
<short>Return real power.</short>
<descr>
<var>power</var> raises <var>base</var> to the power <var>power</var>. This is equivalent
to <var>exp(power*ln(base))</var>. Therefore <var>base</var> should be non-negative.
@ -908,12 +929,15 @@ None.
<element name="radtocycle">
<short></short>
<short>Convert radians angle to cycle angle</short>
<descr>
<p>
<var>Radtocycle</var> converts its argument <var>rad</var> (an angle expressed in
radians) to an angle in cycles.
(1 cycle equals 2 pi radians)
</p>
<p>
(1 cycle equals 2 <var>pi</var> radians)
</p>
</descr>
<errors>
None.
@ -930,7 +954,7 @@ None.
<element name="radtodeg">
<short></short>
<short>Convert radians angle to degrees angle</short>
<descr>
<var>Radtodeg</var> converts its argument <var>rad</var> (an angle expressed in
radians) to an angle in degrees.
@ -952,12 +976,15 @@ None.
<element name="radtograd">
<short></short>
<short>Convert radians angle to grads angle</short>
<descr>
<p>
<var>Radtodeg</var> converts its argument <var>rad</var> (an angle expressed in
radians) to an angle in grads.
</p>
<p>
(200 grads equals pi radians)
</p>
</descr>
<errors>
None.
@ -974,7 +1001,7 @@ None.
<element name="randg">
<short></short>
<short>Return gaussian distributed random number.</short>
<descr>
<var>randg</var> returns a random number which - when produced in large
quantities - has a Gaussian distribution with mean <var>mean</var> and
@ -993,13 +1020,16 @@ None.
<element name="sincos">
<short></short>
<short>Return sine and cosine of argument</short>
<descr>
<p>
<var>Sincos</var> calculates the sine and cosine of the angle <var>theta</var>,
and returns the result in <var>sinus</var> and <var>cosinus</var>.
</p>
<p>
On Intel hardware, This calculation will be faster than making 2 calls
to clculatet he sine and cosine separately.
to calculate the sine and cosine separately.
</p>
</descr>
<errors>
None.
@ -1013,7 +1043,7 @@ None.
<element name="sinh">
<short></short>
<short>Return hyperbolic sine</short>
<descr>
<var>Sinh</var> returns the hyperbolic sine of its argument <var>x</var>.
</descr>
@ -1030,13 +1060,16 @@ None.
<element name="stddev">
<short></short>
<short>Return standard deviation of data</short>
<descr>
<p>
<var>Stddev</var> returns the standard deviation of the values in <var>Data</var>.
It returns zero if there is only one value.
</p>
<p>
The second form of the function accepts a pointer to an array of <var>N</var>
values.
</p>
</descr>
<errors>
None.
@ -1052,12 +1085,15 @@ None.
<element name="sum">
<short></short>
<short>Return sum of values</short>
<descr>
<p>
<var>Sum</var> returns the sum of the values in the <var>data</var> array.
</p>
<p>
The second form of the function accepts a pointer to an array of <var>N</var>
values.
</p>
</descr>
<errors>
None.
@ -1066,20 +1102,23 @@ None.
<link id="sumofsquares"/>
<link id="sumsandsquares"/>
<link id="totalvariance"/>
, <link id="variance"/>
<link id="variance"/>
</seealso>
<example file="mathex/ex44"/>
</element>
<element name="sumofsquares">
<short></short>
<short>Return sum of squares of values</short>
<descr>
<p>
<var>Sumofsquares</var> returns the sum of the squares of the values in the <var>data</var>
array.
</p>
<p>
The second form of the function accepts a pointer to an array of <var>N</var>
values.
</p>
</descr>
<errors>
None.
@ -1088,21 +1127,24 @@ None.
<link id="sum"/>
<link id="sumsandsquares"/>
<link id="totalvariance"/>
, <link id="variance"/>
<link id="variance"/>
</seealso>
<example file="mathex/ex45"/>
</element>
<element name="sumsandsquares">
<short></short>
<short>Return sum and sum of squares of values.</short>
<descr>
<p>
<var>sumsandsquares</var> calculates the sum of the values and the sum of
the squares of the values in the <var>data</var> array and returns the
results in <var>sum</var> and <var>sumofsquares</var>.
</p>
<p>
The second form of the function accepts a pointer to an array of <var>N</var>
values.
</p>
</descr>
<errors>
None.
@ -1111,14 +1153,14 @@ None.
<link id="sum"/>
<link id="sumofsquares"/>
<link id="totalvariance"/>
, <link id="variance"/>
<link id="variance"/>
</seealso>
<example file="mathex/ex46"/>
</element>
<element name="tan">
<short></short>
<short>Return tangent</short>
<descr>
<var>Tan</var> returns the tangent of <var>x</var>.
</descr>
@ -1136,7 +1178,7 @@ If <var>x</var> (normalized) is pi/2 or 3pi/2 then an overflow will occur.
<element name="tanh">
<short></short>
<short>Return hyperbolic tangent</short>
<descr>
<var>Tanh</var> returns the hyperbolic tangent of <var>x</var>.
</descr>
@ -1153,13 +1195,16 @@ None.
<element name="totalvariance">
<short></short>
<short>Return total varians of values</short>
<descr>
<p>
<var>TotalVariance</var> returns the total variance of the values in the
<var>data</var> array. It returns zero if there is only one value.
</p>
<p>
The second form of the function accepts a pointer to an array of <var>N</var>
values.
</p>
</descr>
<errors>
None.
@ -1174,13 +1219,16 @@ None.
<element name="variance">
<short></short>
<short>Return variance of values</short>
<descr>
<p>
<var>Variance</var> returns the variance of the values in the
<var>data</var> array. It returns zero if there is only one value.
</p>
<p>
The second form of the function accepts a pointer to an array of <var>N</var>
values.
</p>
</descr>
<errors>
None.
@ -1193,6 +1241,395 @@ None.
<example file="mathex/ex50"/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="sysutils">
<short>Used for exception definitions.</short>
</element>
<!-- constant Visibility: default -->
<element name="MinExtended">
<short>Minimum value (closest to zero) of extended type</short>
</element>
<!-- constant Visibility: default -->
<element name="MaxExtended">
<short>Maximum value of extended type</short>
</element>
<!-- constant Visibility: default -->
<element name="MinFloat">
<short>Minimum value (closest to zero) of float type</short>
</element>
<!-- constant Visibility: default -->
<element name="MaxFloat">
<short>Maximum value of float type</short>
</element>
<!-- pointer type Visibility: default -->
<element name="PInteger">
<short>Pointer to integer type</short>
</element>
<!-- range type Visibility: default -->
<element name="TValueRelationship">
<short>Type to describe relational order between values</short>
</element>
<!-- constant Visibility: default -->
<element name="EqualsValue">
<short>Values are the same</short>
</element>
<!-- constant Visibility: default -->
<element name="LessThanValue">
<short>First value is less than second value</short>
</element>
<!-- constant Visibility: default -->
<element name="GreaterThanValue">
<short>First values is greater than second value</short>
</element>
<!-- constant Visibility: default -->
<element name="NaN">
<short>Value is Not a Number</short>
</element>
<!-- constant Visibility: default -->
<element name="Infinity">
<short>Value is infinity</short>
</element>
<!-- function Visibility: default -->
<element name="InRange">
<short>Check whether value is in range.</short>
<descr>
<var>InRange</var> returns <var>True</var> if <var>AValue</var> is in the
range <var>AMin</var>..<var>AMax</var>. It returns <var>False</var> if
<var>Value</var> lies outside the specified range.
</descr>
<seealso>
<link id="EnsureRange"/>
</seealso>
</element>
<!-- function Visibility: default -->
<element name="EnsureRange">
<short>Change value to it falls in specified range.</short>
<descr>
<var>EnsureRange</var> returns <var>Value</var> if <var>AValue</var> is in
the range <var>AMin</var>..<var>AMax</var>. It returns <var>AMin</var> if
the value is less than <var>AMin</var>, or <var>AMax</var> if the value is
larger than <var>AMax</var>.
</descr>
<seealso>
<link id="InRange"/>
</seealso>
</element>
<!-- procedure Visibility: default -->
<element name="DivMod">
<short>Return DIV and MOD of arguments </short>
<descr>
<var>DivMod</var> returns <var>Dividend</var> DIV <var>Divisor</var> in
<var>Result</var>, and <var>Dividend</var> MOD <var>Divisor</var> in
<var>Remainder</var>
</descr>
</element>
<!-- range type Visibility: default -->
<element name="TValueSign">
<short>Type indicating sign of a valuea</short>
</element>
<!-- constant Visibility: default -->
<element name="NegativeValue">
<short>Value is negative</short>
</element>
<!-- constant Visibility: default -->
<element name="ZeroValue">
<short>Value is zero</short>
</element>
<!-- constant Visibility: default -->
<element name="PositiveValue">
<short>Value is positive</short>
</element>
<!-- function Visibility: default -->
<element name="Sign">
<short>Return sign of argument</short>
<descr>
<var>Sign</var> returns the sign of it's argument, which can be an Integer,
64 bit integer, or a double. The returned value is an integer which is -1, 0
or 1, and can be used to do further calculations with.
</descr>
</element>
<!-- function Visibility: default -->
<element name="IsZero">
<short>Check whether value is zero</short>
<descr>
<p>
<var>IsZero</var> checks whether the float value <var>A</var> is zero, up to a
precision of <var>Epsilon</var>. It returns <var>True</var> if Abs(<var>A</var>) is
less than <var>Epsilon</var>.
</p>
<p>
The default value for <var>Epsilon</var> is dependent on the type of the
arguments, but is <link id="MinFloat"/> for the float type.
</p>
</descr>
<seealso>
<link id="IsNan"/>
<link id="IsInfinite"/>
<link id="SameValue"/>
</seealso>
</element>
<!-- function Visibility: default -->
<element name="IsNan">
<short>Check whether value is Not a Number</short>
<descr>
<var>IsNan</var> returns <var>True</var> if the double <var>d</var>
contains Not A Number (a value which cannot be represented correctly
in double format).
</descr>
<seealso>
<link id="IsZero"/>
<link id="IsInfinite"/>
</seealso>
</element>
<!-- function Visibility: default -->
<element name="IsInfinite">
<short>Check whether value is infinite</short>
<descr>
<var>IsInfinite</var> returns <var>True</var> if the double <var>d</var>
contains the infinite value.
</descr>
<seealso>
<link id="IsZero"/>
<link id="IsInfinite"/>
</seealso>
</element>
<!-- function Visibility: default -->
<element name="SameValue">
<short>Check whether 2 float values are the same</short>
<descr>
<p>
<var>SameValue</var> returns <var>True</var> if the floating-point values
<var>A</var> and <var>B</var> are the same, i.e. whether the absolute value
of their their difference is smaller than <var>Epsilon</var>. If their
difference is larger, then <var>False</var> is returned.
</p>
<p>
The default value for <var>Epsilon</var> is dependent on the type of the
arguments, but is <link id="MinFloat"/> for the float type.
</p>
</descr>
<seealso>
<link id="MinFloat"/>
<link id="IsZero"/>
</seealso>
</element>
<!-- function Visibility: default -->
<element name="arccosh">
<short>Return inverse hyperbolic cosine</short>
<descr>
<p>
<var>arccosh</var> returns the inverse hyperbolic cosine of it's argument
<var>x</var>.
</p>
<p>
This function is an alias for <link id="arcosh"/>, provided for Delphi
compatibility.
</p>
</descr>
<seealso>
<link id="arcosh"/>
</seealso>
</element>
<!-- function Visibility: default -->
<element name="arcsinh">
<short>Return inverse hyperbolic sine</short>
<descr>
<p>
<var>arcsinh</var> returns the inverse hyperbolic sine of it's argument
<var>x</var>.
</p>
<p>
This function is an alias for <link id="arsinh"/>, provided for Delphi
compatibility.
</p>
</descr>
<seealso>
<link id="arsinh"/>
</seealso>
</element>
<!-- function Visibility: default -->
<element name="arctanh">
<short>Return inverse hyperbolic tangent</short>
<descr>
<p>
<var>arcsinh</var> returns the inverse hyperbolic tangent of it's argument
<var>x</var>.
</p>
<p>
This function is an alias for <link id="artanh"/>, provided for Delphi
compatibility.
</p>
</descr>
<seealso>
<link id="artanh"/>
</seealso>
</element>
<!-- enumeration type Visibility: default -->
<element name="TFPURoundingMode">
<short>Type describing the rounding mode for the Floating Point processor.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TFPURoundingMode.rmNearest">
<short>Round to nearest integer value</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TFPURoundingMode.rmDown">
<short>Round to biggest integer smaller than value.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TFPURoundingMode.rmUp">
<short>Round to smallest integer larger than value.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TFPURoundingMode.rmTruncate">
<short>Cut off fractional part.</short>
</element>
<!-- enumeration type Visibility: default -->
<element name="TFPUPrecisionMode">
<short>Type describing the default precision for the Floating Point processor.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TFPUPrecisionMode.pmSingle">
<short>Single-type precision</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TFPUPrecisionMode.pmReserved">
<short>?</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TFPUPrecisionMode.pmDouble">
<short>Double-type precision</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TFPUPrecisionMode.pmExtended">
<short>Extended-type precision</short>
</element>
<!-- enumeration type Visibility: default -->
<element name="TFPUException">
<short>Type describing Floating Point processor exceptions.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TFPUException.exInvalidOp">
<short>Invalid operation error</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TFPUException.exDenormalized">
<short></short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TFPUException.exZeroDivide">
<short>Division by zero error.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TFPUException.exOverflow">
<short>Float overflow error</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TFPUException.exUnderflow">
<short>Float underflow error</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TFPUException.exPrecision">
<short>Precision error</short>
</element>
<!-- set type Visibility: default -->
<element name="TFPUExceptionMask">
<short>Type to set the Floating Point Unit exception mask.</short>
</element>
<!-- function Visibility: default -->
<element name="GetRoundMode">
<short>Return the Floating Point Unit rounding mode.</short>
<descr>
</descr>
</element>
<!-- function Visibility: default -->
<element name="SetRoundMode">
<short>Set the Floating Point Unit rounding mode.</short>
<descr>
</descr>
</element>
<!-- function Visibility: default -->
<element name="GetPrecisionMode">
<short>Return the Floating Point Unit precision mode.</short>
<descr>
</descr>
</element>
<!-- function Visibility: default -->
<element name="SetPrecisionMode">
<short>Set the Floating Point Unit precision mode.</short>
<descr>
</descr>
</element>
<!-- function Visibility: default -->
<element name="GetExceptionMask">
<short>Get the Floating Point Unit exception mask.</short>
<descr>
</descr>
</element>
<!-- function Visibility: default -->
<element name="SetExceptionMask">
<short>Set the Floating Point Unit exception mask.</short>
<descr>
</descr>
</element>
<!-- procedure Visibility: default -->
<element name="ClearExceptions">
<short>Clear Floating Point Unit exceptions</short>
<descr>
</descr>
</element>
</module>
</package>
</fpdoc-descriptions>

55
docs/sockets.xml
View File

@ -1447,6 +1447,61 @@ None.
</seealso>
</element>
<element name="htonl">
<short>Convert long integer from host ordered to network ordered</short>
<descr>
<var>htonl</var> makes sure that the bytes in <var>host</var> are ordered
in the correct way for sending over the network and returns the correctly
ordered result.
</descr>
<seealso>
<link id="htons"/>
<link id="ntohl"/>
<link id="ntohs"/>
</seealso>
</element>
<element name="htons">
<short>Convert short integer from host ordered to network ordered</short>
<descr>
<var>htons</var> makes sure that the bytes in <var>host</var> are ordered
in the correct way for sending over the network and returns the correctly
ordered result.
</descr>
<seealso>
<link id="htonl"/>
<link id="ntohl"/>
<link id="ntohs"/>
</seealso>
</element>
<element name="ntohl">
<short>Convert long integer from network ordered to host ordered</short>
<descr>
<var>ntohs</var> makes sure that the bytes in <var>Net</var>, received from
the network, are ordered in the correct way for handling by the host
machinen, and returns the correctly ordered result.
</descr>
<seealso>
<link id="htonl"/>
<link id="htons"/>
<link id="ntohs"/>
</seealso>
</element>
<element name="ntohs">
<short>Convert short integer from network ordered to host ordered</short>
<descr>
<var>ntohs</var> makes sure that the bytes in <var>Net</var>, received from
the network, are ordered in the correct way for handling by the host
machinen, and returns the correctly ordered result.
</descr>
<seealso>
<link id="htonl"/>
<link id="htons"/>
<link id="ntohl"/>
</seealso>
</element>
</module>
</package>

7428
docs/system.xml Normal file
View File

File diff suppressed because it is too large Load Diff

10
docs/sysutils.xml
View File

@ -2007,11 +2007,13 @@ None.
</element>
<element name="AnsiExtractQuotedStr">
<short>Removes quotes from a string.</short>
<short>Removes the first quoted string from a string.</short>
<descr>
<var>AnsiExtractQuotedStr</var> Returns <var>Src</var> as a string, with <var>Quote</var>
characters removed from the beginning and end of the string, and double
<var>Quote</var> characters replaced by a single <var>Quote</var> characters.
<var>AnsiExtractQuotedStr</var> returns the first quoted string in
<var>Src</var>, and deletes the result from <var>Src</var>. The resulting
string has with <var>Quote</var> characters removed from the beginning and
end of the string (if they are present), and double <var>Quote</var>
characters replaced by a single <var>Quote</var> characters.
As such, it revereses the action of <link id="AnsiQuotedStr"/>.
</descr>
<errors>

419
docs/unix.xml
View File

@ -644,38 +644,6 @@
<short>File system type (<link id="StatFS"/>): XIA</short>
</element>
<element name="MAP_PRIVATE">
<short><link id="FpMMap"/> map type: Changes are private</short>
</element>
<element name="MAP_ANONYMOUS">
<short><link id="FpMMap"/> map type: Don't use a file</short>
</element>
<element name="MAP_GROWSDOWN">
<short><link id="FpMMap"/> option: Memory grows downward (like a stack)</short>
</element>
<element name="MAP_DENYWRITE">
<short><link id="FpMMap"/> option: Ignored.</short>
</element>
<element name="MAP_EXECUTABLE">
<short><link id="FpMMap"/> option: Ignored.</short>
</element>
<element name="MAP_LOCKED">
<short><link id="FpMMap"/> option: lock the pages in memory.</short>
</element>
<element name="MAP_NORESERVE">
<short><link id="FpMMap"/> option: Do not reserve swap pages for this memory.</short>
</element>
<element name="MAP_SHARED">
<short><link id="FpMMap"/> map type: Share changes</short>
</element>
<element name="MAP_TYPE">
<short><link id="FpMMap"/> map type: Bitmask for type of mapping</short>
</element>
<element name="MAP_FIXED">
<short><link id="FpMMap"/> map type: Interpret addr exactly</short>
</element>
<!-- constant Visibility: default -->
<element name="IOCtl_TCGETS">
<short>IOCTL call number: get Terminal Control settings</short>
@ -1095,18 +1063,6 @@
<short>Timezone name.</short>
</element>
<element name="PROT_READ">
<short><link id="FpMMap"/> memory access: page can be read</short>
</element>
<element name="PROT_WRITE">
<short><link id="FpMMap"/> memory access: page can be written</short>
</element>
<element name="PROT_EXEC">
<short><link id="FpMMap"/> memory access: page can be executed</short>
</element>
<element name="PROT_NONE">
<short><link id="FpMMap"/> memory access: page can not be accessed</short>
</element>
<!-- enumeration type Visibility: default -->
@ -1211,9 +1167,6 @@ it is adjusted to the local time zone, but not to DST.
<errors>
no errors
</errors>
<seealso>
<link id="GetTime"/>
</seealso>
<example file="unixex/ex1"/>
</element>
@ -1240,7 +1193,6 @@ None
<seealso>
<link id="GetEpochTime"/>
<link id="GetDate"/>
<link id="GetDateTime"/>
</seealso>
<example file="unixex/ex5"/>
</element>
@ -1263,8 +1215,6 @@ None
</errors>
<seealso>
<link id="GetEpochTime"/>
<link id="GetTime"/>
<link id="GetDateTime"/>
<link id="SetTime"/>
</seealso>
<example file="unixex/ex6"/>
@ -1283,7 +1233,6 @@ None
</errors>
<seealso>
<link id="GetEpochTime"/>
<link id="GetTime"/>
<link id="GetDate"/>
<link id="SetDate"/>
<link id="SetTime"/>
@ -1309,11 +1258,9 @@ You must be root to execute this call.
Extended error information can be retrieved with <link id="#rtl.baseunix.fpGetErrno">FpGetErrno</link>
</errors>
<seealso>
<link id="GetTime"/>
<link id="SetDate"/>
<link id="GetDate"/>
<link id="SetDateTime"/>
<link id="GetDateTime"/>
</seealso>
</element>
@ -1337,9 +1284,7 @@ Extended error information can be retrieved with <link id="#rtl.baseunix.fpGetEr
<seealso>
<link id="GetDate"/>
<link id="SetTime"/>
<link id="GetTime"/>
<link id="SetDateTime"/>
<link id="GetDateTime"/>
</seealso>
</element>
@ -1365,8 +1310,6 @@ Extended error information can be retrieved with <link id="#rtl.baseunix.fpGetEr
<link id="SetDate"/>
<link id="SetTime"/>
<link id="GetDate"/>
<link id="GetTime"/>
<link id="GetDateTime"/>
</seealso>
</element>
@ -2092,7 +2035,7 @@ Extended error information is returned by the <link id="#rtl.baseunix.fpGetErrno
</errors>
<seealso>
<link id="StatFS"/>
<link id="FpLStat"/>
<link id="#rtl.baseunix.FpLStat"/>
</seealso>
<example file="unixex/ex91"/>
</element>
@ -2126,7 +2069,7 @@ Extended error information is returned by the <link id="#rtl.baseunix.fpGetErrno
</errors>
<seealso>
<link id="#rtl.baseunix.FpStat"/>
<link id="FpLStat"/>
<link id="#rtl.baseunix.FpLStat"/>
</seealso>
<example file="unixex/ex91"/>
</element>
@ -2390,7 +2333,6 @@ is to search the current directory first.
An empty string if no such file was found.
</errors>
<seealso>
<link id="FExpand"/>
<link id="#rtl.unixutil.FNMatch"/>
</seealso>
<example file="unixex/ex46"/>
@ -2458,110 +2400,6 @@ None.
<example file="unixex/ex65"/>
</element>
<!-- function Visibility: default -->
<element name="FpMMap">
<short>Create memory map of a file</short>
<descr>
<p>
<var>FpMMap</var> maps or unmaps files or devices into memory. The different
arguments determine what and how the file is mapped:
</p>
<dl>
<dt>adr</dt>
<dd> Address where to mmap the device. This address is a hint,
and may not be followed.</dd>
<dt>len</dt><dd> Size (in bytes) of area to be mapped.</dd>
<dt>prot</dt>
<dd>
<p> Protection of mapped memory. This is a OR-ed combination of the
following constants:</p>
<dl>
<dt>PROT_EXEC</dt><dd> The memory can be executed.</dd>
<dt>PROT_READ</dt><dd> The memory can be read.</dd>
<dt>PROT_WRITE</dt><dd> The memory can be written.</dd>
<dt>PROT_NONE</dt><dd> The memory can not be accessed.</dd>
</dl>
</dd>
<dt>flags</dt><dd><p>Contains some options for the mmap call. It is an OR-ed
combination of the following constants:</p>
<dl>
<dt>MAP_FIXED</dt>
<dd> Do not map at another address than the given address. If the
address cannot be used, <var>MMap</var> will fail.</dd>
<dt>MAP_SHARED</dt>
<dd> Share this map with other processes that map this object.</dd>
<dt>MAP_PRIVATE</dt>
<dd> Create a private map with copy-on-write semantics.</dd>
<dt>MAP_ANONYMOUS</dt>
<dd> <var>fd</var> does not have to be a file descriptor.</dd>
</dl>
<p>
One of the options <var>MAP_SHARED</var> and <var>MAP_PRIVATE</var> must be present,
but not both at the same time.
</p>
</dd>
<dt>fd</dt><dd> File descriptor from which to map.</dd>
<dt>off</dt><dd> Offset to be used in file descriptor <var>fd</var>.</dd>
</dl>
<p>
The function returns a pointer to the mapped memory, or a -1 in case of en
error.
</p>
</descr>
<errors>
<p>
On error, -1 is returned and extended error information is returned by the <link id="#rtl.baseunix.fpGetErrno">FpGetErrno</link> function.
</p>
<dl>
<dt>Sys_EBADF</dt>
<dd> <var>fd</var> is not a valid file descriptor and
<var>MAP_ANONYMOUS</var> was not specified.</dd>
<dt>Sys_EACCES</dt>
<dd><var>MAP_PRIVATE</var> was specified, but <var>fd</var> is not open for
reading. Or <var>MAP_SHARED</var> was asked and <var>PROT_WRITE</var> is set, fd
is not open for writing</dd>
<dt>Sys_EINVAL</dt>
<dd> One of the record fields <var>Start</var>, <var>length</var> or
<var>offset</var> is invalid.</dd>
<dt>Sys_ETXTBUSY</dt>
<dd><var>MAP_DENYWRITE</var> was set but the object specified
by fd is open for writing.</dd>
<dt>Sys_EAGAIN</dt>
<dd><var>fd</var> is locked, or too much memory is locked.</dd>
<dt>Sys_ENOMEM</dt>
<dd> Not enough memory for this operation.</dd>
</dl>
</errors>
<seealso>
<link id="FpMUnMap"/>
</seealso>
<example file="unixex/ex66"/>
</element>
<!-- function Visibility: default -->
<element name="Fpmunmap">
<short>Unmap previously mapped memory block</short>
<descr>
<p>
<var>FpMUnMap</var> unmaps the memory block of size <var>Len</var>, pointed to by
<var>Adr</var>, which was previously allocated with <link id="FpMMap"/>.
</p>
<p>
The function returns <var>True</var> if successful, <var>False</var> otherwise.
</p>
<p>
For an example, see <link id="FpMMap"/>.
</p>
</descr>
<errors>
In case of error the function returns a nonzero value,
extended error information is returned by the <link id="#rtl.baseunix.fpGetErrno">FpGetErrno</link> function.
See <link id="FpMMap"/> for possible error values.
</errors>
<seealso>
<link id="FpMMap"/>
</seealso>
</element>
<!-- function Visibility: default -->
<element name="fpgettimeofday">
@ -2573,263 +2411,12 @@ See <link id="FpMMap"/> for possible error values.
not taking into account timezones, daylight savings time and so on.
</p>
<p>
It is simply a wrapper to the kernel system call. To get the local time,
<link id="GetTime"/>.
It is simply a wrapper to the kernel system call.
</p>
</descr>
<errors>
None.
</errors>
<seealso>
<link id="GetTime"/>
<link id="GetDateTime"/>
</seealso>
</element>
<!-- function Visibility: default -->
<element name="fpNice">
<short>Set process priority</short>
<descr>
<p>
<var>Nice</var> adds <var>-N</var> to the priority of the running process. The lower the
priority numerically, the less the process is favored.
Only the superuser can specify a negative <var>N</var>, i.e. increase the rate at
which the process is run.
</p>
<p>
If the function is succesful, zero is returned. On error, a nonzero value is returned.
</p>
</descr>
<errors>
<p>
Extended error information is returned by the <link id="#rtl.baseunix.fpGetErrno">FpGetErrno</link> function.
</p>
<dl>
<dt>sys_eperm</dt><dd> A non-superuser tried to specify a negative <var>N</var>, i.e.
do a priority increase.</dd>
</dl>
</errors>
<seealso>
<link id="FpGetPriority"/>
<link id="FpSetPriority"/>
</seealso>
<example file="unixex/ex15"/>
</element>
<!-- function Visibility: default -->
<element name="fpGetPriority">
<short>Return process priority</short>
<descr>
<p>
GetPriority returns the priority with which a process is running.
Which process(es) is determined by the <var>Which</var> and <var>Who</var> variables.
<var>Which</var> can be one of the pre-defined <var>Prio_Process</var>,
<var>Prio_PGrp</var>, <var>Prio_User</var>, in which case <var>Who</var> is the process ID, Process group ID or
User ID, respectively.
</p>
<p>
For an example, see <link id="FpNice"/>.
</p>
</descr>
<errors>
<p>
Error information is returned solely by the <link id="#rtl.baseunix.fpGetErrno">FpGetErrno</link>
function: a priority can be a positive or negative value.
</p>
<dl>
<dt>sys_esrch</dt>
<dd> No process found using <var>which</var> and <var>who</var>. </dd>
<dt>sys_einval</dt>
<dd> <var>Which</var> was not one of <var>Prio_Process</var>,
<var>Prio_Grp</var> or <var>Prio_User</var>.</dd>
</dl>
</errors>
<seealso>
<link id="FpSetPriority"/>
<link id="FpNice"/>
</seealso>
</element>
<!-- function Visibility: default -->
<element name="fpSetPriority">
<short>Set process priority</short>
<descr>
<p>
<var>fpSetPriority</var> sets the priority with which a process is running.
Which process(es) is determined by the <var>Which</var> and <var>Who</var> variables.
<var>Which</var> can be one of the pre-defined constants:
</p>
<dl>
<dt>Prio_Process</dt><dd><var>Who</var> is interpreted as process ID</dd>
<dt>Prio_PGrp</dt><dd><var>Who</var> is interpreted as process group ID</dd>
<dt>Prio_User</dt><dd><var>Who</var> is interpreted as user ID</dd>
</dl>
<p>
<var>Prio</var> is a value in the range -20 to 20.
</p>
<p>
For an example, see <link id="FpNice"/>.
</p>
<p>
The function returns zero on success, -1 on failure
</p>
</descr>
<errors>
<p>
Extended error information is returned by the <link id="#rtl.baseunix.fpGetErrno">FpGetErrno</link>
function.
</p>
<dl>
<dt>sys_esrch</dt>
<dd>No process found using <var>which</var> and <var>who</var>.</dd>
<dt>sys_einval</dt>
<dd> <var>Which</var> was not one of <var>Prio_Process</var>,
<var>Prio_Grp</var> or <var>Prio_User</var>.</dd>
<dt>sys_eperm</dt>
<dd>A process was found, but neither its effective or real
user ID match the effective user ID of the caller.</dd>
<dt>sys_eacces</dt>
<dd>A non-superuser tried to a priority increase.</dd>
</dl>
</errors>
<seealso>
<link id="FpGetPriority"/>
<link id="FpNice"/>
</seealso>
</element>
<!-- function Visibility: default -->
<element name="fpLstat">
<short>Return information about symbolic link. Do not follow the link</short>
<descr>
<var>FpLstat</var> gets information about the link specified in <var>Path</var>
(or <var>FileName</var>, and stores it in <var>Info</var>, which points to a
record of type <var>TStat</var>. Contrary to <link
id="#rtl.baseunix.FpFStat">FpFstat</link>, it stores
information about the link, not about the file the link points to.
The function returns zero if the call was succesful, a nonzero return value
indicates failure.
failed.
</descr>
<errors>
<p>
Extended error information is returned by the <link id="#rtl.baseunix.fpGetErrno">FpGetErrno</link>
function.
</p>
<dl>
<dt>sys_enoent</dt><dd> <var>Path</var> does not exist.</dd>
</dl>
</errors>
<seealso>
<link id="#rtl.baseunix.FpFStat"/>
<link id="StatFS"/>
</seealso>
<example file="unixex/ex29"/>
</element>
<!-- function Visibility: default -->
<element name="fpSymlink">
<short>Create a symbolic link</short>
<descr>
<p>
<var>SymLink</var> makes <var>NewName</var> point to the file in
<var>OldName</var>, which doesn't necessarily exist. The two files
DO NOT have the same inode number. This is known as a 'soft' link.
</p>
<p>The permissions of the link are irrelevant, as they are not used when
following the link. Ownership of the file is only checked in case of removal
or renaming of the link.
</p>
<p>
The function returns zero if the call was succesful, a nonzero value if the call
failed.
</p>
</descr>
<errors>
<p>
Extended error information is returned by the <link id="#rtl.baseunix.fpGetErrno">FpGetErrno</link>
function.
</p>
<dl>
<dt>sys_eperm</dt>
<dd>The filesystem containing oldpath and newpath does not
support linking files.</dd>
<dt>sys_eaccess</dt>
<dd>Write access for the directory containing <var>Newpath</var>
is disallowed, or one of the directories in <var>OldPath</var> or
<var>NewPath</var> has no search (=execute) permission.</dd>
<dt>sys_enoent</dt>
<dd>A directory entry in <var>OldPath</var> or <var>NewPath</var> does
not exist or is a symbolic link pointing to a non-existent directory.</dd>
<dt>sys_enotdir</dt>
<dd>A directory entry in <var>OldPath</var> or <var>NewPath</var> is
nor a directory.</dd>
<dt>sys_enomem</dt><dd>Insufficient kernel memory.</dd>
<dt>sys_erofs</dt><dd>The files are on a read-only filesystem.</dd>
<dt>sys_eexist</dt><dd><var>NewPath</var> already exists.</dd>
<dt>sys_eloop</dt>
<dd> <var>OldPath</var> or <var>NewPath</var> has a reference to a circular
symbolic link, i.e. a symbolic link, whose expansion points to itself.
</dd>
<dt>sys_enospc</dt>
<dd>The device containing <var>NewPath</var> has no room for another entry.</dd>
</dl>
</errors>
<seealso>
<link id="#rtl.baseunix.FpLink"/>
<link id="#rtl.baseunix.FpUnLink"/>
<link id="FpReadLink"/>
</seealso>
<example file="unixex/ex22"/>
</element>
<!-- function Visibility: default -->
<element name="fpReadLink">
<short>Read destination of symbolic link</short>
<descr>
<p>
<var>FpReadLink</var> returns the file the symbolic link <var>name</var> is pointing
to. The first form of this function accepts a buffer <var>linkname</var> of
length <var>maxlen</var> where the filename will be stored. It returns the
actual number of characters stored in the buffer.
</p>
<p>
The second form of the function returns simply the name of the file.
</p>
</descr>
<errors>
<p>
On error, the first form of the function returns -1; the second one returns
an empty string.
Extended error information is returned by the <link id="#rtl.baseunix.fpGetErrno">FpGetErrno</link>
function.
</p>
<dl>
<dt>SYS_ENOTDIR</dt>
<dd>A part of the path in <var>Name</var> is not a directory.</dd>
<dt>SYS_EINVAL</dt>
<dd>maxlen is not positive, or the file is not a symbolic link.</dd>
<dt>SYS_ENAMETOOLONG</dt>
<dd>A pathname, or a component of a pathname, was too long.</dd>
<dt>SYS_ENOENT</dt>
<dd>the link <var>name</var> does not exist.</dd>
<dt>SYS_EACCES</dt>
<dd>No permission to search a directory in the path</dd>
<dt>SYS_ELOOP</dt>
<dd>Too many symbolic links were encountered in translating the pathname.</dd>
<dt>SYS_EIO</dt>
<dd>An I/O error occurred while reading from the file system.</dd>
<dt>SYS_EFAULT</dt>
<dd>The buffer is not part of the the process's memory space.</dd>
<dt>SYS_ENOMEM</dt>
<dd>Not enough kernel memory was available.</dd>
</dl>
</errors>
<seealso>
<link id="FpSymLink"/>
</seealso>
<example file="unixex/ex62"/>
</element>
<!-- function Visibility: default -->

11
docs/unixutil.xml
View File

@ -66,7 +66,6 @@ None.
</errors>
<seealso>
<link id="BaseName"/>
<link id="#rtl.unix.FExpand"/>
</seealso>
<example file="unutilex/ex47"/>
</element>
@ -99,9 +98,7 @@ None.
</errors>
<seealso>
<link id="ArrayStringToPPchar"/>
<link id="#rtl.unix.CreateShellArgV"/>
<link id="#rtl.baseunix.FpExecve"/>
<link id="#rtl.unix.Execv"/>
</seealso>
<example file="unutilex/ex70"/>
</element>
@ -149,7 +146,6 @@ None.
</errors>
<seealso>
<link id="DirName"/>
<link id="#rtl.unix.FExpand"/>
</seealso>
<example file="unutilex/ex48"/>
</element>
@ -172,7 +168,6 @@ None.
</errors>
<seealso>
<link id="#rtl.unix.FSearch"/>
<link id="#rtl.unix.FExpand"/>
</seealso>
<example file="unutilex/ex69"/>
</element>
@ -222,10 +217,7 @@ Converts the Local time to epoch time (=Number of seconds since 00:00:00 , Janua
None
</errors>
<seealso>
<link id="#rtl.unix.GetEpochTime"/>
<link id="EpochToLocal"/>
<link id="#rtl.unix.GetTime"/>
<link id="#rtl.unix.GetDate"/>
</seealso>
<example file="unutilex/ex4"/>
</element>
@ -246,10 +238,7 @@ This function takes into account the timzeone settings of your system.
None
</errors>
<seealso>
<link id="#rtl.unix.GetEpochTime"/>
<link id="LocalToEpoch"/>
<link id="#rtl.unix.GetTime"/>
<link id="#rtl.unix.GetDate"/>
</seealso>
<example file="unutilex/ex3"/>
</element>