blob: 829660e202375bb52165367dec6a951bf42f66eb [file] [log] [blame]
.TH "iterator_info_s" 3 "31 May 2012" "Version 5.5.2.rc2" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
iterator_info_s \-
.PP
Holds iterator information containing functions which should be called by the iterator_handler to loop over your data set and sort it in a SNMP specific manner.
.SH SYNOPSIS
.br
.PP
.SS "Data Fields"
.in +1c
.ti -1c
.RI "\fBnetsnmp_container\fP \fBc\fP"
.br
.ti -1c
.RI "Netsnmp_Iterator_Loop_Key * \fBget_first\fP"
.br
.ti -1c
.RI "Netsnmp_Iterator_Loop_Key * \fBget_next\fP"
.br
.ti -1c
.RI "Netsnmp_Iterator_Loop_Data * \fBget_data\fP"
.br
.ti -1c
.RI "Netsnmp_Iterator_Data * \fBfree_user_ctx\fP"
.br
.ti -1c
.RI "Netsnmp_Iterator_Ctx * \fBinit_loop_ctx\fP"
.br
.ti -1c
.RI "Netsnmp_Iterator_Ctx * \fBcleanup_loop_ctx\fP"
.br
.ti -1c
.RI "Netsnmp_Iterator_Ctx_Dup * \fBsave_pos\fP"
.br
.ti -1c
.RI "Netsnmp_Iterator_Data * \fBrelease_data\fP"
.br
.ti -1c
.RI "Netsnmp_Iterator_Data * \fBinsert_data\fP"
.br
.ti -1c
.RI "Netsnmp_Iterator_Data * \fBremove_data\fP"
.br
.ti -1c
.RI "Netsnmp_Iterator_Op * \fBget_size\fP"
.br
.ti -1c
.RI "int \fBsorted\fP"
.br
.ti -1c
.RI "void * \fBuser_ctx\fP"
.br
.RI "\fIThis can be used by client handlers to store any information they need. \fP"
.in -1c
.SH "Detailed Description"
.PP
Holds iterator information containing functions which should be called by the iterator_handler to loop over your data set and sort it in a SNMP specific manner.
The iterator_info typedef can be used instead of directly calling this struct if you would prefer.
.PP
Definition at line 39 of file container_iterator.c.
.SH "Field Documentation"
.PP
.SS "void* \fBiterator_info_s::user_ctx\fP"
.PP
This can be used by client handlers to store any information they need.
.PP
Definition at line 69 of file container_iterator.c.
.SH "Author"
.PP
Generated automatically by Doxygen for net-snmp from the source code.