Code

Add perl binding and documentation for new ping_iterator_count function
[liboping.git] / src / mans / ping_iterator_count.pod
1 =head1 NAME
3 ping_iterator_count - Count the number of hosts in a liboping object
5 =head1 SYNOPSIS
7   #include <oping.h>
9   int ping_iterator_count (pingobj_t *obj);
11 =head1 DESCRIPTION
13 This functions is used to count the number of hosts currently associated
14 with a liboping object.
16 =head1 RETURN VALUE
18 The B<ping_iterator_count> returns an integer number or zero if no host is
19 associated with I<obj>.
21 =head1 SEE ALSO
23 L<ping_host_add(3)>,
24 L<ping_iterator_get(3)>,
25 L<ping_iterator_next(3)>,
26 L<liboping(3)>
28 =head1 AUTHOR
30 liboping is written by Florian "octo" Forster E<lt>ff at octo.itE<gt>.
31 Its homepage can be found at L<http://noping.cc/>.
33 Copyright (c) 2005-2016 by Florian "octo" Forster.