didou Tue Apr 5 08:51:55 2005 EDT
Modified files:
/phpdoc/en/reference/dio/functions dio-close.xml dio-fcntl.xml
dio-open.xml dio-read.xml
dio-seek.xml dio-stat.xml
dio-tcsetattr.xml
dio-truncate.xml dio-write.xml
Log:
WS
http://cvs.php.net/diff.php/phpdoc/en/reference/dio/functions/dio-close.xml?r1=1.6&r2=1.7&ty=u
Index: phpdoc/en/reference/dio/functions/dio-close.xml
diff -u phpdoc/en/reference/dio/functions/dio-close.xml:1.6
phpdoc/en/reference/dio/functions/dio-close.xml:1.7
--- phpdoc/en/reference/dio/functions/dio-close.xml:1.6 Tue Apr 5 08:50:53 2005
+++ phpdoc/en/reference/dio/functions/dio-close.xml Tue Apr 5 08:51:55 2005
@@ -1,48 +1,48 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.6 $ -->
- <refentry id="function.dio-close">
- <refnamediv>
- <refname>dio_close</refname>
- <refpurpose>Closes the file descriptor given by fd</refpurpose>
- </refnamediv>
- <refsect1 role="description">
- &reftitle.description;
- <methodsynopsis>
- <type>void</type><methodname>dio_close</methodname>
- <methodparam><type>resource</type><parameter>fd</parameter></methodparam>
- </methodsynopsis>
- <para>
- The function <function>dio_close</function> closes the file descriptor
- <parameter>fd</parameter>.
- </para>
- </refsect1>
- <refsect1 role="parameters">
- &reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>fd</parameter></term>
- <listitem>
- <para>
- The file descriptor returned by <function>dio_open</function>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </refsect1>
- <refsect1 role="returnvalues">
- &reftitle.returnvalues;
- <para>
- &return.void;
- </para>
- </refsect1>
- <refsect1 role="examples">
- &reftitle.examples;
- <para>
- <example>
- <title>Closing an open file descriptor</title>
- <programlisting role="php">
+<!-- $Revision: 1.7 $ -->
+<refentry id="function.dio-close">
+ <refnamediv>
+ <refname>dio_close</refname>
+ <refpurpose>Closes the file descriptor given by fd</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <void/><methodname>dio_close</methodname>
+ <methodparam><type>resource</type><parameter>fd</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ The function <function>dio_close</function> closes the file descriptor
+ <parameter>fd</parameter>.
+ </para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>fd</parameter></term>
+ <listitem>
+ <para>
+ The file descriptor returned by <function>dio_open</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.void;
+ </para>
+ </refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title>Closing an open file descriptor</title>
+ <programlisting role="php">
<![CDATA[
<?php
$fd = dio_open('/dev/ttyS0', O_RDWR);
@@ -50,19 +50,19 @@
dio_close($fd);
?>
]]>
- </programlisting>
- </example>
- </para>
- </refsect1>
- <refsect1 role="seealso">
- &reftitle.seealso;
- <para>
- <simplelist>
- <member><function>dio_open</function></member>
- </simplelist>
- </para>
- </refsect1>
- </refentry>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>dio_open</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/diff.php/phpdoc/en/reference/dio/functions/dio-fcntl.xml?r1=1.9&r2=1.10&ty=u
Index: phpdoc/en/reference/dio/functions/dio-fcntl.xml
diff -u phpdoc/en/reference/dio/functions/dio-fcntl.xml:1.9
phpdoc/en/reference/dio/functions/dio-fcntl.xml:1.10
--- phpdoc/en/reference/dio/functions/dio-fcntl.xml:1.9 Tue Apr 5 08:50:53 2005
+++ phpdoc/en/reference/dio/functions/dio-fcntl.xml Tue Apr 5 08:51:55 2005
@@ -1,136 +1,138 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.9 $ -->
- <refentry id="function.dio-fcntl">
- <refnamediv>
- <refname>dio_fcntl</refname>
- <refpurpose>Performs a c library fcntl on fd</refpurpose>
- </refnamediv>
- <refsect1 role="description">
- &reftitle.description;
- <methodsynopsis>
- <type>mixed</type><methodname>dio_fcntl</methodname>
- <methodparam><type>resource</type><parameter>fd</parameter></methodparam>
- <methodparam><type>int</type><parameter>cmd</parameter></methodparam>
- <methodparam
choice="opt"><type>mixed</type><parameter>args</parameter></methodparam>
- </methodsynopsis>
- <para>
- The <function>dio_fcntl</function> function performs the
- operation specified by <parameter>cmd</parameter> on the file
- descriptor <parameter>fd</parameter>. Some commands require
- additional arguments <parameter>args</parameter> to be supplied.
- </para>
- ¬e.no-windows;
- </refsect1>
- <refsect1 role="parameters">
- &reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>fd</parameter></term>
- <listitem>
- <para>
- The file descriptor returned by <function>dio_open</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>cmd</parameter></term>
- <listitem>
- <para>
- Can be one of the following operations:
- <itemizedlist>
- <listitem>
- <para>
- <constant>F_SETLK</constant> - Lock is set or cleared. If the lock
- is held by someone else <function>dio_fcntl</function> returns
- -1.
- </para>
- </listitem>
- <listitem>
- <para>
- <constant>F_SETLKW</constant> - like <constant>F_SETLK</constant>,
but in case the lock
- is held by someone else, <function>dio_fcntl</function> waits
- until the lock is released.
- </para>
- </listitem>
- <listitem>
- <para>
- <constant>F_GETLK</constant> - <function>dio_fcntl</function>
returns an
- associative array (as described above) if someone else
- prevents lock. If there is no obstruction key "type" will set
- to <constant>F_UNLCK</constant>.
- </para>
- </listitem>
- <listitem>
- <para>
- <constant>F_DUPFD</constant> - finds the lowest numbered available
file descriptor
- greater than or equal to <parameter>args</parameter> and returns
- them.
- </para>
- </listitem>
- <listitem>
- <para>
- <constant>F_SETF</constant>L - Sets the file descriptors flags to
the value specified by
- <parameter>args</parameter>, which can be
<constant>O_APPEND</constant>,
- <constant>O_NONBLOCK</constant> or <constant>O_ASYNC</constant>.
To use
- <constant>O_ASYNC</constant> you will need to use the
- <link linkend="ref.pcntl">PCNTL</link> extension.
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>args</parameter></term>
- <listitem>
- <para>
- <parameter>args</parameter> is an associative array, when
- <parameter>cmd</parameter> is <constant>F_SETLK</constant> or
- <constant>F_SETLLW</constant>, with the following keys:
- <itemizedlist>
- <listitem>
- <para>
- "start" - offset where lock begins
- </para>
- </listitem>
- <listitem>
- <para>
- "length" - size of locked area. zero means to end of file
- </para>
- </listitem>
- <listitem>
- <para>
- "wenth" - Where l_start is relative to: can be
<constant>SEEK_SET</constant>,
- <constant>SEEK_END</constant> and <constant>SEEK_CUR</constant>
- </para>
- </listitem>
- <listitem>
- <para>
- "type" - type of lock: can be <constant>F_RDLCK</constant> (read
- lock), <constant>F_WRLCK</constant> (write lock) or
- <constant>F_UNLCK</constant> (unlock)
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </refsect1>
- <refsect1 role="returnvalues">
- &reftitle.returnvalues;
- <para>
- Returns the result of the C call.
- </para>
- </refsect1>
- <refsect1 role="examples">
- &reftitle.examples;
- <para>
- <example>
- <title>Setting and clearing a lock</title>
- <programlisting role="php">
+<!-- $Revision: 1.10 $ -->
+<refentry id="function.dio-fcntl">
+ <refnamediv>
+ <refname>dio_fcntl</refname>
+ <refpurpose>Performs a c library fcntl on fd</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>mixed</type><methodname>dio_fcntl</methodname>
+ <methodparam><type>resource</type><parameter>fd</parameter></methodparam>
+ <methodparam><type>int</type><parameter>cmd</parameter></methodparam>
+ <methodparam
choice="opt"><type>mixed</type><parameter>args</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ The <function>dio_fcntl</function> function performs the
+ operation specified by <parameter>cmd</parameter> on the file
+ descriptor <parameter>fd</parameter>. Some commands require
+ additional arguments <parameter>args</parameter> to be supplied.
+ </para>
+ ¬e.no-windows;
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>fd</parameter></term>
+ <listitem>
+ <para>
+ The file descriptor returned by <function>dio_open</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>cmd</parameter></term>
+ <listitem>
+ <para>
+ Can be one of the following operations:
+ <itemizedlist>
+ <listitem>
+ <para>
+ <constant>F_SETLK</constant> - Lock is set or cleared. If the lock
+ is held by someone else <function>dio_fcntl</function> returns
+ -1.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <constant>F_SETLKW</constant> - like <constant>F_SETLK</constant>,
+ but in case the lock is held by someone else,
+ <function>dio_fcntl</function> waits until the lock is released.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <constant>F_GETLK</constant> - <function>dio_fcntl</function>
+ returns an associative array (as described above) if someone else
+ prevents lock. If there is no obstruction key "type" will set
+ to <constant>F_UNLCK</constant>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <constant>F_DUPFD</constant> - finds the lowest numbered available
+ file descriptor greater than or equal to <parameter>args</parameter>
+ and returns them.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <constant>F_SETFL</constant> - Sets the file descriptors flags to
+ the value specified by <parameter>args</parameter>, which can be
+ <constant>O_APPEND</constant>, <constant>O_NONBLOCK</constant> or
+ <constant>O_ASYNC</constant>. To use <constant>O_ASYNC</constant>
+ you will need to use the <link linkend="ref.pcntl">PCNTL</link>
+ extension.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>args</parameter></term>
+ <listitem>
+ <para>
+ <parameter>args</parameter> is an associative array, when
+ <parameter>cmd</parameter> is <constant>F_SETLK</constant> or
+ <constant>F_SETLLW</constant>, with the following keys:
+ <itemizedlist>
+ <listitem>
+ <para>
+ "start" - offset where lock begins
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ "length" - size of locked area. zero means to end of file
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ "wenth" - Where l_start is relative to: can be
+ <constant>SEEK_SET</constant>,
+ <constant>SEEK_END</constant> and <constant>SEEK_CUR</constant>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ "type" - type of lock: can be <constant>F_RDLCK</constant> (read
+ lock), <constant>F_WRLCK</constant> (write lock) or
+ <constant>F_UNLCK</constant> (unlock)
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the result of the C call.
+ </para>
+ </refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title>Setting and clearing a lock</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -146,11 +148,11 @@
dio_close($fd);
?>
]]>
- </programlisting>
- </example>
- </para>
- </refsect1>
- </refentry>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/diff.php/phpdoc/en/reference/dio/functions/dio-open.xml?r1=1.7&r2=1.8&ty=u
Index: phpdoc/en/reference/dio/functions/dio-open.xml
diff -u phpdoc/en/reference/dio/functions/dio-open.xml:1.7
phpdoc/en/reference/dio/functions/dio-open.xml:1.8
--- phpdoc/en/reference/dio/functions/dio-open.xml:1.7 Tue Apr 5 08:50:53 2005
+++ phpdoc/en/reference/dio/functions/dio-open.xml Tue Apr 5 08:51:55 2005
@@ -1,120 +1,121 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.7 $ -->
- <refentry id="function.dio-open">
- <refnamediv>
- <refname>dio_open</refname>
- <refpurpose>
- Opens a new filename with specified permissions of flags and
- creation permissions of mode
- </refpurpose>
- </refnamediv>
- <refsect1 role="description">
- &reftitle.description;
- <methodsynopsis>
- <type>resource</type><methodname>dio_open</methodname>
-
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
- <methodparam><type>int</type><parameter>flags</parameter></methodparam>
- <methodparam
choice="opt"><type>int</type><parameter>mode</parameter></methodparam>
- </methodsynopsis>
- <para>
- <function>dio_open</function> opens a file and returns a new file
- descriptor for it.
- </para>
- </refsect1>
- <refsect1 role="parameters">
- &reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>filename</parameter></term>
- <listitem>
- <para>
- The opened file.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>flags</parameter></term>
- <listitem>
- <para>
- The <parameter>flags</parameter> parameter can also include any
- combination of the following flags:
- <itemizedlist>
- <listitem>
- <para>
- <constant>O_CREAT</constant> - creates the file, if it doesn't
already exist.
- </para>
- </listitem>
- <listitem>
- <para>
- <constant>O_EXCL</constant> - if both, <constant>O_CREAT</constant>
- and <constant>O_EXCL</constant> are set,
<function>dio_open</function>
- fails, if the file already exists.
- </para>
- </listitem>
- <listitem>
- <para>
- <constant>O_TRUNC</constant> - if the file exists, and its opened
for write access,
- the file will be truncated to zero length.
- </para>
- </listitem>
- <listitem>
- <para>
- <constant>O_APPEND</constant> - write operations write data at the
- end of the file.
- </para>
- </listitem>
- <listitem>
- <para>
- <constant>O_NONBLOCK</constant> - sets non blocking mode.
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>mode</parameter></term>
- <listitem>
- <para>
- If <parameter>flags</parameter> is <constant>O_CREAT</constant>,
- <parameter>mode</parameter> will set the mode of the file
- (creation permissions).
- <itemizedlist>
- <listitem>
- <para>
- <constant>O_RDONLY</constant> - opens the file for read access.
- </para>
- </listitem>
- <listitem>
- <para>
- <constant>O_WRONLY</constant> - opens the file for write access.
- </para>
- </listitem>
- <listitem>
- <para>
- <constant>O_RDWR</constant> - opens the file for both reading and
- writing.
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </refsect1>
- <refsect1 role="returnvalues">
- &reftitle.returnvalues;
- <para>
- A file descriptor or &false; on error.
- </para>
- </refsect1>
- <refsect1 role="examples">
- &reftitle.examples;
- <example>
- <title>Setting the baud rate on a serial port</title>
- <programlisting role="php">
+<!-- $Revision: 1.8 $ -->
+<refentry id="function.dio-open">
+ <refnamediv>
+ <refname>dio_open</refname>
+ <refpurpose>
+ Opens a new filename with specified permissions of flags and
+ creation permissions of mode
+ </refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>resource</type><methodname>dio_open</methodname>
+
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
+ <methodparam><type>int</type><parameter>flags</parameter></methodparam>
+ <methodparam
choice="opt"><type>int</type><parameter>mode</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ <function>dio_open</function> opens a file and returns a new file
+ descriptor for it.
+ </para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>filename</parameter></term>
+ <listitem>
+ <para>
+ The opened file.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>flags</parameter></term>
+ <listitem>
+ <para>
+ The <parameter>flags</parameter> parameter can also include any
+ combination of the following flags:
+ <itemizedlist>
+ <listitem>
+ <para>
+ <constant>O_CREAT</constant> - creates the file, if it doesn't
+ already exist.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <constant>O_EXCL</constant> - if both, <constant>O_CREAT</constant>
+ and <constant>O_EXCL</constant> are set,
<function>dio_open</function>
+ fails, if the file already exists.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <constant>O_TRUNC</constant> - if the file exists, and its opened
+ for write access, the file will be truncated to zero length.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <constant>O_APPEND</constant> - write operations write data at the
+ end of the file.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <constant>O_NONBLOCK</constant> - sets non blocking mode.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>mode</parameter></term>
+ <listitem>
+ <para>
+ If <parameter>flags</parameter> is <constant>O_CREAT</constant>,
+ <parameter>mode</parameter> will set the mode of the file
+ (creation permissions).
+ <itemizedlist>
+ <listitem>
+ <para>
+ <constant>O_RDONLY</constant> - opens the file for read access.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <constant>O_WRONLY</constant> - opens the file for write access.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <constant>O_RDWR</constant> - opens the file for both reading and
+ writing.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ A file descriptor or &false; on error.
+ </para>
+ </refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <example>
+ <title>Setting the baud rate on a serial port</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -123,18 +124,18 @@
dio_close($fd);
?>
]]>
- </programlisting>
- </example>
- </refsect1>
- <refsect1 role="seealso">
- &reftitle.seealso;
- <para>
- <simplelist>
- <member><function>dio_close</function></member>
- </simplelist>
- </para>
- </refsect1>
- </refentry>
+ </programlisting>
+ </example>
+ </refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>dio_close</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/diff.php/phpdoc/en/reference/dio/functions/dio-read.xml?r1=1.5&r2=1.6&ty=u
Index: phpdoc/en/reference/dio/functions/dio-read.xml
diff -u phpdoc/en/reference/dio/functions/dio-read.xml:1.5
phpdoc/en/reference/dio/functions/dio-read.xml:1.6
--- phpdoc/en/reference/dio/functions/dio-read.xml:1.5 Tue Apr 5 08:50:53 2005
+++ phpdoc/en/reference/dio/functions/dio-read.xml Tue Apr 5 08:51:55 2005
@@ -1,62 +1,62 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
- <refentry id="function.dio-read">
- <refnamediv>
- <refname>dio_read</refname>
- <refpurpose>Reads bytes from a file descriptor</refpurpose>
- </refnamediv>
- <refsect1 role="description">
- &reftitle.description;
- <methodsynopsis>
- <type>string</type><methodname>dio_read</methodname>
- <methodparam><type>resource</type><parameter>fd</parameter></methodparam>
- <methodparam
choice="opt"><type>int</type><parameter>len</parameter></methodparam>
- </methodsynopsis>
- <para>
- The function <function>dio_read</function> reads and returns
- <parameter>len</parameter> bytes from file with descriptor
- <parameter>fd</parameter>.
- </para>
- </refsect1>
- <refsect1 role="parameters">
- &reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>fd</parameter></term>
- <listitem>
- <para>
- The file descriptor returned by <function>dio_open</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>len</parameter></term>
- <listitem>
- <para>
- The number of bytes to read. If not specified,
- <function>dio_read</function> reads 1K sized block.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </refsect1>
- <refsect1 role="returnvalues">
- &reftitle.returnvalues;
- <para>
- The bytes readed from <parameter>fd</parameter>.
- </para>
- </refsect1>
- <refsect1 role="seealso">
- &reftitle.seealso;
- <para>
- <simplelist>
- <member><function>dio_write</function></member>
- </simplelist>
- </para>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.6 $ -->
+<refentry id="function.dio-read">
+ <refnamediv>
+ <refname>dio_read</refname>
+ <refpurpose>Reads bytes from a file descriptor</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>string</type><methodname>dio_read</methodname>
+ <methodparam><type>resource</type><parameter>fd</parameter></methodparam>
+ <methodparam
choice="opt"><type>int</type><parameter>len</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ The function <function>dio_read</function> reads and returns
+ <parameter>len</parameter> bytes from file with descriptor
+ <parameter>fd</parameter>.
+ </para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>fd</parameter></term>
+ <listitem>
+ <para>
+ The file descriptor returned by <function>dio_open</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>len</parameter></term>
+ <listitem>
+ <para>
+ The number of bytes to read. If not specified,
+ <function>dio_read</function> reads 1K sized block.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ The bytes readed from <parameter>fd</parameter>.
+ </para>
+ </refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>dio_write</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/diff.php/phpdoc/en/reference/dio/functions/dio-seek.xml?r1=1.7&r2=1.8&ty=u
Index: phpdoc/en/reference/dio/functions/dio-seek.xml
diff -u phpdoc/en/reference/dio/functions/dio-seek.xml:1.7
phpdoc/en/reference/dio/functions/dio-seek.xml:1.8
--- phpdoc/en/reference/dio/functions/dio-seek.xml:1.7 Tue Apr 5 08:50:53 2005
+++ phpdoc/en/reference/dio/functions/dio-seek.xml Tue Apr 5 08:51:55 2005
@@ -1,91 +1,93 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.7 $ -->
- <refentry id="function.dio-seek">
- <refnamediv>
- <refname>dio_seek</refname>
- <refpurpose>Seeks to pos on fd from whence</refpurpose>
- </refnamediv>
- <refsect1 role="description">
- &reftitle.description;
- <methodsynopsis>
- <type>int</type><methodname>dio_seek</methodname>
- <methodparam><type>resource</type><parameter>fd</parameter></methodparam>
- <methodparam><type>int</type><parameter>pos</parameter></methodparam>
- <methodparam
choice="opt"><type>int</type><parameter>whence</parameter></methodparam>
- </methodsynopsis>
- <para>
- The function <function>dio_seek</function> is used to change the
- file position of the given file descriptor.
- </para>
- </refsect1>
- <refsect1 role="parameters">
- &reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>fd</parameter></term>
- <listitem>
- <para>
- The file descriptor returned by <function>dio_open</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>pos</parameter></term>
- <listitem>
- <para>
- The new position.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>whence</parameter></term>
- <listitem>
- <para>
- Specifies how the position <parameter>pos</parameter> should be
interpreted:
- <itemizedlist>
- <listitem>
- <para>
- <constant>SEEK_SET</constant> (default) - specifies that
<parameter>pos</parameter> is
- specified from the beginning of the file.
- </para>
- </listitem>
- <listitem>
- <para>
- <constant>SEEK_CUR</constant> - Specifies that
<parameter>pos</parameter> is a
- count of characters from the current file position. This count
- may be positive or negative.
- </para>
- </listitem>
- <listitem>
- <para>
- <constant>SEEK_END</constant> - Specifies that
<parameter>pos</parameter> is a
- count of characters from the end of the file. A negative count
- specifies a position within the current extent of the file; a
- positive count specifies a position past the current end. If
- you set the position past the current end, and actually write
- data, you will extend the file with zeros up to that
- position.
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </refsect1>
- <refsect1 role="returnvalues">
- &reftitle.returnvalues;
- <para>
- </para>
- </refsect1>
- <refsect1 role="examples">
- &reftitle.examples;
- <para>
- <example>
- <title>Setting the baud rate on a serial port</title>
- <programlisting role="php">
+<!-- $Revision: 1.8 $ -->
+<refentry id="function.dio-seek">
+ <refnamediv>
+ <refname>dio_seek</refname>
+ <refpurpose>Seeks to pos on fd from whence</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>int</type><methodname>dio_seek</methodname>
+ <methodparam><type>resource</type><parameter>fd</parameter></methodparam>
+ <methodparam><type>int</type><parameter>pos</parameter></methodparam>
+ <methodparam
choice="opt"><type>int</type><parameter>whence</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ The function <function>dio_seek</function> is used to change the
+ file position of the given file descriptor.
+ </para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>fd</parameter></term>
+ <listitem>
+ <para>
+ The file descriptor returned by <function>dio_open</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>pos</parameter></term>
+ <listitem>
+ <para>
+ The new position.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>whence</parameter></term>
+ <listitem>
+ <para>
+ Specifies how the position <parameter>pos</parameter> should be
+ interpreted:
+ <itemizedlist>
+ <listitem>
+ <para>
+ <constant>SEEK_SET</constant> (default) - specifies that
+ <parameter>pos</parameter> is specified from the beginning of the
+ file.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <constant>SEEK_CUR</constant> - Specifies that
+ <parameter>pos</parameter> is a count of characters from the current
+ file position. This count may be positive or negative.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <constant>SEEK_END</constant> - Specifies that
+ <parameter>pos</parameter> is a count of characters from the end of
+ the file. A negative count specifies a position within the current
+ extent of the file; a positive count specifies a position past the
+ current end. If you set the position past the current end, and
+ actually write data, you will extend the file with zeros up to that
+ position.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ </para>
+ </refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title>Setting the baud rate on a serial port</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -108,11 +110,11 @@
dio_close($fd);
?>
]]>
- </programlisting>
- </example>
- </para>
- </refsect1>
- </refentry>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/diff.php/phpdoc/en/reference/dio/functions/dio-stat.xml?r1=1.4&r2=1.5&ty=u
Index: phpdoc/en/reference/dio/functions/dio-stat.xml
diff -u phpdoc/en/reference/dio/functions/dio-stat.xml:1.4
phpdoc/en/reference/dio/functions/dio-stat.xml:1.5
--- phpdoc/en/reference/dio/functions/dio-stat.xml:1.4 Tue Apr 5 08:50:53 2005
+++ phpdoc/en/reference/dio/functions/dio-stat.xml Tue Apr 5 08:51:55 2005
@@ -1,113 +1,113 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
- <refentry id="function.dio-stat">
- <refnamediv>
- <refname>dio_stat</refname>
- <refpurpose>
- Gets stat information about the file descriptor fd
- </refpurpose>
- </refnamediv>
- <refsect1 role="description">
- &reftitle.description;
- <methodsynopsis>
- <type>array</type><methodname>dio_stat</methodname>
- <methodparam><type>resource</type><parameter>fd</parameter></methodparam>
- </methodsynopsis>
- <para>
- <function>dio_stat</function> returns information about the given file
- descriptor.
- </para>
- </refsect1>
- <refsect1 role="parameters">
- &reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>fd</parameter></term>
- <listitem>
- <para>
- The file descriptor returned by <function>dio_open</function>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </refsect1>
- <refsect1 role="returnvalues">
- &reftitle.returnvalues;
- <para>
- Returns an associative array with the following keys:
- <itemizedlist>
- <listitem>
- <para>
- "device" - device
- </para>
- </listitem>
- <listitem>
- <para>
- "inode" - inode
- </para>
- </listitem>
- <listitem>
- <para>
- "mode" - mode
- </para>
- </listitem>
- <listitem>
- <para>
- "nlink" - number of hard links
- </para>
- </listitem>
- <listitem>
- <para>
- "uid" - user id
- </para>
- </listitem>
- <listitem>
- <para>
- "gid" - group id
- </para>
- </listitem>
- <listitem>
- <para>
- "device_type" - device type (if inode device)
- </para>
- </listitem>
- <listitem>
- <para>
- "size" - total size in bytes
- </para>
- </listitem>
- <listitem>
- <para>
- "blocksize" - blocksize
- </para>
- </listitem>
- <listitem>
- <para>
- "blocks" - number of blocks allocated
- </para>
- </listitem>
- <listitem>
- <para>
- "atime" - time of last access
- </para>
- </listitem>
- <listitem>
- <para>
- "mtime" - time of last modification
- </para>
- </listitem>
- <listitem>
- <para>
- "ctime" - time of last change
- </para>
- </listitem>
- </itemizedlist>
- On error <function>dio_stat</function> returns &null;.
- </para>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.5 $ -->
+<refentry id="function.dio-stat">
+ <refnamediv>
+ <refname>dio_stat</refname>
+ <refpurpose>
+ Gets stat information about the file descriptor fd
+ </refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>array</type><methodname>dio_stat</methodname>
+ <methodparam><type>resource</type><parameter>fd</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ <function>dio_stat</function> returns information about the given file
+ descriptor.
+ </para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>fd</parameter></term>
+ <listitem>
+ <para>
+ The file descriptor returned by <function>dio_open</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns an associative array with the following keys:
+ <itemizedlist>
+ <listitem>
+ <para>
+ "device" - device
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ "inode" - inode
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ "mode" - mode
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ "nlink" - number of hard links
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ "uid" - user id
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ "gid" - group id
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ "device_type" - device type (if inode device)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ "size" - total size in bytes
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ "blocksize" - blocksize
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ "blocks" - number of blocks allocated
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ "atime" - time of last access
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ "mtime" - time of last modification
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ "ctime" - time of last change
+ </para>
+ </listitem>
+ </itemizedlist>
+ On error <function>dio_stat</function> returns &null;.
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/diff.php/phpdoc/en/reference/dio/functions/dio-tcsetattr.xml?r1=1.9&r2=1.10&ty=u
Index: phpdoc/en/reference/dio/functions/dio-tcsetattr.xml
diff -u phpdoc/en/reference/dio/functions/dio-tcsetattr.xml:1.9
phpdoc/en/reference/dio/functions/dio-tcsetattr.xml:1.10
--- phpdoc/en/reference/dio/functions/dio-tcsetattr.xml:1.9 Tue Apr 5
08:50:53 2005
+++ phpdoc/en/reference/dio/functions/dio-tcsetattr.xml Tue Apr 5 08:51:55 2005
@@ -1,83 +1,83 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.9 $ -->
- <refentry id="function.dio-tcsetattr">
- <refnamediv>
- <refname>dio_tcsetattr</refname>
- <refpurpose>
- Sets terminal attributes and baud rate for a serial port
- </refpurpose>
- </refnamediv>
- <refsect1 role="description">
- &reftitle.description;
- <methodsynopsis>
- <type>void</type><methodname>dio_tcsetattr</methodname>
- <methodparam><type>resource</type><parameter>fd</parameter></methodparam>
-
<methodparam><type>array</type><parameter>options</parameter></methodparam>
- </methodsynopsis>
- <para>
- <function>dio_tcsetattr</function> sets the terminal attributes and baud
- rate of the open <parameter>resource</parameter>.
- </para>
- ¬e.no-windows;
- </refsect1>
- <refsect1 role="parameters">
- &reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>fd</parameter></term>
- <listitem>
- <para>
- The file descriptor returned by <function>dio_open</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>options</parameter></term>
- <listitem>
- <para>
- The currently available options are
- <itemizedlist>
- <listitem>
- <para>
- 'baud' - baud rate of the port - can be
38400,19200,9600,4800,2400,1800,
- 1200,600,300,200,150,134,110,75 or 50, default value is 9600.
- </para>
- </listitem>
- <listitem>
- <para>
- 'bits' - data bits - can be 8,7,6 or 5. Default value is 8.
- </para>
- </listitem>
- <listitem>
- <para>
- 'stop' - stop bits - can be 1 or 2. Default value is 1.
- </para>
- </listitem>
- <listitem>
- <para>
- 'parity' - can be 0,1 or 2. Default value is 0.
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </refsect1>
- <refsect1 role="returnvalues">
- &reftitle.returnvalues;
- <para>
- &return.void;
- </para>
- </refsect1>
- <refsect1 role="examples">
- &reftitle.examples;
- <para>
- <example>
- <title>Setting the baud rate on a serial port</title>
- <programlisting role="php">
+<!-- $Revision: 1.10 $ -->
+<refentry id="function.dio-tcsetattr">
+ <refnamediv>
+ <refname>dio_tcsetattr</refname>
+ <refpurpose>
+ Sets terminal attributes and baud rate for a serial port
+ </refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <void/><methodname>dio_tcsetattr</methodname>
+ <methodparam><type>resource</type><parameter>fd</parameter></methodparam>
+ <methodparam><type>array</type><parameter>options</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ <function>dio_tcsetattr</function> sets the terminal attributes and baud
+ rate of the open <parameter>resource</parameter>.
+ </para>
+ ¬e.no-windows;
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>fd</parameter></term>
+ <listitem>
+ <para>
+ The file descriptor returned by <function>dio_open</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>options</parameter></term>
+ <listitem>
+ <para>
+ The currently available options are
+ <itemizedlist>
+ <listitem>
+ <para>
+ 'baud' - baud rate of the port - can be
38400,19200,9600,4800,2400,1800,
+ 1200,600,300,200,150,134,110,75 or 50, default value is 9600.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ 'bits' - data bits - can be 8,7,6 or 5. Default value is 8.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ 'stop' - stop bits - can be 1 or 2. Default value is 1.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ 'parity' - can be 0,1 or 2. Default value is 0.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.void;
+ </para>
+ </refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title>Setting the baud rate on a serial port</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -103,11 +103,11 @@
?>
]]>
- </programlisting>
- </example>
- </para>
- </refsect1>
- </refentry>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/diff.php/phpdoc/en/reference/dio/functions/dio-truncate.xml?r1=1.5&r2=1.6&ty=u
Index: phpdoc/en/reference/dio/functions/dio-truncate.xml
diff -u phpdoc/en/reference/dio/functions/dio-truncate.xml:1.5
phpdoc/en/reference/dio/functions/dio-truncate.xml:1.6
--- phpdoc/en/reference/dio/functions/dio-truncate.xml:1.5 Tue Apr 5
08:50:53 2005
+++ phpdoc/en/reference/dio/functions/dio-truncate.xml Tue Apr 5 08:51:55 2005
@@ -1,61 +1,61 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
- <refentry id="function.dio-truncate">
- <refnamediv>
- <refname>dio_truncate</refname>
- <refpurpose>
- Truncates file descriptor fd to offset bytes
- </refpurpose>
- </refnamediv>
- <refsect1 role="description">
- &reftitle.description;
- <methodsynopsis>
- <type>bool</type><methodname>dio_truncate</methodname>
- <methodparam><type>resource</type><parameter>fd</parameter></methodparam>
- <methodparam><type>int</type><parameter>offset</parameter></methodparam>
- </methodsynopsis>
- <para>
- <function>dio_truncate</function> truncates a file to at most
- <parameter>offset</parameter> bytes in size.
- </para>
- <para>
- If the file previously was larger than this size, the extra data is
- lost. If the file previously was shorter, it is unspecified whether the
- file is left unchanged or is extended. In the latter case the extended
- part reads as zero bytes.
- </para>
- ¬e.no-windows;
- </refsect1>
- <refsect1 role="parameters">
- &reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>fd</parameter></term>
- <listitem>
- <para>
- The file descriptor returned by <function>dio_open</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>offset</parameter></term>
- <listitem>
- <para>
- The offset in bytes.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </refsect1>
- <refsect1 role="returnvalues">
- &reftitle.returnvalues;
- <para>
- &return.success;
- </para>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.6 $ -->
+<refentry id="function.dio-truncate">
+ <refnamediv>
+ <refname>dio_truncate</refname>
+ <refpurpose>
+ Truncates file descriptor fd to offset bytes
+ </refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>bool</type><methodname>dio_truncate</methodname>
+ <methodparam><type>resource</type><parameter>fd</parameter></methodparam>
+ <methodparam><type>int</type><parameter>offset</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ <function>dio_truncate</function> truncates a file to at most
+ <parameter>offset</parameter> bytes in size.
+ </para>
+ <para>
+ If the file previously was larger than this size, the extra data is
+ lost. If the file previously was shorter, it is unspecified whether the
+ file is left unchanged or is extended. In the latter case the extended
+ part reads as zero bytes.
+ </para>
+ ¬e.no-windows;
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>fd</parameter></term>
+ <listitem>
+ <para>
+ The file descriptor returned by <function>dio_open</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>offset</parameter></term>
+ <listitem>
+ <para>
+ The offset in bytes.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/diff.php/phpdoc/en/reference/dio/functions/dio-write.xml?r1=1.4&r2=1.5&ty=u
Index: phpdoc/en/reference/dio/functions/dio-write.xml
diff -u phpdoc/en/reference/dio/functions/dio-write.xml:1.4
phpdoc/en/reference/dio/functions/dio-write.xml:1.5
--- phpdoc/en/reference/dio/functions/dio-write.xml:1.4 Tue Apr 5 08:50:53 2005
+++ phpdoc/en/reference/dio/functions/dio-write.xml Tue Apr 5 08:51:55 2005
@@ -1,73 +1,72 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
- <refentry id="function.dio-write">
- <refnamediv>
- <refname>dio_write</refname>
- <refpurpose>
- Writes data to fd with optional truncation at length
- </refpurpose>
- </refnamediv>
- <refsect1 role="description">
- &reftitle.description;
- <methodsynopsis>
- <type>int</type><methodname>dio_write</methodname>
- <methodparam><type>resource</type><parameter>fd</parameter></methodparam>
- <methodparam><type>string</type><parameter>data</parameter></methodparam>
- <methodparam
choice="opt"><type>int</type><parameter>len</parameter></methodparam>
- </methodsynopsis>
- <para>
- The function <function>dio_write</function> writes up to
- <parameter>len</parameter> bytes from <parameter>data</parameter>
- to file <parameter>fd</parameter>.
- </para>
- </refsect1>
- <refsect1 role="parameters">
- &reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>fd</parameter></term>
- <listitem>
- <para>
- The file descriptor returned by <function>dio_open</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>data</parameter></term>
- <listitem>
- <para>
- The written data.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>len</parameter></term>
- <listitem>
- <para>
- The length of data to write in bytes. If not specified, the
- function writes all the data to the specified file.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </refsect1>
- <refsect1 role="returnvalues">
- &reftitle.returnvalues;
- <para>
- Returns the number of bytes written to <parameter>fd</parameter>.
- </para>
- </refsect1>
- <refsect1 role="seealso">
- &reftitle.seealso;
- <para>
- <simplelist>
- <member><function>dio_read</function></member>
- </simplelist>
- </para>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.5 $ -->
+<refentry id="function.dio-write">
+ <refnamediv>
+ <refname>dio_write</refname>
+ <refpurpose>
+ Writes data to fd with optional truncation at length
+ </refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>int</type><methodname>dio_write</methodname>
+ <methodparam><type>resource</type><parameter>fd</parameter></methodparam>
+ <methodparam><type>string</type><parameter>data</parameter></methodparam>
+ <methodparam
choice="opt"><type>int</type><parameter>len</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ <function>dio_write</function> writes up to <parameter>len</parameter>
+ bytes from <parameter>data</parameter> to file <parameter>fd</parameter>.
+ </para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>fd</parameter></term>
+ <listitem>
+ <para>
+ The file descriptor returned by <function>dio_open</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>data</parameter></term>
+ <listitem>
+ <para>
+ The written data.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>len</parameter></term>
+ <listitem>
+ <para>
+ The length of data to write in bytes. If not specified, the
+ function writes all the data to the specified file.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the number of bytes written to <parameter>fd</parameter>.
+ </para>
+ </refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>dio_read</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
