summaryrefslogtreecommitdiff
path: root/runtime/doc/eval.txt
diff options
context:
space:
mode:
authorBram Moolenaar <Bram@vim.org>2017-12-12 22:45:31 +0100
committerBram Moolenaar <Bram@vim.org>2017-12-12 22:45:31 +0100
commita6d4849c711379b773529afaed640455287ac934 (patch)
treeb46e5a0f0d49e07234c87d9ea60edd6b2500b617 /runtime/doc/eval.txt
parentfae8ed1fc8c06b28528d726e8440dfc66852bca8 (diff)
downloadvim-git-a6d4849c711379b773529afaed640455287ac934.tar.gz
patch 8.0.1389: getqflist() items are missing if not setv8.0.1389
Problem: getqflist() items are missing if not set, that makes it more difficult to handle the values. Solution: When a value is not available return zero or another invalid value. (Yegappan Lakshmanan, closes #2430)
Diffstat (limited to 'runtime/doc/eval.txt')
-rw-r--r--runtime/doc/eval.txt24
1 files changed, 14 insertions, 10 deletions
diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt
index 3afd67551..977ff718b 100644
--- a/runtime/doc/eval.txt
+++ b/runtime/doc/eval.txt
@@ -4687,7 +4687,7 @@ getqflist([{what}]) *getqflist()*
winid get the quickfix |window-ID|
all all of the above quickfix properties
Non-string items in {what} are ignored. To get the value of a
- particular item, set it to one.
+ particular item, set it to zero.
If "nr" is not present then the current quickfix list is used.
If both "nr" and a non-zero "id" are specified, then the list
specified by "id" is used.
@@ -4697,17 +4697,21 @@ getqflist([{what}]) *getqflist()*
When "lines" is specified, all the other items except "efm"
are ignored. The returned dictionary contains the entry
"items" with the list of entries.
- In case of error processing {what}, an empty dictionary is
- returned.
The returned dictionary contains the following entries:
- context context information stored with |setqflist()|
- id quickfix list ID |quickfix-ID|
- idx index of the current entry in the list
- items quickfix list entries
- nr quickfix list number
- size number of entries in the quickfix list
- title quickfix list title text
+ context context information stored with |setqflist()|.
+ If not present, set to "".
+ id quickfix list ID |quickfix-ID|. If not
+ present, set to 0.
+ idx index of the current entry in the list. If not
+ present, set to 0.
+ items quickfix list entries. If not present, set to
+ an empty list.
+ nr quickfix list number. If not present, set to 0
+ size number of entries in the quickfix list. If not
+ present, set to 0.
+ title quickfix list title text. If not present, set
+ to "".
winid quickfix |window-ID|. If not present, set to 0
Examples: >