xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3rebaser_rebase.3 (revision b9988867a8ad969c45a52aa7628bc932ec98d46b)
1.Dd January 24, 2024
2.Dt SQLITE3REBASER_REBASE 3
3.Os
4.Sh NAME
5.Nm sqlite3rebaser_rebase
6.Nd rebase a changeset
7.Sh SYNOPSIS
8.In sqlite3.h
9.Ft int
10.Fo sqlite3rebaser_rebase
11.Fa "sqlite3_rebaser*"
12.Fa "int nIn"
13.Fa "const void *pIn"
14.Fa "int *pnOut"
15.Fa "void **ppOut"
16.Fc
17.Sh DESCRIPTION
18Argument pIn must point to a buffer containing a changeset nIn bytes
19in size.
20This function allocates and populates a buffer with a copy of the changeset
21rebased according to the configuration of the rebaser object passed
22as the first argument.
23If successful, (*ppOut) is set to point to the new buffer containing
24the rebased changeset and (*pnOut) to its size in bytes and SQLITE_OK
25returned.
26It is the responsibility of the caller to eventually free the new buffer
27using sqlite3_free().
28Otherwise, if an error occurs, (*ppOut) and (*pnOut) are set to zero
29and an SQLite error code returned.
30.Sh IMPLEMENTATION NOTES
31These declarations were extracted from the
32interface documentation at line 12477.
33.Bd -literal
34SQLITE_API int sqlite3rebaser_rebase(
35  sqlite3_rebaser*,
36  int nIn, const void *pIn,
37  int *pnOut, void **ppOut
38);
39.Ed
40