NAME

arif_select_page - select the page of candidates

SYNOPSYS

#include <arif/arif.h>

int
arif_select_page (
    struct arif_ctx *ctx,
    int              idx
);

DESCRIPTION

The arif_select_page() function changes the input context ctx's current page of candidates to the page referred to by idx.

The argument idx can either be a specific page number (starting at 1), or a relative page (-1 for the previous page, and 0 for the next page).

If the page does not exist, this function has no effect.

RETURN VALUES

Returns the page number if the given page exists, or -1 if otherwise.

NOTES

Default page

If the arif_select_page() function is not yet called after a query, the first page is the current page.

COPYRIGHT

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.

You should have received a copy of the license along with this document. If not, see <https://www.gnu.org/licenses/fdl-1.3.html>.