summaryrefslogtreecommitdiff
path: root/static/netbsd/man3/sqlite3changegroup_output.3
diff options
context:
space:
mode:
Diffstat (limited to 'static/netbsd/man3/sqlite3changegroup_output.3')
-rw-r--r--static/netbsd/man3/sqlite3changegroup_output.347
1 files changed, 47 insertions, 0 deletions
diff --git a/static/netbsd/man3/sqlite3changegroup_output.3 b/static/netbsd/man3/sqlite3changegroup_output.3
new file mode 100644
index 00000000..98f0627c
--- /dev/null
+++ b/static/netbsd/man3/sqlite3changegroup_output.3
@@ -0,0 +1,47 @@
+.Dd January 24, 2024
+.Dt SQLITE3CHANGEGROUP_OUTPUT 3
+.Os
+.Sh NAME
+.Nm sqlite3changegroup_output
+.Nd obtain a composite changeset from a changegroup
+.Sh SYNOPSIS
+.In sqlite3.h
+.Ft int
+.Fo sqlite3changegroup_output
+.Fa "sqlite3_changegroup*"
+.Fa "int *pnData"
+.Fa "void **ppData"
+.Fc
+.Sh DESCRIPTION
+Obtain a buffer containing a changeset (or patchset) representing the
+current contents of the changegroup.
+If the inputs to the changegroup were themselves changesets, the output
+is a changeset.
+Or, if the inputs were patchsets, the output is also a patchset.
+.Pp
+As with the output of the sqlite3session_changeset() and sqlite3session_patchset()
+functions, all changes related to a single table are grouped together
+in the output of this function.
+Tables appear in the same order as for the very first changeset added
+to the changegroup.
+If the second or subsequent changesets added to the changegroup contain
+changes for tables that do not appear in the first changeset, they
+are appended onto the end of the output changeset, again in the order
+in which they are first encountered.
+.Pp
+If an error occurs, an SQLite error code is returned and the output
+variables (*pnData) and (*ppData) are set to 0.
+Otherwise, SQLITE_OK is returned and the output variables are set to
+the size of and a pointer to the output buffer, respectively.
+In this case it is the responsibility of the caller to eventually free
+the buffer using a call to sqlite3_free().
+.Sh IMPLEMENTATION NOTES
+These declarations were extracted from the
+interface documentation at line 11983.
+.Bd -literal
+SQLITE_API int sqlite3changegroup_output(
+ sqlite3_changegroup*,
+ int *pnData, /* OUT: Size of output buffer in bytes */
+ void **ppData /* OUT: Pointer to output buffer */
+);
+.Ed