varbind_api.h

00001 #ifndef NET_SNMP_VARBIND_API_H
00002 #define NET_SNMP_VARBIND_API_H
00003 
00008 #include <net-snmp/types.h>
00009 
00010 #ifdef __cplusplus
00011 extern          "C" {
00012 #endif
00013 
00014     /* Creation */
00015     netsnmp_variable_list *
00016        snmp_pdu_add_variable(netsnmp_pdu *pdu,
00017                                  const oid * name, size_t name_length,
00018                                  u_char type,
00019                                  const void * value, size_t len);
00020     netsnmp_variable_list *
00021        snmp_varlist_add_variable(netsnmp_variable_list ** varlist,
00022                                  const oid * name, size_t name_length,
00023                                  u_char type,
00024                                  const void * value, size_t len);
00025     netsnmp_variable_list *
00026        snmp_add_null_var(netsnmp_pdu *pdu,
00027                                  const oid * name, size_t name_length);
00028     netsnmp_variable_list *
00029        snmp_clone_varbind(netsnmp_variable_list * varlist);
00030 
00031     /* Setting Values */
00032     int             snmp_set_var_value(netsnmp_variable_list * var,
00033                                        const void * value, size_t len);
00034     int             snmp_set_var_objid(netsnmp_variable_list * var,
00035                                        const oid * name, size_t name_length);
00036     int             snmp_set_var_typed_value(netsnmp_variable_list * var,
00037                                        u_char type,
00038                                        const void * value, size_t len);
00039     int             snmp_set_var_typed_integer(netsnmp_variable_list * var,
00040                                        u_char type, long val);
00041 
00042      /* Output */
00043     void            print_variable(const oid * objid, size_t objidlen,
00044                                    const netsnmp_variable_list * variable);
00045     void           fprint_variable(FILE * fp,
00046                                    const oid * objid, size_t objidlen,
00047                                    const netsnmp_variable_list * variable);
00048     int           snprint_variable(char *buf, size_t buf_len,
00049                                    const oid * objid, size_t objidlen,
00050                                    const netsnmp_variable_list * variable);
00051 
00052     void             print_value(const oid * objid, size_t objidlen,
00053                                  const netsnmp_variable_list * variable);
00054     void            fprint_value(FILE * fp,
00055                                  const oid * objid, size_t objidlen,
00056                                  const netsnmp_variable_list * variable);
00057     int            snprint_value(char *buf, size_t buf_len,
00058                                  const oid * objid, size_t objidlen,
00059                                  const netsnmp_variable_list * variable);
00060 
00061     /* Deletion */
00062     void            snmp_free_var(    netsnmp_variable_list *var);     /* frees just this one */
00063     void            snmp_free_varbind(netsnmp_variable_list *varlist); /* frees all in list */
00064 
00065 #ifdef __cplusplus
00066 }
00067 #endif
00068 
00069     /*
00070      *  For the initial release, this will just refer to the
00071      *  relevant UCD header files.
00072      *    In due course, the routines relevant to this area of the
00073      *  API will be identified, and listed here directly.
00074      *
00075      *  But for the time being, this header file is a placeholder,
00076      *  to allow application writers to adopt the new header file names.
00077      */
00078 #include <net-snmp/library/snmp_api.h>
00079 #include <net-snmp/library/snmp_client.h>
00080 #include <net-snmp/library/mib.h>
00081 
00082 #endif                          /* NET_SNMP_VARBIND_API_H */