[#wallet-SQLiteCursor]
= xref:wallet.adoc[wallet]::SQLiteCursor
:relfileprefix: ../
:mrdocs:

RAII class that provides a database cursor

== Synopsis

Declared in `<wallet/sqlite.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class SQLiteCursor
    : public xref:wallet/DatabaseCursor.adoc[DatabaseCursor]
----

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `xref:wallet/DatabaseCursor.adoc[DatabaseCursor]`
| Iterates over records stored in a wallet database.
|===

== Enums

[cols="1,4"]
|===
| Name| Description
| xref:wallet/DatabaseCursor/Status.adoc[`Status`] 
| Result of advancing the cursor.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:wallet/SQLiteCursor/2constructor-04f.adoc[`SQLiteCursor`]         [.small]#[constructor]#
| Constructors
| xref:wallet/SQLiteCursor/2destructor.adoc[`~SQLiteCursor`] [.small]#[destructor]# [.small]#[virtual]#
| Destroy the cursor and finalize its prepared statement.
| xref:wallet/DatabaseCursor/operator_assign.adoc[`operator=`]  [.small]#[deleted]#
| Cursors are non‐copyable.
| xref:wallet/SQLiteCursor/Next.adoc[`Next`]  [.small]#[virtual]#
| Read the next record from the cursor.
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:wallet/SQLiteCursor/m_cursor_stmt.adoc[`m_cursor_stmt`] 
| The prepared statement backing this cursor.
| xref:wallet/SQLiteCursor/m_prefix_range_end.adoc[`m_prefix_range_end`] 
| Exclusive upper bound of the key prefix range for a prefix cursor.
| xref:wallet/SQLiteCursor/m_prefix_range_start.adoc[`m_prefix_range_start`] 
| Inclusive lower bound of the key prefix range for a prefix cursor.
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#