.TH "scalar: process scalars easily." 3 "19 Mar 2004" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
scalar: process scalars easily. \- 
.SS "Functions"

.in +1c
.ti -1c
.RI "\fBnetsnmp_mib_handler\fP * \fBnetsnmp_get_scalar_handler\fP (void)"
.br
.RI "\fICreates a scalar handler calling netsnmp_create_handler with a handler name defaulted to 'scalar' and access method, netsnmp_scalar_helper_handler.\fP"
.ti -1c
.RI "int \fBnetsnmp_register_scalar\fP (\fBnetsnmp_handler_registration\fP *reginfo)"
.br
.RI "\fIThis function registers a scalar helper handler.\fP"
.ti -1c
.RI "int \fBnetsnmp_register_read_only_scalar\fP (\fBnetsnmp_handler_registration\fP *reginfo)"
.br
.RI "\fIThis function registers a read only scalar helper handler.\fP"
.in -1c
.SH "FUNCTION DOCUMENTATION"
.PP 
.SS "\fBnetsnmp_mib_handler\fP* netsnmp_get_scalar_handler (void)"
.PP
Creates a scalar handler calling netsnmp_create_handler with a handler name defaulted to 'scalar' and access method, netsnmp_scalar_helper_handler.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIvoid\fP\fP
\fBReturns: \fP
.in +1c
Returns a pointer to a netsnmp_mib_handler struct which contains the handler's name and the access method
.PP
\fBSee also: \fP
.in +1c
\fBnetsnmp_get_scalar_handler\fP , \fBnetsnmp_register_scalar\fP 
.PP
Definition at line 51 of file scalar.c.
.PP
References netsnmp_create_handler().
.PP
Referenced by netsnmp_register_read_only_scalar(), and netsnmp_register_scalar().
.SS "int netsnmp_register_read_only_scalar (\fBnetsnmp_handler_registration\fP * reginfo)"
.PP
This function registers a read only scalar helper handler.
.PP
This  function is very similar to netsnmp_register_scalar the only addition is that the 'read_only' handler is injected into the handler chain prior to injecting the serialize handler and registering reginfo.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIreginfo\fP\fP
a handler registration structure which could get created using netsnmp_create_handler_registration. Used to register a read only scalar helper handler.
.PP
\fBReturns: \fP
.in +1c
MIB_REGISTERED_OK is returned if the registration was a success. Failures are MIB_REGISTRATION_FAILURE and MIB_DUPLICATE_REGISTRATION.
.PP
\fBSee also: \fP
.in +1c
\fBnetsnmp_register_scalar\fP , \fBnetsnmp_get_scalar_handler\fP 
.PP
Definition at line 114 of file scalar.c.
.PP
References netsnmp_get_instance_handler(), netsnmp_get_read_only_handler(), netsnmp_get_scalar_handler(), netsnmp_inject_handler(), netsnmp_register_serialize(), netsnmp_handler_registration_s::rootoid, and netsnmp_handler_registration_s::rootoid_len.
.SS "int netsnmp_register_scalar (\fBnetsnmp_handler_registration\fP * reginfo)"
.PP
This function registers a scalar helper handler.
.PP
The registered OID,  reginfo->rootoid, space is extended for the instance subid using  realloc() but the reginfo->rootoid_len length is not extended just yet. .This function subsequently injects the instance, scalar, and serialize helper handlers before actually registering reginfo.
.PP
Each handler is injected/pushed to the top of the handler chain list  and will be processed last in first out, LIFO.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIreginfo\fP\fP
a handler registration structure which could get created using netsnmp_create_handler_registration. Used to register a scalar helper handler.
.PP
\fBReturns: \fP
.in +1c
MIB_REGISTERED_OK is returned if the registration was a success. Failures are MIB_REGISTRATION_FAILURE and MIB_DUPLICATE_REGISTRATION.
.PP
\fBSee also: \fP
.in +1c
\fBnetsnmp_register_read_only_scalar\fP , \fBnetsnmp_get_scalar_handler\fP 
.PP
Definition at line 79 of file scalar.c.
.PP
References netsnmp_get_instance_handler(), netsnmp_get_scalar_handler(), netsnmp_inject_handler(), netsnmp_register_serialize(), netsnmp_handler_registration_s::rootoid, and netsnmp_handler_registration_s::rootoid_len.