blob: ba568c9025501510e0a317995660cd168b730d32 [file] [log] [blame] [edit]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>lwIP: MIB2</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">lwIP<span id="projectnumber">&#160;2.1.3</span>
</div>
<div id="projectbrief">Lightweight IP stack</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('group__snmp__mib2.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">MIB2<div class="ingroups"><a class="el" href="group__apps.html">Applications</a> &raquo; <a class="el" href="group__snmp.html">SNMPv2c/v3 agent</a></div></div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gacde87dc1d3bd669b19d834b028f490cc" id="r_gacde87dc1d3bd669b19d834b028f490cc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gacde87dc1d3bd669b19d834b028f490cc">snmp_mib2_set_sysdescr</a> (const u8_t *str, const u16_t *len)</td></tr>
<tr class="separator:gacde87dc1d3bd669b19d834b028f490cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf96002d9d10bcae27a95b2367674249e" id="r_gaf96002d9d10bcae27a95b2367674249e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf96002d9d10bcae27a95b2367674249e">snmp_mib2_set_syscontact</a> (u8_t *ocstr, u16_t *ocstrlen, u16_t bufsize)</td></tr>
<tr class="separator:gaf96002d9d10bcae27a95b2367674249e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga53339a03d720c745790837905bc2171a" id="r_ga53339a03d720c745790837905bc2171a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga53339a03d720c745790837905bc2171a">snmp_mib2_set_syscontact_readonly</a> (const u8_t *ocstr, const u16_t *ocstrlen)</td></tr>
<tr class="separator:ga53339a03d720c745790837905bc2171a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae7ce98a6ecc0bb92aaa2b330599a2db7" id="r_gae7ce98a6ecc0bb92aaa2b330599a2db7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gae7ce98a6ecc0bb92aaa2b330599a2db7">snmp_mib2_set_sysname</a> (u8_t *ocstr, u16_t *ocstrlen, u16_t bufsize)</td></tr>
<tr class="separator:gae7ce98a6ecc0bb92aaa2b330599a2db7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab95eb687492fa0e7d762f911c442bdc5" id="r_gab95eb687492fa0e7d762f911c442bdc5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gab95eb687492fa0e7d762f911c442bdc5">snmp_mib2_set_sysname_readonly</a> (const u8_t *ocstr, const u16_t *ocstrlen)</td></tr>
<tr class="separator:gab95eb687492fa0e7d762f911c442bdc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4248e004a27344b7260574c3a51882f2" id="r_ga4248e004a27344b7260574c3a51882f2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga4248e004a27344b7260574c3a51882f2">snmp_mib2_set_syslocation</a> (u8_t *ocstr, u16_t *ocstrlen, u16_t bufsize)</td></tr>
<tr class="separator:ga4248e004a27344b7260574c3a51882f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac1759d5b0640943697be2ad538325267" id="r_gac1759d5b0640943697be2ad538325267"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gac1759d5b0640943697be2ad538325267">snmp_mib2_set_syslocation_readonly</a> (const u8_t *ocstr, const u16_t *ocstrlen)</td></tr>
<tr class="separator:gac1759d5b0640943697be2ad538325267"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaf96002d9d10bcae27a95b2367674249e" name="gaf96002d9d10bcae27a95b2367674249e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf96002d9d10bcae27a95b2367674249e">&#9670;&#160;</a></span>snmp_mib2_set_syscontact()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void snmp_mib2_set_syscontact </td>
<td>(</td>
<td class="paramtype">u8_t *</td> <td class="paramname"><span class="paramname"><em>ocstr</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16_t *</td> <td class="paramname"><span class="paramname"><em>ocstrlen</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16_t</td> <td class="paramname"><span class="paramname"><em>bufsize</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes sysContact pointers</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ocstr</td><td>if non-NULL then copy str pointer </td></tr>
<tr><td class="paramname">ocstrlen</td><td>points to string length, excluding zero terminator. if set to NULL it is assumed that ocstr is NULL-terminated. </td></tr>
<tr><td class="paramname">bufsize</td><td>size of the buffer in bytes. (this is required because the buffer can be overwritten by snmp-set) if ocstrlen is NULL buffer needs space for terminating 0 byte. otherwise complete buffer is used for string. if bufsize is set to 0, the value is regarded as read-only. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga53339a03d720c745790837905bc2171a" name="ga53339a03d720c745790837905bc2171a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga53339a03d720c745790837905bc2171a">&#9670;&#160;</a></span>snmp_mib2_set_syscontact_readonly()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void snmp_mib2_set_syscontact_readonly </td>
<td>(</td>
<td class="paramtype">const u8_t *</td> <td class="paramname"><span class="paramname"><em>ocstr</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const u16_t *</td> <td class="paramname"><span class="paramname"><em>ocstrlen</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>see <a class="el" href="#gaf96002d9d10bcae27a95b2367674249e">snmp_mib2_set_syscontact</a> but set pointer to readonly memory </p>
</div>
</div>
<a id="gacde87dc1d3bd669b19d834b028f490cc" name="gacde87dc1d3bd669b19d834b028f490cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacde87dc1d3bd669b19d834b028f490cc">&#9670;&#160;</a></span>snmp_mib2_set_sysdescr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void snmp_mib2_set_sysdescr </td>
<td>(</td>
<td class="paramtype">const u8_t *</td> <td class="paramname"><span class="paramname"><em>str</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const u16_t *</td> <td class="paramname"><span class="paramname"><em>len</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes sysDescr pointers.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>if non-NULL then copy str pointer </td></tr>
<tr><td class="paramname">len</td><td>points to string length, excluding zero terminator </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga4248e004a27344b7260574c3a51882f2" name="ga4248e004a27344b7260574c3a51882f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4248e004a27344b7260574c3a51882f2">&#9670;&#160;</a></span>snmp_mib2_set_syslocation()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void snmp_mib2_set_syslocation </td>
<td>(</td>
<td class="paramtype">u8_t *</td> <td class="paramname"><span class="paramname"><em>ocstr</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16_t *</td> <td class="paramname"><span class="paramname"><em>ocstrlen</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16_t</td> <td class="paramname"><span class="paramname"><em>bufsize</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes sysLocation pointers</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ocstr</td><td>if non-NULL then copy str pointer </td></tr>
<tr><td class="paramname">ocstrlen</td><td>points to string length, excluding zero terminator. if set to NULL it is assumed that ocstr is NULL-terminated. </td></tr>
<tr><td class="paramname">bufsize</td><td>size of the buffer in bytes. (this is required because the buffer can be overwritten by snmp-set) if ocstrlen is NULL buffer needs space for terminating 0 byte. otherwise complete buffer is used for string. if bufsize is set to 0, the value is regarded as read-only. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gac1759d5b0640943697be2ad538325267" name="gac1759d5b0640943697be2ad538325267"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac1759d5b0640943697be2ad538325267">&#9670;&#160;</a></span>snmp_mib2_set_syslocation_readonly()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void snmp_mib2_set_syslocation_readonly </td>
<td>(</td>
<td class="paramtype">const u8_t *</td> <td class="paramname"><span class="paramname"><em>ocstr</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const u16_t *</td> <td class="paramname"><span class="paramname"><em>ocstrlen</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>see <a class="el" href="#ga4248e004a27344b7260574c3a51882f2">snmp_mib2_set_syslocation</a> but set pointer to readonly memory </p>
</div>
</div>
<a id="gae7ce98a6ecc0bb92aaa2b330599a2db7" name="gae7ce98a6ecc0bb92aaa2b330599a2db7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae7ce98a6ecc0bb92aaa2b330599a2db7">&#9670;&#160;</a></span>snmp_mib2_set_sysname()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void snmp_mib2_set_sysname </td>
<td>(</td>
<td class="paramtype">u8_t *</td> <td class="paramname"><span class="paramname"><em>ocstr</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16_t *</td> <td class="paramname"><span class="paramname"><em>ocstrlen</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16_t</td> <td class="paramname"><span class="paramname"><em>bufsize</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes sysName pointers</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ocstr</td><td>if non-NULL then copy str pointer </td></tr>
<tr><td class="paramname">ocstrlen</td><td>points to string length, excluding zero terminator. if set to NULL it is assumed that ocstr is NULL-terminated. </td></tr>
<tr><td class="paramname">bufsize</td><td>size of the buffer in bytes. (this is required because the buffer can be overwritten by snmp-set) if ocstrlen is NULL buffer needs space for terminating 0 byte. otherwise complete buffer is used for string. if bufsize is set to 0, the value is regarded as read-only. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gab95eb687492fa0e7d762f911c442bdc5" name="gab95eb687492fa0e7d762f911c442bdc5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab95eb687492fa0e7d762f911c442bdc5">&#9670;&#160;</a></span>snmp_mib2_set_sysname_readonly()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void snmp_mib2_set_sysname_readonly </td>
<td>(</td>
<td class="paramtype">const u8_t *</td> <td class="paramname"><span class="paramname"><em>ocstr</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const u16_t *</td> <td class="paramname"><span class="paramname"><em>ocstrlen</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>see <a class="el" href="#gae7ce98a6ecc0bb92aaa2b330599a2db7">snmp_mib2_set_sysname</a> but set pointer to readonly memory </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
</html>