File: oci-lob-seek.xml

package info (click to toggle)
php-doc 20100521-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 59,992 kB
  • ctags: 4,085
  • sloc: xml: 796,833; php: 21,338; cpp: 500; sh: 117; makefile: 58; awk: 28
file content (104 lines) | stat: -rw-r--r-- 2,886 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 298108 $ -->
<refentry xml:id="function.oci-lob-seek" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>OCI-Lob->seek</refname>
  <refpurpose>Sets the internal pointer of the large object</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <classsynopsis>
   <ooclass><classname>OCI-Lob</classname></ooclass>
   <methodsynopsis>
    <type>bool</type><methodname>seek</methodname>
    <methodparam><type>int</type><parameter>offset</parameter></methodparam>
    <methodparam choice="opt"><type>int</type><parameter>whence</parameter><initializer><constant>OCI_SEEK_SET</constant></initializer></methodparam>
   </methodsynopsis>
  </classsynopsis>
  <para>
   Sets the internal pointer of the large object.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>
       Indicates the amount of bytes, on which internal pointer should be
       moved from the position, pointed by <parameter>whence</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>whence</parameter></term>
     <listitem>
      <para>
       May be one of:
       <simplelist>
        <member>
         <constant>OCI_SEEK_SET</constant> - sets the position equal to 
         <parameter>offset</parameter>
        </member>
        <member>
         <constant>OCI_SEEK_CUR</constant> - adds <parameter>offset</parameter> 
         bytes to the current position  
        </member>
        <member>
         <constant>OCI_SEEK_END</constant> - adds <parameter>offset</parameter>
         bytes to the end of large object (use negative value to move to a position
         before the end of large object)
        </member>
       </simplelist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><xref linkend="function.oci-lob-rewind" /></member>
    <member><xref linkend="function.oci-lob-tell" /></member>
    <member><xref linkend="function.oci-lob-eof" /></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->