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
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!-- DOCTYPE refentry PUBLIC "-//Norman Walsh//DTD DocBk XML V3.1.7//EN" "DocBook/docbookx.dtd" -->
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<!--
$Id$
-->
<refentry id="fn_bookmark">
<refmeta>
<refentrytitle>bookmark</refentrytitle>
<refmiscinfo>cursors</refmiscinfo>
</refmeta>
<refnamediv>
<refname>bookmark</refname>
<refpurpose>Return the bookmark for current row of a scrollable cursor</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_bookmark">
<funcprototype id="fproto_bookmark">
<funcdef>any <function>bookmark</function></funcdef>
<paramdef>in <parameter>cursor</parameter> CURSOR</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_bookmark">
<title>Description</title>
<para><function>bookmark</function> returns a bookmark for the current row
of an open scrollable cursor. Given an invalid argument, i.e. no cursor,
no current row or non-open cursor, it signals an error. The returned
value can be used in subsequent FETCH .. BOOKMARK over the same
cursor.</para>
</refsect1>
<refsect1 id="params_bookmark">
<title>Parameters</title>
<refsect2>
<title>bookmark</title>
<para>Given Bookmark.</para>
</refsect2>
<refsect2>
<title>cursor</title>
<para>Open scrollable cursor.</para>
</refsect2>
</refsect1>
<refsect1 id="ret_bookmark"><title>Return Types</title>
<para><parameter>integer</parameter> bookmark id.</para></refsect1>
<refsect1 id="errors_bookmark"><title>Errors</title>
<table><title>Errors signalled by</title>
<tgroup cols="4">
<thead><row><entry>SQLState</entry><entry>Error Code</entry><entry>Error Text</entry><entry>Description</entry></row></thead>
<tbody>
<row>
<entry><errorcode>24000</errorcode></entry>
<entry><errorcode>SR238</errorcode></entry>
<entry><errorname>Virtuoso/PL Scrollable cursor not opened</errorname></entry>
<entry></entry>
</row>
<row>
<entry><errorcode>HY109</errorcode></entry>
<entry><errorcode>SR239</errorcode></entry>
<entry><errorname>Virtuoso/PL Scrollable cursor not positioned on a row</errorname></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1>
<!--
<refsect1 id="examples_bookmark"><title>Examples</title>
<example id="ex_bookmark"><title></title>
<para></para>
<screen></screen>
</example>
</refsect1>
-->
<refsect1 id="seealso_bookmark"><title>See Also</title>
<para><link linkend="openfetchetcintostmts">Cursors</link> in
<link linkend="sqlprocedures">Virtuoso/PL guide</link></para>
</refsect1>
</refentry>
|
