Manual Page Result
0
Command: sqlite3changegroup_new | Section: 3 | Source: NetBSD | File: sqlite3changegroup_new.3
SQLITE3CHANGEGROUP_NEW(3) FreeBSD Library Functions Manual
NAME
sqlite3changegroup_new - Create A New Changegroup Object
SYNOPSIS
int
sqlite3changegroup_new(sqlite3_changegroup **pp);
DESCRIPTION
An sqlite3_changegroup object is used to combine two or more changesets
(or patchsets) into a single changeset (or patchset). A single
changegroup object may combine changesets or patchsets, but not both.
The output is always in the same format as the input.
If successful, this function returns SQLITE_OK and populates (*pp) with a
pointer to a new sqlite3_changegroup object before returning. The caller
should eventually free the returned object using a call to
sqlite3changegroup_delete(). If an error occurs, an SQLite error code
(i.e. SQLITE_NOMEM) is returned and *pp is set to NULL.
The usual usage pattern for an sqlite3_changegroup object is as follows:
o It is created using a call to sqlite3changegroup_new().
o Zero or more changesets (or patchsets) are added to the object by
calling sqlite3changegroup_add().
o The result of combining all input changesets together is obtained by
the application via a call to sqlite3changegroup_output().
o The object is deleted using a call to sqlite3changegroup_delete().
Any number of calls to add() and output() may be made between the calls
to new() and delete(), and in any order.
As well as the regular sqlite3changegroup_add() and
sqlite3changegroup_output() functions, also available are the streaming
versions sqlite3changegroup_add_strm() and
sqlite3changegroup_output_strm().
FreeBSD 14.1-RELEASE-p8 December 19, 2018 FreeBSD 14.1-RELEASE-p8