abies Mon Sep 1 19:49:57 2003 EDT
Modified files:
/phpdoc/en/reference/ibase/functions ibase-blob-add.xml
ibase-blob-cancel.xml
ibase-blob-close.xml
ibase-blob-create.xml
ibase-blob-echo.xml
ibase-blob-get.xml
ibase-blob-import.xml
ibase-blob-info.xml
ibase-blob-open.xml
Log:
Fixed prototypes and added missing descriptions
Index: phpdoc/en/reference/ibase/functions/ibase-blob-add.xml
diff -u phpdoc/en/reference/ibase/functions/ibase-blob-add.xml:1.3
phpdoc/en/reference/ibase/functions/ibase-blob-add.xml:1.4
--- phpdoc/en/reference/ibase/functions/ibase-blob-add.xml:1.3 Sun Jul 27 18:21:30
2003
+++ phpdoc/en/reference/ibase/functions/ibase-blob-add.xml Mon Sep 1 19:49:57
2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.39 -->
<refentry id='function.ibase-blob-add'>
<refnamediv>
@@ -12,7 +12,7 @@
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ibase_blob_add</methodname>
- <methodparam><type>int</type><parameter>blob_id</parameter></methodparam>
+
<methodparam><type>resource</type><parameter>blob_handle</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
@@ -22,10 +22,10 @@
</para>
<para>
See also
- <function>ibase_blob_create</function>,
<function>ibase_blob_cancel</function>,
- <function>ibase_blob_close</function> and
- <function>ibase_import</function>.
+ <function>ibase_blob_close</function>,
+ <function>ibase_blob_create</function> and
+ <function>ibase_blob_import</function>.
</para>
</refsect1>
</refentry>
Index: phpdoc/en/reference/ibase/functions/ibase-blob-cancel.xml
diff -u phpdoc/en/reference/ibase/functions/ibase-blob-cancel.xml:1.3
phpdoc/en/reference/ibase/functions/ibase-blob-cancel.xml:1.4
--- phpdoc/en/reference/ibase/functions/ibase-blob-cancel.xml:1.3 Sun Jul 27
18:21:30 2003
+++ phpdoc/en/reference/ibase/functions/ibase-blob-cancel.xml Mon Sep 1 19:49:57
2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.39 -->
<refentry id='function.ibase-blob-cancel'>
<refnamediv>
@@ -12,10 +12,18 @@
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ibase_blob_cancel</methodname>
- <methodparam><type>int</type><parameter>blob_id</parameter></methodparam>
+
<methodparam><type>resource</type><parameter>blob_handle</parameter></methodparam>
</methodsynopsis>
<para>
- &warn.undocumented.func;
+ This function will discard a BLOB created by
<function>ibase_create_blob</function>
+ if it has not yet been closed by <function>ibase_blob_close</function>.
+ &return.success;
+ </para>
+ <para>
+ See also
+ <function>ibase_blob_close</function>,
+ <function>ibase_blob_create</function> and
+ <function>ibase_blob_import</function>.
</para>
</refsect1>
</refentry>
Index: phpdoc/en/reference/ibase/functions/ibase-blob-close.xml
diff -u phpdoc/en/reference/ibase/functions/ibase-blob-close.xml:1.3
phpdoc/en/reference/ibase/functions/ibase-blob-close.xml:1.4
--- phpdoc/en/reference/ibase/functions/ibase-blob-close.xml:1.3 Sun Jul 27
18:21:30 2003
+++ phpdoc/en/reference/ibase/functions/ibase-blob-close.xml Mon Sep 1 19:49:57
2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.39 -->
<refentry id='function.ibase-blob-close'>
<refnamediv>
@@ -11,11 +11,21 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>bool</type><methodname>ibase_blob_close</methodname>
- <methodparam><type>int</type><parameter>blob_id</parameter></methodparam>
+ <type>mixed</type><methodname>ibase_blob_close</methodname>
+
<methodparam><type>resource</type><parameter>blob_handle</parameter></methodparam>
</methodsynopsis>
<para>
- &warn.undocumented.func;
+ This function closes a BLOB that has either been opened for reading by
+ <function>ibase_open_blob</function> or has been opened for writing by
+ <function>ibase_create_blob</function>. If the BLOB was being read, this function
+ returns &true; on success, if the BLOB was being written to, this function
+ returns a string containing the BLOB id that has been assigned to it by the
database.
+ On failure, this function returns &false;.
+ </para>
+ <para>
+ See also
+ <function>ibase_blob_cancel</function> and
+ <function>ibase_blob_open</function>.
</para>
</refsect1>
</refentry>
Index: phpdoc/en/reference/ibase/functions/ibase-blob-create.xml
diff -u phpdoc/en/reference/ibase/functions/ibase-blob-create.xml:1.3
phpdoc/en/reference/ibase/functions/ibase-blob-create.xml:1.4
--- phpdoc/en/reference/ibase/functions/ibase-blob-create.xml:1.3 Sun Jul 27
18:21:30 2003
+++ phpdoc/en/reference/ibase/functions/ibase-blob-create.xml Mon Sep 1 19:49:57
2003
@@ -1,22 +1,22 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.39 -->
<refentry id='function.ibase-blob-create'>
<refnamediv>
<refname>ibase_blob_create</refname>
<refpurpose>
- Creates a new blob for adding data
+ Create a new blob for adding data
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>ibase_blob_create</methodname>
+ <type>resource</type><methodname>ibase_blob_create</methodname>
<methodparam
choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<para>
- <function>ibase_blob_create</function> creates a new blob for
- filling with data. It returns the blob id for later use with
+ <function>ibase_blob_create</function> creates a new BLOB for
+ filling with data. It returns a BLOB handle for later use with
<function>ibase_blob_add</function> or &false; on failure.
</para>
<para>
Index: phpdoc/en/reference/ibase/functions/ibase-blob-echo.xml
diff -u phpdoc/en/reference/ibase/functions/ibase-blob-echo.xml:1.3
phpdoc/en/reference/ibase/functions/ibase-blob-echo.xml:1.4
--- phpdoc/en/reference/ibase/functions/ibase-blob-echo.xml:1.3 Sun Jul 27 18:21:30
2003
+++ phpdoc/en/reference/ibase/functions/ibase-blob-echo.xml Mon Sep 1 19:49:57
2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.39 -->
<refentry id='function.ibase-blob-echo'>
<refnamediv>
@@ -12,10 +12,18 @@
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ibase_blob_echo</methodname>
- <methodparam><type>string</type><parameter>blob_id_str</parameter></methodparam>
+ <methodparam><type>string</type><parameter>blob_id</parameter></methodparam>
</methodsynopsis>
<para>
- &warn.undocumented.func;
+ This function opens a BLOB for reading and sends its contents directly
+ to standard output (the browser, in most cases).
+ &return.success;
+ </para>
+ <para>
+ See also
+ <function>ibase_blob_open</function>,
+ <function>ibase_blob_close</function> and
+ <function>ibase_blob_get</function>.
</para>
</refsect1>
</refentry>
Index: phpdoc/en/reference/ibase/functions/ibase-blob-get.xml
diff -u phpdoc/en/reference/ibase/functions/ibase-blob-get.xml:1.2
phpdoc/en/reference/ibase/functions/ibase-blob-get.xml:1.3
--- phpdoc/en/reference/ibase/functions/ibase-blob-get.xml:1.2 Wed Apr 17 02:38:49
2002
+++ phpdoc/en/reference/ibase/functions/ibase-blob-get.xml Mon Sep 1 19:49:57
2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.41 -->
<refentry id='function.ibase-blob-get'>
<refnamediv>
@@ -12,11 +12,25 @@
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>ibase_blob_get</methodname>
- <methodparam><type>int</type><parameter>blob_id</parameter></methodparam>
+
<methodparam><type>resource</type><parameter>blob_handle</parameter></methodparam>
<methodparam><type>int</type><parameter>len</parameter></methodparam>
</methodsynopsis>
<para>
- &warn.undocumented.func;
+ This function returns at most <parameter>len</parameter> bytes from a BLOB
+ that has been opened for reading by <function>ibase_blob_open</function>.
+ Returns &false; on failure.
+ </para>
+ <note>
+ <para>
+ It is not possible to read from a BLOB that has been opened for writing
+ by <function>ibase_blob_create</function>.
+ </para>
+ </note>
+ <para>
+ See also
+ <function>ibase_blob_open</function>,
+ <function>ibase_blob_close</function> and
+ <function>ibase_blob_echo</function>.
</para>
</refsect1>
</refentry>
Index: phpdoc/en/reference/ibase/functions/ibase-blob-import.xml
diff -u phpdoc/en/reference/ibase/functions/ibase-blob-import.xml:1.3
phpdoc/en/reference/ibase/functions/ibase-blob-import.xml:1.4
--- phpdoc/en/reference/ibase/functions/ibase-blob-import.xml:1.3 Sun Jul 27
18:21:30 2003
+++ phpdoc/en/reference/ibase/functions/ibase-blob-import.xml Mon Sep 1 19:49:57
2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.39 -->
<refentry id='function.ibase-blob-import'>
<refnamediv>
@@ -13,10 +13,19 @@
<methodsynopsis>
<type>string</type><methodname>ibase_blob_import</methodname>
<methodparam
choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
- <methodparam><type>int</type><parameter>file_id</parameter></methodparam>
+
<methodparam><type>resource</type><parameter>file_handle</parameter></methodparam>
</methodsynopsis>
<para>
- &warn.undocumented.func;
+ This function creates a BLOB, reads an entire file into it, closes it and
+ returns the assigned BLOB id. The file handle is a handle returned by
+ <function>fopen</function>. Returns &false; on failure.
+ </para>
+ <para>
+ See also
+ <function>ibase_blob_add</function>,
+ <function>ibase_blob_cancel</function>,
+ <function>ibase_blob_close</function> and
+ <function>ibase_blob_create</function>.
</para>
</refsect1>
</refentry>
Index: phpdoc/en/reference/ibase/functions/ibase-blob-info.xml
diff -u phpdoc/en/reference/ibase/functions/ibase-blob-info.xml:1.2
phpdoc/en/reference/ibase/functions/ibase-blob-info.xml:1.3
--- phpdoc/en/reference/ibase/functions/ibase-blob-info.xml:1.2 Wed Apr 17 02:38:49
2002
+++ phpdoc/en/reference/ibase/functions/ibase-blob-info.xml Mon Sep 1 19:49:57
2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.39 -->
<refentry id='function.ibase-blob-info'>
<refnamediv>
@@ -11,11 +11,13 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>object</type><methodname>ibase_blob_info</methodname>
- <methodparam><type>string</type><parameter>blob_id_str</parameter></methodparam>
+ <type>array</type><methodname>ibase_blob_info</methodname>
+ <methodparam><type>string</type><parameter>blob_id</parameter></methodparam>
</methodsynopsis>
<para>
- &warn.undocumented.func;
+ Returns an array containing information about a BLOB. The information returned
+ consists of the length of the BLOB, the number of segments it contains, the size
+ of the largest segment, and whether it is a stream BLOB or a segmented BLOB.
</para>
</refsect1>
</refentry>
Index: phpdoc/en/reference/ibase/functions/ibase-blob-open.xml
diff -u phpdoc/en/reference/ibase/functions/ibase-blob-open.xml:1.2
phpdoc/en/reference/ibase/functions/ibase-blob-open.xml:1.3
--- phpdoc/en/reference/ibase/functions/ibase-blob-open.xml:1.2 Wed Apr 17 02:38:49
2002
+++ phpdoc/en/reference/ibase/functions/ibase-blob-open.xml Mon Sep 1 19:49:57
2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.39 -->
<refentry id='function.ibase-blob-open'>
<refnamediv>
@@ -11,11 +11,19 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>ibase_blob_open</methodname>
+ <type>resource</type><methodname>ibase_blob_open</methodname>
<methodparam><type>string</type><parameter>blob_id</parameter></methodparam>
</methodsynopsis>
<para>
- &warn.undocumented.func;
+ <function>ibase_blob_open</function> opens an existing BLOB for
+ reading. It returns a BLOB handle for later use with
+ <function>ibase_blob_get</function> or &false; on failure.
+ </para>
+ <para>
+ See also
+ <function>ibase_blob_close</function>,
+ <function>ibase_blob_echo</function> and
+ <function>ibase_blob_get</function>.
</para>
</refsect1>
</refentry>
