📄 snmpproclib.html
字号:
<html><head><!-- /vobs/wpwr/docs/vxworks/ref/snmpProcLib.html - generated by refgen from snmpProcLibDoc.c --> <title> snmpProcLib </title></head><body bgcolor="#FFFFFF"> <hr><a name="top"></a><p align=right><a href="libIndex.html"><i>VxWorks Reference Manual : Libraries</i></a></p></blockquote><h1>snmpProcLib</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong>snmpProcLib</strong> - manipulate variable-bindings in an SNMP packet </p></blockquote><h4>ROUTINES</h4><blockquote><p><p><b><i><a href="./snmpProcLib.html#getproc_started">getproc_started</a></i>( )</b> - indicate that a <b>getproc</b> operation has begun<br><b><i><a href="./snmpProcLib.html#getproc_good">getproc_good</a></i>( )</b> - indicate successful completion of a <b>getproc</b> procedure<br><b><i><a href="./snmpProcLib.html#getproc_error">getproc_error</a></i>( )</b> - indicate that a <b>getproc</b> operation encountered an error<br><b><i><a href="./snmpProcLib.html#nextproc_started">nextproc_started</a></i>( )</b> - indicate that a <b>nextproc</b> operation has begun<br><b><i><a href="./snmpProcLib.html#nextproc_good">nextproc_good</a></i>( )</b> - indicate successful completion of a <b>nextproc</b> procedure<br><b><i><a href="./snmpProcLib.html#nextproc_no_next">nextproc_no_next</a></i>( )</b> - indicate that there exists no next instance <br><b><i><a href="./snmpProcLib.html#nextproc_error">nextproc_error</a></i>( )</b> - indicate that a <b>nextproc</b> operation encountered an error<br><b><i><a href="./snmpProcLib.html#getproc_got_int32">getproc_got_int32</a></i>( )</b> - indicate retrieval of a 32-bit integer<br><b><i><a href="./snmpProcLib.html#getproc_got_uint32">getproc_got_uint32</a></i>( )</b> - indicate retrieval of a 32-bit unsigned integer<br><b><i><a href="./snmpProcLib.html#getproc_got_ip_address">getproc_got_ip_address</a></i>( )</b> - indicate retrieval of an IP address<br><b><i><a href="./snmpProcLib.html#getproc_got_empty">getproc_got_empty</a></i>( )</b> - indicate retrieval of a null value<br><b><i><a href="./snmpProcLib.html#getproc_got_string">getproc_got_string</a></i>( )</b> - indicate retrieval of a string<br><b><i><a href="./snmpProcLib.html#testproc_started">testproc_started</a></i>( )</b> - indicate that a <b>testproc</b> operation has begun<br><b><i><a href="./snmpProcLib.html#testproc_good">testproc_good</a></i>( )</b> - indicate successful completion of a <b>testproc</b> procedure<br><b><i><a href="./snmpProcLib.html#testproc_error">testproc_error</a></i>( )</b> - indicate that a <b>testproc</b> operation encountered an error<br><b><i><a href="./snmpProcLib.html#setproc_started">setproc_started</a></i>( )</b> - indicate that a <b>setproc</b> operation has begun<br><b><i><a href="./snmpProcLib.html#setproc_good">setproc_good</a></i>( )</b> - indicates successful completion of a <b>setproc</b> procedure<br><b><i><a href="./snmpProcLib.html#setproc_error">setproc_error</a></i>( )</b> - indicate that a <b>setproc</b> operation encountered an error<br><b><i><a href="./snmpProcLib.html#undoproc_started">undoproc_started</a></i>( )</b> - indicate that an <b>undoproc</b> operation has begun<br><b><i><a href="./snmpProcLib.html#undoproc_good">undoproc_good</a></i>( )</b> - indicates successful completion of an <b>undoproc</b> operation<br><b><i><a href="./snmpProcLib.html#undoproc_error">undoproc_error</a></i>( )</b> - indicate that an <b>undproc</b> operation encountered an error<br><b><i><a href="./snmpProcLib.html#getproc_got_uint64">getproc_got_uint64</a></i>( )</b> - indicate retrieval of a 64-bit unsigned integer<br><b><i><a href="./snmpProcLib.html#getproc_got_uint64_high_low">getproc_got_uint64_high_low</a></i>( )</b> - indicate retrieval of a 64-bit unsigned<br><b><i><a href="./snmpProcLib.html#getproc_nosuchins">getproc_nosuchins</a></i>( )</b> - indicates that no such instance exists<br><b><i><a href="./snmpProcLib.html#getproc_got_object_id">getproc_got_object_id</a></i>( )</b> - indicate retrieval of an object identifier<br><b><i><a href="./snmpProcLib.html#nextproc_next_instance">nextproc_next_instance</a></i>( )</b> - install instance part of next instance<br><p></blockquote><h4>DESCRIPTION</h4><blockquote><p><p>This module defines routines used to manipulate variable bindings inan SNMP packet. These are equivalents for macros defined in <b>snmpdefs.h</b>.<p></blockquote><h4>INCLUDE FILES</h4><blockquote><p><b>snmpdefs.h</b><p></blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./snmpProcLib.html#top">snmpProcLib</a></b><hr><a name="getproc_started"></a><p align=right><a href="rtnIndex.html"><i>Libraries : Routines</i></a></p></blockquote><h1><i>getproc_started</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>getproc_started</i>( )</strong> - indicate that a <b>getproc</b> operation has begun</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>void getproc_started ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind /* var bind being processed */ )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine indicates that <b>getproc</b> for the specified SNMPvariable binding has been started and should not be started again.<p></blockquote><h4>RETURNS</h4><blockquote><p>N/A</blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./snmpProcLib.html#top">snmpProcLib</a></b><hr><a name="getproc_good"></a><p align=right><a href="rtnIndex.html"><i>Libraries : Routines</i></a></p></blockquote><h1><i>getproc_good</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>getproc_good</i>( )</strong> - indicate successful completion of a <b>getproc</b> procedure</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>void getproc_good ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind /* var bind being processed */ )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine is called when <b>getproc</b> successfully retrieves the value foran SNMP variable binding. <p></blockquote><h4>RETURNS</h4><blockquote><p>N/A</blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./snmpProcLib.html#top">snmpProcLib</a></b><hr><a name="getproc_error"></a><p align=right><a href="rtnIndex.html"><i>Libraries : Routines</i></a></p></blockquote><h1><i>getproc_error</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>getproc_error</i>( )</strong> - indicate that a <b>getproc</b> operation encountered an error</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>void getproc_error ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind, /* var bind being processed */ INT_32_T error /* error code */ )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine indicates that <b>getproc</b> encountered an error andcannot retrieve the requested value.<p></blockquote><h4>RETURNS</h4><blockquote><p>N/A</blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./snmpProcLib.html#top">snmpProcLib</a></b><hr><a name="nextproc_started"></a><p align=right><a href="rtnIndex.html"><i>Libraries : Routines</i></a></p></blockquote><h1><i>nextproc_started</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>nextproc_started</i>( )</strong> - indicate that a <b>nextproc</b> operation has begun</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>void nextproc_started ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind /* var bind being processed */ )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine indicates that <b>nextproc</b> has begun for the specifiedvariable binding.<p></blockquote><h4>RETURNS</h4><blockquote><p>N/A</blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./snmpProcLib.html#top">snmpProcLib</a></b><hr><a name="nextproc_good"></a><p align=right><a href="rtnIndex.html"><i>Libraries : Routines</i></a></p></blockquote><h1><i>nextproc_good</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>nextproc_good</i>( )</strong> - indicate successful completion of a <b>nextproc</b> procedure</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>void nextproc_good ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind /* var bind being processed */ )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine indicates that <b>nextproc</b> for the specifiedvariable binding has completed successfully. <p></blockquote><h4>RETURNS</h4><blockquote><p>N/A</blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./snmpProcLib.html#top">snmpProcLib</a></b><hr><a name="nextproc_no_next"></a><p align=right><a href="rtnIndex.html"><i>Libraries : Routines</i></a></p></blockquote><h1><i>nextproc_no_next</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>nextproc_no_next</i>( )</strong> - indicate that there exists no next instance </p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>void nextproc_no_next ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind /* var bind being processed */ )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine is called from within <b>nextproc</b> if there is no next instance for the requested variable binding.<p></blockquote><h4>RETURNS</h4><blockquote><p>N/A</blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./snmpProcLib.html#top">snmpProcLib</a></b><hr><a name="nextproc_error"></a><p align=right><a href="rtnIndex.html"><i>Libraries : Routines</i></a></p></blockquote><h1><i>nextproc_error</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>nextproc_error</i>( )</strong> - indicate that a <b>nextproc</b> operation encountered an error</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>void nextproc_error ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind, /* var bind being processed */ INT_32_T error /* error code */ )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine is called when <b>nextproc</b> encounters an error and cannot retreive a next instance for the requested variable binding.<p></blockquote><h4>RETURNS</h4><blockquote><p>N/A</blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./snmpProcLib.html#top">snmpProcLib</a></b><hr><a name="getproc_got_int32"></a><p align=right><a href="rtnIndex.html"><i>Libraries : Routines</i></a></p></blockquote><h1><i>getproc_got_int32</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>getproc_got_int32</i>( )</strong> - indicate retrieval of a 32-bit integer</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>void getproc_got_int32 ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind, /* var bind being processed */ INT_32_T data /* 32 bit integer value for varbind */ )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine is called from <b>getproc</b> or <b>nextproc</b> when a 32-bitinteger value is retreived for a variable binding.<p></blockquote><h4>RETURNS</h4><blockquote><p>N/A</blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./snmpProcLib.html#top">snmpProcLib</a></b><hr><a name="getproc_got_uint32"></a><p align=right><a href="rtnIndex.html"><i>Libraries : Routines</i></a></p></blockquote><h1><i>getproc_got_uint32</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>getproc_got_uint32</i>( )</strong> - indicate retrieval of a 32-bit unsigned integer</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>void getproc_got_uint32 ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind, /* var bind being processed */ UINT_32_T data, /* unsigned 32 bit integer value for varbind */ OCTET_T type /* SNMP type of value */ )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine is called from <b>getproc</b> or <b>nextproc</b> when a 32-bitunsigned integer value is retrieved for a variable binding.<p></blockquote><h4>RETURNS</h4><blockquote><p>N/A</blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./snmpProcLib.html#top">snmpProcLib</a></b><hr><a name="getproc_got_ip_address"></a><p align=right><a href="rtnIndex.html"><i>Libraries : Routines</i></a></p></blockquote><h1><i>getproc_got_ip_address</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>getproc_got_ip_address</i>( )</strong> - indicate retrieval of an IP address</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>void getproc_got_ip_address ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind, /* var bind being processed */ UINT_32_T addrData /* ip address value */ )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine is called from <b>getproc</b> or <b>nextproc</b> when an IP addressis retrieved for a variable binding.<p></blockquote><h4>RETURNS</h4><blockquote><p>N/A</blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./snmpProcLib.html#top">snmpProcLib</a></b><hr><a name="getproc_got_empty"></a><p align=right><a href="rtnIndex.html"><i>Libraries : Routines</i></a></p></blockquote><h1><i>getproc_got_empty</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>getproc_got_empty</i>( )</strong> - indicate retrieval of a null value</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>void getproc_got_empty ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind /* var bind being processed */ )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine is called from <b>getproc</b> or <b>nextproc</b> when a null valueis retrieved for a variable binding.<p></blockquote><h4>RETURNS</h4><blockquote><p>N/A</blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./snmpProcLib.html#top">snmpProcLib</a></b><hr><a name="getproc_got_string"></a><p align=right><a href="rtnIndex.html"><i>Libraries : Routines</i></a></p></blockquote><h1><i>getproc_got_string</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>getproc_got_string</i>( )</strong> - indicate retrieval of a string</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>void getproc_got_string ( SNMP_PKT_T * pPkt, /* internal representation of the snmp packet */ VB_T * pVarBind, /* var bind being processed */ ALENGTH_T size, /* size of string in octets */ OCTET_T * data, /* string data */ int dynamicFlg, /* storage type - dynamic or static */ OCTET_T type /* SNMP type of string data */ )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine is called from <b>getproc</b> or <b>nextproc</b> when a string isretrieved for a variable binding. The string data is stored in anextended buffer in the variable-binding structure. Tha parameter<i>dynamicFlg</i> indicates the storage type used by the extended buffer;if <i>dynamicFlg</i> is non-zero, then the buffer is assumed to have beenallocated dynamically via <b><i><a href="./snmpIoLib.html#snmpdMemoryAlloc">snmpdMemoryAlloc</a></i>( )</b> and will be freed laterwith <b><i><a href="./snmpIoLib.html#snmpdMemoryFree">snmpdMemoryFree</a></i>( )</b>. Otherwise, the buffer is assumed to be static.<p></blockquote><h4>RETURNS</h4><blockquote><p>N/A</blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./snmpProcLib.html#top">snmpProcLib</a></b><hr><a name="testproc_started"></a><p align=right>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -