aboutsummaryrefslogtreecommitdiffstats
path: root/src/sqlite.c
diff options
context:
space:
mode:
authorEli Zaretskii2022-10-30 10:31:00 +0200
committerEli Zaretskii2022-10-30 10:31:00 +0200
commit3ceaa918295e3038fcca9950410ada5d46edfdbe (patch)
tree454d7a06d5f372dac40de94beff362cddd28866b /src/sqlite.c
parentb489ca507058c7d23df6a3339bd30a6dc39fa55e (diff)
downloademacs-3ceaa918295e3038fcca9950410ada5d46edfdbe.tar.gz
emacs-3ceaa918295e3038fcca9950410ada5d46edfdbe.zip
; * src/sqlite.c (Fsqlite_select): Doc fix. (Bug#58885)
Diffstat (limited to 'src/sqlite.c')
-rw-r--r--src/sqlite.c17
1 files changed, 9 insertions, 8 deletions
diff --git a/src/sqlite.c b/src/sqlite.c
index d6cb38a29ad..08bf696b8ca 100644
--- a/src/sqlite.c
+++ b/src/sqlite.c
@@ -528,14 +528,15 @@ DEFUN ("sqlite-select", Fsqlite_select, Ssqlite_select, 2, 4, 0,
528If VALUES is non-nil, it should be a list or a vector specifying the 528If VALUES is non-nil, it should be a list or a vector specifying the
529values that will be interpolated into a parameterized statement. 529values that will be interpolated into a parameterized statement.
530 530
531By default, the return value is a list where the first element is a 531By default, the return value is a list, whose contents depend on
532list of column names, and the rest of the elements are the matching data. 532the value of the optional argument RETURN-TYPE.
533 533
534RETURN-TYPE can be either nil (which means that the matching data 534If RETURN-TYPE is nil or omitted, the function returns a list of rows
535should be returned as a list of rows), or `full' (the same, but the 535matching QUERY. If RETURN-TYPE is `full', the function returns a
536first element in the return list will be the column names), or `set', 536list whose first element is the list of column names, and the rest
537which means that we return a set object that can be queried with 537of the elements are the rows matching QUERY. If RETURN-TYPE is `set',
538`sqlite-next' and other functions to get the data. */) 538the function returns a set object that can be queried with functions
539like `sqlite-next' etc., in order to get the data. */)
539 (Lisp_Object db, Lisp_Object query, Lisp_Object values, 540 (Lisp_Object db, Lisp_Object query, Lisp_Object values,
540 Lisp_Object return_type) 541 Lisp_Object return_type)
541{ 542{