diff options
Diffstat (limited to 'man/cmap_iter_next.3.in')
| -rw-r--r-- | man/cmap_iter_next.3.in | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/man/cmap_iter_next.3.in b/man/cmap_iter_next.3.in new file mode 100644 index 0000000..95eb664 --- /dev/null +++ b/man/cmap_iter_next.3.in @@ -0,0 +1,82 @@ +.\"/* +.\" * Copyright (c) 2012 Red Hat, Inc. +.\" * +.\" * All rights reserved. +.\" * +.\" * Author: Jan Friesse (jfriesse@redhat.com) +.\" * +.\" * This software licensed under BSD license, the text of which follows: +.\" * +.\" * Redistribution and use in source and binary forms, with or without +.\" * modification, are permitted provided that the following conditions are met: +.\" * +.\" * - Redistributions of source code must retain the above copyright notice, +.\" * this list of conditions and the following disclaimer. +.\" * - Redistributions in binary form must reproduce the above copyright notice, +.\" * this list of conditions and the following disclaimer in the documentation +.\" * and/or other materials provided with the distribution. +.\" * - Neither the name of the Red Hat, Inc. nor the names of its +.\" * contributors may be used to endorse or promote products derived from this +.\" * software without specific prior written permission. +.\" * +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF +.\" * THE POSSIBILITY OF SUCH DAMAGE. +.\" */ +.TH "CMAP_ITER_NEXT" 3 "06/02/2012" "corosync Man Page" "Corosync Cluster Engine Programmer's Manual" + +.SH NAME +.P +cmap_iter_next \- Return next item in iteration in CMAP + +.SH SYNOPSIS +.P +\fB#include <corosync/cmap.h>\fR + +.P +\fBcs_error_t +cmap_iter_next(cmap_handle_t \fIhandle\fB, cmap_iter_handle_t \fIiter_handle\fB, char \fIkey_name[]\fB, +size_t *\fIvalue_len\fB, cmap_value_types_t *\fItype\fB);\fR + +.SH DESCRIPTION +.P +The +.B cmap_iter_next +function is used to get next value in iteration. The +.I handle +argument is connection to CMAP database obtained by calling +.B cmap_initialize(3) +function. +.I iter_handle +argument is iterator handle obtained by +.B cmap_iter_init(3) +function. Following key name is stored inside +.I key_name +argument, which must be preallocated by caller and its guaranteed maximum size is CMAP_KEYNAME_MAXLEN +(currently 255). +.I value_len +is pointer where length of value is stored, but can be NULL. +.I type +is also optional argument (can be NULL) and here type of value is stored (type is one of types described +in +.B cmap_get(3) +function). + +.SH RETURN VALUE +This call returns the CS_OK value if successful. If there are no more items to iterate, CS_NO_SECTION +error code is returned. + +.SH "SEE ALSO" +.BR cmap_iter_init (3), +.BR cmap_iter_finalize (3), +.BR cmap_initialize (3), +.BR cmap_get (3), +.BR cmap_overview (3) |