<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html xmlns:fn="http://www.w3.org/2005/02/xpath-functions">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../doc/otp_doc.css" type="text/css">
<title>Erlang -- Definition of Instrumentation Functions</title>
</head>
<body bgcolor="white" text="#000000" link="#0000ff" vlink="#ff00ff" alink="#ff0000"><div id="container">
<script id="js" type="text/javascript" language="JavaScript" src="../../../../doc/js/flipmenu/flipmenu.js"></script><script id="js2" type="text/javascript" src="../../../../doc/js/erlresolvelinks.js"></script><script language="JavaScript" type="text/javascript">
<!--
function getWinHeight() {
var myHeight = 0;
if( typeof( window.innerHeight ) == 'number' ) {
//Non-IE
myHeight = window.innerHeight;
} else if( document.documentElement && ( document.documentElement.clientWidth ||
document.documentElement.clientHeight ) ) {
//IE 6+ in 'standards compliant mode'
myHeight = document.documentElement.clientHeight;
} else if( document.body && ( document.body.clientWidth || document.body.clientHeight ) ) {
//IE 4 compatible
myHeight = document.body.clientHeight;
}
return myHeight;
}
function setscrollpos() {
var objf=document.getElementById('loadscrollpos');
document.getElementById("leftnav").scrollTop = objf.offsetTop - getWinHeight()/2;
}
function addEvent(obj, evType, fn){
if (obj.addEventListener){
obj.addEventListener(evType, fn, true);
return true;
} else if (obj.attachEvent){
var r = obj.attachEvent("on"+evType, fn);
return r;
} else {
return false;
}
}
addEvent(window, 'load', setscrollpos);
//--></script><div id="leftnav"><div class="innertube">
<img alt="Erlang logo" src="../../../../doc/erlang-logo.png"><br><small><a href="users_guide.html">User's Guide</a><br><a href="index.html">Reference Manual</a><br><a href="release_notes.html">Release Notes</a><br><a href="../pdf/snmp-4.22.1.pdf">PDF</a><br><a href="../../../../doc/index.html">Top</a></small><p><strong>Simple Network Management Protocol (SNMP)</strong><br><strong>User's Guide</strong><br><small>Version 4.22.1</small></p>
<br><a href="javascript:openAllFlips()">Expand All</a><br><a href="javascript:closeAllFlips()">Contract All</a><p><small><strong>Chapters</strong></small></p>
<ul class="flipMenu" imagepath="../../../../doc/js/flipmenu">
<li id="no" title="SNMP Introduction" expanded="false">SNMP Introduction<ul>
<li><a href="snmp_intro.html">
Top of chapter
</a></li>
<li title="Scope and Purpose"><a href="snmp_intro.html#id73205">Scope and Purpose</a></li>
<li title="Prerequisites"><a href="snmp_intro.html#id63280">Prerequisites</a></li>
<li title="Definitions"><a href="snmp_intro.html#id61217">Definitions</a></li>
<li title="About This Manual"><a href="snmp_intro.html#id66265">About This Manual</a></li>
<li title="Where to Find More Information"><a href="snmp_intro.html#id65242">Where to Find More Information</a></li>
</ul>
</li>
<li id="no" title="Agent Functional Description" expanded="false">Agent Functional Description<ul>
<li><a href="snmp_agent_funct_descr.html">
Top of chapter
</a></li>
<li title="Features"><a href="snmp_agent_funct_descr.html#id70043">Features</a></li>
<li title="SNMPv1, SNMPv2 and SNMPv3"><a href="snmp_agent_funct_descr.html#id69677">SNMPv1, SNMPv2 and SNMPv3</a></li>
<li title="Operation"><a href="snmp_agent_funct_descr.html#id71220">Operation</a></li>
<li title="Sub-agents and MIB Loading"><a href="snmp_agent_funct_descr.html#id75292">Sub-agents and MIB Loading</a></li>
<li title="Contexts and Communities"><a href="snmp_agent_funct_descr.html#id74241">Contexts and Communities</a></li>
<li title="Management of the Agent"><a href="snmp_agent_funct_descr.html#id74376">Management of the Agent</a></li>
<li title="Notifications"><a href="snmp_agent_funct_descr.html#id73838">Notifications</a></li>
<li title="Discovery"><a href="snmp_agent_funct_descr.html#id75718">Discovery</a></li>
</ul>
</li>
<li id="no" title="Manager Functional Description" expanded="false">Manager Functional Description<ul>
<li><a href="snmp_manager_funct_descr.html">
Top of chapter
</a></li>
<li title="Features"><a href="snmp_manager_funct_descr.html#id75862">Features</a></li>
<li title="Operation"><a href="snmp_manager_funct_descr.html#id76012">Operation</a></li>
<li title="MIB loading"><a href="snmp_manager_funct_descr.html#id76080">MIB loading</a></li>
</ul>
</li>
<li id="no" title="The MIB Compiler" expanded="false">The MIB Compiler<ul>
<li><a href="snmp_mib_compiler.html">
Top of chapter
</a></li>
<li title="Operation"><a href="snmp_mib_compiler.html#id76200">Operation</a></li>
<li title="Importing MIBs"><a href="snmp_mib_compiler.html#id76263">Importing MIBs</a></li>
<li title="MIB Consistency Checking"><a href="snmp_mib_compiler.html#id76334">MIB Consistency Checking</a></li>
<li title=".hrl File Generation"><a href="snmp_mib_compiler.html#id76371">.hrl File Generation</a></li>
<li title="Emacs Integration"><a href="snmp_mib_compiler.html#id76421">Emacs Integration</a></li>
<li title="Compiling from a Shell or a Makefile"><a href="snmp_mib_compiler.html#id76467">Compiling from a Shell or a Makefile</a></li>
<li title="Deviations from the Standard"><a href="snmp_mib_compiler.html#id76521">Deviations from the Standard</a></li>
</ul>
</li>
<li id="no" title="Running the application" expanded="false">Running the application<ul>
<li><a href="snmp_config.html">
Top of chapter
</a></li>
<li title="Configuring the application"><a href="snmp_config.html#id76778">Configuring the application</a></li>
<li title="Modifying the Configuration Files"><a href="snmp_config.html#id79236">Modifying the Configuration Files</a></li>
<li title="Starting the application"><a href="snmp_config.html#id79327">Starting the application</a></li>
<li title="Debugging the application"><a href="snmp_config.html#id79377">Debugging the application</a></li>
</ul>
</li>
<li id="no" title="Definition of Agent Configuration Files" expanded="false">Definition of Agent Configuration Files<ul>
<li><a href="snmp_agent_config_files.html">
Top of chapter
</a></li>
<li title="Agent Information"><a href="snmp_agent_config_files.html#id79867">Agent Information</a></li>
<li title="Contexts"><a href="snmp_agent_config_files.html#id79944">Contexts</a></li>
<li title="System Information"><a href="snmp_agent_config_files.html#id79997">System Information</a></li>
<li title="Communities"><a href="snmp_agent_config_files.html#id80066">Communities</a></li>
<li title="MIB Views for VACM"><a href="snmp_agent_config_files.html#id80148">MIB Views for VACM</a></li>
<li title="Security data for USM"><a href="snmp_agent_config_files.html#id80387">Security data for USM</a></li>
<li title="Notify Definitions"><a href="snmp_agent_config_files.html#id80603">Notify Definitions</a></li>
<li title="Target Address Definitions"><a href="snmp_agent_config_files.html#id80684">Target Address Definitions</a></li>
<li title="Target Parameters Definitions"><a href="snmp_agent_config_files.html#id80890">Target Parameters Definitions</a></li>
</ul>
</li>
<li id="no" title="Definition of Manager Configuration Files" expanded="false">Definition of Manager Configuration Files<ul>
<li><a href="snmp_manager_config_files.html">
Top of chapter
</a></li>
<li title="Manager Information"><a href="snmp_manager_config_files.html#id81118">Manager Information</a></li>
<li title="Users"><a href="snmp_manager_config_files.html#id81260">Users</a></li>
<li title="Agents"><a href="snmp_manager_config_files.html#id81361">Agents</a></li>
<li title="Security data for USM"><a href="snmp_manager_config_files.html#id81544">Security data for USM</a></li>
</ul>
</li>
<li id="no" title="Agent Implementation Example" expanded="false">Agent Implementation Example<ul>
<li><a href="snmp_impl_example_agent.html">
Top of chapter
</a></li>
<li title="MIB"><a href="snmp_impl_example_agent.html#id81793">MIB</a></li>
<li title="Default Implementation"><a href="snmp_impl_example_agent.html#id81833">Default Implementation</a></li>
<li title="Manual Implementation"><a href="snmp_impl_example_agent.html#id81912">Manual Implementation</a></li>
</ul>
</li>
<li id="no" title="Manager Implementation Example" expanded="false">Manager Implementation Example<ul>
<li><a href="snmp_impl_example_manager.html">
Top of chapter
</a></li>
<li title="The example manager"><a href="snmp_impl_example_manager.html#id82242">The example manager</a></li>
<li title="A simple standard test"><a href="snmp_impl_example_manager.html#id82333">A simple standard test</a></li>
</ul>
</li>
<li id="no" title="Instrumentation Functions" expanded="false">Instrumentation Functions<ul>
<li><a href="snmp_instr_functions.html">
Top of chapter
</a></li>
<li title="Instrumentation Functions"><a href="snmp_instr_functions.html#id82473">Instrumentation Functions</a></li>
<li title="Using the ExtraArgument"><a href="snmp_instr_functions.html#id83088">Using the ExtraArgument</a></li>
<li title="Default Instrumentation"><a href="snmp_instr_functions.html#id83196">Default Instrumentation</a></li>
<li title="Atomic Set"><a href="snmp_instr_functions.html#id83301">Atomic Set</a></li>
</ul>
</li>
<li id="loadscrollpos" title="Definition of Instrumentation Functions" expanded="true">Definition of Instrumentation Functions<ul>
<li><a href="snmp_def_instr_functions.html">
Top of chapter
</a></li>
<li title="Variable Instrumentation"><a href="snmp_def_instr_functions.html#id83474">Variable Instrumentation</a></li>
<li title="Table Instrumentation"><a href="snmp_def_instr_functions.html#id83849">Table Instrumentation</a></li>
</ul>
</li>
<li id="no" title="Definition of Agent Net if" expanded="false">Definition of Agent Net if<ul>
<li><a href="snmp_agent_netif.html">
Top of chapter
</a></li>
<li title="Mandatory Functions"><a href="snmp_agent_netif.html#id84750">Mandatory Functions</a></li>
<li title="Messages"><a href="snmp_agent_netif.html#id84772">Messages</a></li>
</ul>
</li>
<li id="no" title="Definition of Manager Net if" expanded="false">Definition of Manager Net if<ul>
<li><a href="snmp_manager_netif.html">
Top of chapter
</a></li>
<li title="Mandatory Functions"><a href="snmp_manager_netif.html#id85574">Mandatory Functions</a></li>
<li title="Messages"><a href="snmp_manager_netif.html#id85591">Messages</a></li>
</ul>
</li>
<li id="no" title="Audit Trail Log" expanded="false">Audit Trail Log<ul>
<li><a href="snmp_audit_trail_log.html">
Top of chapter
</a></li>
<li title="Agent Logging"><a href="snmp_audit_trail_log.html#id85997">Agent Logging</a></li>
<li title="Manager Logging"><a href="snmp_audit_trail_log.html#id86040">Manager Logging</a></li>
</ul>
</li>
<li id="no" title="Advanced Agent Topics" expanded="false">Advanced Agent Topics<ul>
<li><a href="snmp_advanced_agent.html">
Top of chapter
</a></li>
<li title="When to use a Sub-agent"><a href="snmp_advanced_agent.html#id86186">When to use a Sub-agent</a></li>
<li title="Agent Semantics"><a href="snmp_advanced_agent.html#id86296">Agent Semantics</a></li>
<li title="Sub-agents and Dependencies "><a href="snmp_advanced_agent.html#id86360">Sub-agents and Dependencies </a></li>
<li title="Distributed Tables"><a href="snmp_advanced_agent.html#id86378">Distributed Tables</a></li>
<li title="Fault Tolerance"><a href="snmp_advanced_agent.html#id86434">Fault Tolerance</a></li>
<li title="Using Mnesia Tables as SNMP Tables"><a href="snmp_advanced_agent.html#id86508">Using Mnesia Tables as SNMP Tables</a></li>
<li title="Deviations from the Standard"><a href="snmp_advanced_agent.html#id86786">Deviations from the Standard</a></li>
</ul>
</li>
<li id="no" title="SNMP Appendix A" expanded="false">SNMP Appendix A<ul>
<li><a href="snmp_app_a.html">
Top of chapter
</a></li>
<li title="Appendix A"><a href="snmp_app_a.html#id86932">Appendix A</a></li>
</ul>
</li>
<li id="no" title="SNMP Appendix B" expanded="false">SNMP Appendix B<ul>
<li><a href="snmp_app_b.html">
Top of chapter
</a></li>
<li title="Appendix B"><a href="snmp_app_b.html#id87320">Appendix B</a></li>
</ul>
</li>
</ul>
</div></div>
<div id="content">
<div class="innertube">
<h1>11 Definition of Instrumentation Functions</h1>
<p>The section <strong>Definition of Instrumentation Functions</strong> describes
the user defined functions, which the agent calls at different times.
</p>
<h3><a name="id83474">11.1
Variable Instrumentation</a></h3>
<p>For scalar variables, a function <span class="code">f(Operation, ...)</span> must
be defined.
</p>
<p>The <span class="code">Operation</span> can be <span class="code">new</span>, <span class="code">delete</span>,
<span class="code">get</span>, <span class="code">is_set_ok</span>, <span class="code">set</span>, or <span class="code">undo</span>.
</p>
<p>In case of an error, all instrumentation functions may return
either an SNMPv1 or an SNMPv2 error code. If it returns an SNMPv2
code, it is converted into an SNMPv1 code before it is sent to a
SNMPv1 manager. It is recommended to use the SNMPv2 error codes
for all instrumentation functions, as these provide more
details. See <span class="bold_code"><a href="snmp_app_a.html">Appendix A</a></span> for a
description of error code conversions.
</p>
<h4>f(new [, ExtraArgs])</h4>
<p>The function <span class="code">f(new [, ExtraArgs])</span> is called for each
variable in the MIB when the
MIB is loaded into the agent. This makes it possible to perform
necessary initialization.
</p>
<p>This function is optional. The return value is discarded.</p>
<h4>f(delete [, ExtraArgs])</h4>
<p>The function <span class="code">f(delete [, ExtraArgs])</span> is called
for each object in an MIB when the
MIB is unloaded from the agent. This makes it possible to
perform necessary clean-up.
</p>
<p>This function is optional. The return value is discarded.</p>
<h4>f(get [, ExtraArgs])</h4>
<p>The function <span class="code">f(get [, ExtraArgs])</span> is called when a
get-request or a get-next
request refers to the variable.
</p>
<p>This function is mandatory.
</p>
<h4>Valid Return Values</h4>
<ul>
<li>
<span class="code">{value, Value}</span>. The <span class="code">Value</span> must be of
correct type, length and within ranges, otherwise
<span class="code">genErr</span> is returned in the response PDU. If the
object is an enumerated integer, the symbolic enum value
may be used as an atom. If the object is of type BITS, the
return value shall be an integer or a list of bits that
are set.
</li>
<li>
<span class="code">{noValue, noSuchName}</span>(SNMPv1)
</li>
<li>
<span class="code">{noValue, noSuchObject | noSuchInstance} </span>(SNMPv2)
</li>
<li>
<span class="code">genErr</span>. Used if an error occurred. Note,
this should be an internal processing error, e.g. a caused
by a programing fault somewhere. If the variable does not
exist, use <span class="code">{noValue, noSuchName}</span> or
<span class="code">{noValue, noSuchInstance}</span>.
</li>
</ul>
<h4>f(is_set_ok, NewValue [, ExtraArgs])</h4>
<p>The function <span class="code">f(is_set_ok, NewValue [, ExtraArgs])</span> is
called in phase one of the set-request
processing so that the new value can be checked for
inconsistencies.
</p>
<p><span class="code">NewValue</span> is guaranteed to be of the correct type,
length and within ranges, as specified in the MIB. If the
object is an enumerated integer or of type BITS, the integer
value is used.
</p>
<p>This function is optional.
</p>
<p>If this function is called, it will be called again, either
with <span class="code">undo</span> or with <span class="code">set</span> as first argument.
</p>
<h4>Valid return values</h4>
<ul>
<li><span class="code">noError</span></li>
<li>
<span class="code">badValue | noSuchName | genErr</span>(SNMPv1)
</li>
<li>
<span class="code">noAccess | noCreation | inconsistentValue | resourceUnavailable | inconsistentName | genErr</span>(SNMPv2)</li>
</ul>
<h4>f(undo, NewValue [, ExtraArgs])</h4>
<p>If an error occurred, this function is called after the
<span class="code">is_set_ok</span> function is called. If <span class="code">set</span> is called for
this object, <span class="code">undo</span> is not called.
</p>
<p><span class="code">NewValue</span> is guaranteed to be of the correct type,
length and within ranges, as specified in the MIB. If the
object is an enumerated integer or of type BITS, the integer
value is used.
</p>
<p>This function is optional.
</p>
<h4>Valid return values</h4>
<ul>
<li><span class="code">noError</span></li>
<li>
<span class="code">genErr</span>(SNMPv1)
</li>
<li>
<span class="code">undoFailed | genErr</span>(SNMPv2)</li>
</ul>
<h4>f(set, NewValue [, ExtraArgs])</h4>
<p>This function is called to perform the set in phase two of
the set-request processing. It is only called if the
corresponding <span class="code">is_set_ok</span> function is present and returns
<span class="code">noError</span>.
</p>
<p><span class="code">NewValue</span> is guaranteed to be of the correct type,
length and within ranges, as specified in the MIB. If the
object is an enumerated integer or of type BITS, the integer
value is used.
</p>
<p>This function is mandatory.
</p>
<h4>Valid return values</h4>
<ul>
<li><span class="code">noError</span></li>
<li>
<span class="code">genErr</span>(SNMPv1)
</li>
<li>
<span class="code">commitFailed | undoFailed | genErr</span>(SNMPv2)</li>
</ul>
<h3><a name="id83849">11.2
Table Instrumentation</a></h3>
<p>For tables, a <span class="code">f(Operation, ...)</span> function should be
defined (the function shown is exemplified with <span class="code">f</span>).
</p>
<p>The <span class="code">Operation</span> can be <span class="code">new</span>, <span class="code">delete</span>,
<span class="code">get</span>, <span class="code">next</span>, <span class="code">is_set_ok</span>, <span class="code">undo</span> or
<span class="code">set</span>.
</p>
<p>In case of an error, all instrumentation functions may return
either an SNMPv1 or an SNMPv2 error code. If it returns an SNMPv2
code, it is converted into an SNMPv1 code before it is sent to a
SNMPv1 manager. It is recommended to use the SNMPv2 error codes
for all instrumentation functions, as these provide more
details. See <span class="bold_code"><a href="snmp_app_a.html">Appendix A</a></span> for a
description of error code conversions.</p>
<h4>f(new [, ExtraArgs])</h4>
<p>The function <span class="code">f(new [, ExtraArgs])</span> is called for each object in an MIB when the
MIB is loaded into the agent. This makes it possible to perform
the necessary initialization.
</p>
<p>This function is optional. The return value is discarded.</p>
<h4>f(delete [, ExtraArgs])</h4>
<p>The function <span class="code">f(delete [, ExtraArgs])</span> is called for each object in an MIB when the
MIB is unloaded from the agent. This makes it possible to
perform any necessary clean-up.
</p>
<p>This function is optional. The return value is discarded.</p>
<h4>f(get, RowIndex, Cols [, ExtraArgs])</h4>
<p>The function <span class="code">f(get, RowIndex, Cols [, ExtraArgs])</span> is
called when a get-request refers to a table.
</p>
<p>This function is mandatory.
</p>
<h4>Arguments</h4>
<ul>
<li>
<span class="code">RowIndex</span> is a list of integers which define the
key values for the row. The <span class="code">RowIndex</span> is the list
representation (list of integers) which follow the
<span class="code">Cols</span> integer in the OBJECT IDENTIFIER.
</li>
<li>
<span class="code">Cols</span> is a list of integers which represent the
column numbers. The <span class="code">Cols</span> are sorted by increasing
value and are guaranteed to be valid column numbers.</li>
</ul>
<h4>Valid Return Values</h4>
<ul>
<li>
<p>A list with as many elements as the <span class="code">Cols</span> list,
where each element is the value of the corresponding
column. Each element can be:</p>
<ul>
<li>
<span class="code">{value, Value}</span>. The <span class="code">Value</span> must be of
correct type, length and within ranges, otherwise
<span class="code">genErr</span> is returned in the response PDU. If the
object is an enumerated integer, the symbolic enum
value may be used (as an atom). If the object is of
type BITS, the return value shall be an integer or a
list of bits that are set.
</li>
<li>
<span class="code">{noValue, noSuchName}</span>(SNMPv1)
</li>
<li>
<span class="code">{noValue, noSuchObject | noSuchInstance}</span>(SNMPv2)
</li>
</ul>
</li>
<li>
<span class="code">{noValue, Error}</span>. If the row does not exist,
because all columns have <span class="code">{noValue, Error}</span>), the
single tuple <span class="code">{noValue, Error}</span> can be returned.
This is a shorthand for a list with all elements
<span class="code">{noValue, Error}</span>.
</li>
<li>
<span class="code">genErr</span>. Used if an error occurred. Note that
this should be an internal processing error, e.g. a caused
by a programing fault somewhere. If some column does not
exist, use <span class="code">{noValue, noSuchName}</span> or
<span class="code">{noValue, noSuchInstance}</span>.
</li>
</ul>
<h4>f(get_next, RowIndex, Cols [, ExtraArgs])</h4>
<p>The function <span class="code">f(get_next, RowIndex, Cols [, ExtraArgs])</span> is
called when a get-next- or a
get-bulk-request refers to the table.
</p>
<p>The <span class="code">RowIndex</span> argument may refer to an existing row or a
non-existing row, or it may be unspecified. The <span class="code">Cols</span> list
may refer to inaccessible columns or non-existing columns. For
each column in the <span class="code">Cols</span> list, the corresponding next
instance is determined, and the last part of its OBJECT
IDENTIFIER and its value is returned.
</p>
<p>This function is mandatory.
</p>
<h4>Arguments</h4>
<ul>
<li>
<span class="code">RowIndex</span> is a list of integers (possibly empty)
that defines the key values for a row. The <span class="code">RowIndex</span>
is the list representation (list of integers), which follow
the <span class="code">Cols</span> integer in the OBJECT IDENTIFIER.
</li>
<li>
<span class="code">Cols</span> is a list of integers, greater than or
equal to zero, which represents the column numbers.</li>
</ul>
<h4>Valid Return Values</h4>
<ul>
<li>
<p>A list with as many elements as the <span class="code">Cols</span> list
Each element can be:</p>
<ul>
<li>
<span class="code">{NextOid, NextValue}</span>, where <span class="code">NextOid</span>
is the lexicographic next OBJECT IDENTIFIER for the
corresponding column. This should be specified as the
OBJECT IDENTIFER part following the table entry. This
means that the first integer is the column number and
the rest is a specification of the keys.
<span class="code">NextValue</span> is the value of this element.
</li>
<li>
<span class="code">endOfTable</span> if there are no accessible
elements after this one.
</li>
</ul>
</li>
<li>
<span class="code">{genErr, Column}</span> where <span class="code">Column</span> denotes
the column that caused the error. <span class="code">Column</span> must be
one of the columns in the <span class="code">Cols</span> list. Note that
this should be an internal processing error, e.g. a caused
by a programing fault somewhere. If some column does not
exist, you must return the next accessible element (or
<span class="code">endOfTable</span>).
</li>
</ul>
<h4>f(is_set_ok, RowIndex, Cols [, ExtraArgs])</h4>
<p>The function <span class="code">f(is_set_ok, RowIndex, Cols [, ExtraArgs])</span>
is called in phase one of the set-request
processing so that new values can be checked for
inconsistencies.
</p>
<p>If the function is called, it will be called again with
<span class="code">undo</span>, or with <span class="code">set</span> as first argument.
</p>
<p>This function is optional.
</p>
<h4>Arguments</h4>
<ul>
<li>
<span class="code">RowIndex</span> is a list of integers which define the
key values for the row. The <span class="code">RowIndex</span> is the list
representation (list of integers) which follow the
<span class="code">Cols</span> integer in the OBJECT IDENTIFIER.
</li>
<li>
<span class="code">Cols</span> is a list of <span class="code">{Column, NewValue}</span>,
where <span class="code">Column</span> is an integer, and <span class="code">NewValue</span> is
guaranteed to be of the correct type, length and within
ranges, as specified in the MIB. If the object is an
enumerated integer or of type BITS, the integer value is
used. The list is sorted by <span class="code">Column</span> (increasing) and
each <span class="code">Column</span> is guaranteed to be a valid column
number.</li>
</ul>
<h4>Valid Return Values</h4>
<ul>
<li><span class="code">{noError, 0}</span></li>
<li>
<span class="code">{Error, Column}</span>, where <span class="code">Error</span> is the same
as for <span class="code">is_set_ok</span> for variables, and <span class="code">Column</span>
denotes the faulty column. <span class="code">Column</span> must be one of the
columns in the <span class="code">Cols</span> list.</li>
</ul>
<h4>f(undo, RowIndex, Cols [, ExtraArgs])</h4>
<p>If an error occurs, The function
<span class="code">f(undo, RowIndex, Cols [, ExtraArgs])</span> is called after the
<span class="code">is_set_ok</span> function. If <span class="code">set</span> is called for this
object, <span class="code">undo</span> is not called.
</p>
<p>This function is optional.
</p>
<h4>Arguments</h4>
<ul>
<li>
<span class="code">RowIndex</span> is a list of integers which define the
key values for the row. The <span class="code">RowIndex</span> is the list
representation (list of integers) which follow the
<span class="code">Cols</span> integer in the OBJECT IDENTIFIER.
</li>
<li>
<span class="code">Cols</span> is a list of <span class="code">{Column, NewValue}</span>,
where <span class="code">Column</span> is an integer, and <span class="code">NewValue</span> is
guaranteed to be of the correct type, length and within
ranges, as specified in the MIB. If the object is an
enumerated integer or of type BITS, the integer value is
used. The list is sorted by <span class="code">Column</span> (increasing) and
each <span class="code">Column</span> is guaranteed to be a valid column
number.
</li>
</ul>
<h4>Valid Return Values</h4>
<ul>
<li><span class="code">{noError, 0}</span></li>
<li>
<span class="code">{Error, Column}</span> where <span class="code">Error</span> is the same
as for <span class="code">undo</span> for variables, and <span class="code">Column</span> denotes
the faulty column. <span class="code">Column</span> must be one of the columns
in the <span class="code">Cols</span> list.
</li>
</ul>
<h4>f(set, RowIndex, Cols [, ExtraArgs])</h4>
<p>The function <span class="code">f(set, RowIndex, Cols [, ExtraArgs])</span> is
called to perform the set in phase two of
the set-request processing. It is only called if the
corresponding <span class="code">is_set_ok</span> function did not exist, or
returned <span class="code">{noError, 0}</span>.
</p>
<p>This function is mandatory.
</p>
<h4>Arguments</h4>
<ul>
<li>
<span class="code">RowIndex</span> is a list of integers that define the
key values for the row. The <span class="code">RowIndex</span> is the list
representation (list of integers) which follow the
<span class="code">Cols</span> integer in the OBJECT IDENTIFIER.
</li>
<li>
<span class="code">Cols</span> is a list of <span class="code">{Column, NewValue}</span>,
where <span class="code">Column</span> is an integer, and <span class="code">NewValue</span> is
guaranteed to be of the correct type, length and within
ranges, as specified in the MIB. If the object is an
enumerated integer or of type BITS, the integer value is
used. The list is sorted by <span class="code">Column</span> (increasing) and
each <span class="code">Column</span> is guaranteed to be a valid column
number.
</li>
</ul>
<h4>Valid Return Values</h4>
<ul>
<li><span class="code">{noError, 0}</span></li>
<li>
<span class="code">{Error, Column}</span> where <span class="code">Error</span> is the same
as <span class="code">set</span> for variables, and <span class="code">Column</span> denotes
the faulty column. <span class="code">Column</span> must be one of the columns
in the <span class="code">Cols</span> list.</li>
</ul>
</div>
<div class="footer">
<hr>
<p>Copyright © 1997-2012 Ericsson AB. All Rights Reserved.</p>
</div>
</div>
</div></body>
</html>
distrib
>
Fedora
>
17
>
i386
>
media
>
updates
>
by-pkgid
>
675c8c8167236dfcf8d66da674f931e8
>
files
>
1303
