Marc Kupietz | 62da2b5 | 2019-09-12 17:43:34 +0200 | [diff] [blame] | 1 | % Generated by roxygen2: do not edit by hand |
| 2 | % Please edit documentation in R/KorAPQuery.R |
| 3 | \name{KorAPFetchNext} |
| 4 | \alias{KorAPFetchNext} |
| 5 | \title{Fetch the next bunch of results of a KorAP query.} |
| 6 | \usage{ |
| 7 | KorAPFetchNext(queryObject, offset = queryObject$nextStartIndex, |
| 8 | maxFetch = maxResultsPerPage, verbose = FALSE) |
| 9 | } |
| 10 | \arguments{ |
| 11 | \item{queryObject}{object obtained from \code{\link{KorAPQuery}}} |
| 12 | |
| 13 | \item{offset}{start offset for query results to fetch} |
| 14 | |
| 15 | \item{maxFetch}{maximum number of query results to fetch} |
Marc Kupietz | 25aebc3 | 2019-09-16 18:40:50 +0200 | [diff] [blame^] | 16 | |
| 17 | \item{verbose}{print progress information if true} |
Marc Kupietz | 62da2b5 | 2019-09-12 17:43:34 +0200 | [diff] [blame] | 18 | } |
| 19 | \value{ |
| 20 | The \code{queryObject} input parameter with updated fields \code{$collectedMatches}, \code{$matches} (latest bunch only), \code{$nextStartIndex}, , \code{$hasMoreMatches} |
| 21 | } |
| 22 | \description{ |
| 23 | Fetch the next bunch of results of a KorAP query. |
| 24 | } |
| 25 | \examples{ |
Marc Kupietz | 25aebc3 | 2019-09-16 18:40:50 +0200 | [diff] [blame^] | 26 | q <- KorAPFetchNext(KorAPQuery(KorAPConnection(), "Ameisenplage")) |
Marc Kupietz | 62da2b5 | 2019-09-12 17:43:34 +0200 | [diff] [blame] | 27 | |
| 28 | } |
| 29 | \references{ |
| 30 | \url{https://ids-pub.bsz-bw.de/frontdoor/index/index/docId/9026} |
| 31 | } |
| 32 | \seealso{ |
| 33 | \code{\link{KorAPFetchRest}}, \code{\link{KorAPFetchAll}} |
| 34 | } |