12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
- <html>
- <head>
- <title>Reference</title>
- <link rel="stylesheet" href="../luadoc.css" type="text/css" />
- <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
- </head>
- <body>
- <div id="container">
- <div id="product">
- <div id="product_logo"></div>
- <div id="product_name"><big><b></b></big></div>
- <div id="product_description"></div>
- </div> <!-- id="product" -->
- <div id="main">
- <div id="navigation">
- <h1>LuaDoc</h1>
- <ul>
-
- <li><a href="../index.html">Index</a></li>
-
- </ul>
- <!-- Module list -->
- <h1>Modules</h1>
- <ul>
- <li>
- <a href="../modules/luci.dispatcher.html">luci.dispatcher</a>
- </li>
- <li>
- <a href="../modules/luci.http.html">luci.http</a>
- </li>
- <li>
- <a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
- </li>
- <li>
- <a href="../modules/luci.http.date.html">luci.http.date</a>
- </li>
- <li>
- <a href="../modules/luci.http.mime.html">luci.http.mime</a>
- </li>
- <li>
- <a href="../modules/luci.i18n.html">luci.i18n</a>
- </li>
- <li>
- <a href="../modules/luci.ip.html">luci.ip</a>
- </li>
- <li>
- <a href="../modules/luci.ip.cidr.html">luci.ip.cidr</a>
- </li>
- <li>
- <a href="../modules/luci.json.html">luci.json</a>
- </li>
- <li>
- <a href="../modules/luci.jsonc.html">luci.jsonc</a>
- </li>
- <li>
- <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
- </li>
- <li>
- <a href="../modules/luci.model.ipkg.html">luci.model.ipkg</a>
- </li>
- <li><strong>luci.model.uci</strong></li>
-
- <li>
- <a href="../modules/luci.rpcc.html">luci.rpcc</a>
- </li>
- <li>
- <a href="../modules/luci.rpcc.ruci.html">luci.rpcc.ruci</a>
- </li>
- <li>
- <a href="../modules/luci.sys.html">luci.sys</a>
- </li>
- <li>
- <a href="../modules/luci.sys.init.html">luci.sys.init</a>
- </li>
- <li>
- <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
- </li>
- <li>
- <a href="../modules/luci.sys.net.html">luci.sys.net</a>
- </li>
- <li>
- <a href="../modules/luci.sys.process.html">luci.sys.process</a>
- </li>
- <li>
- <a href="../modules/luci.sys.user.html">luci.sys.user</a>
- </li>
- <li>
- <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
- </li>
- <li>
- <a href="../modules/luci.util.html">luci.util</a>
- </li>
- <li>
- <a href="../modules/nixio.html">nixio</a>
- </li>
- <li>
- <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
- </li>
- <li>
- <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
- </li>
- <li>
- <a href="../modules/nixio.File.html">nixio.File</a>
- </li>
- <li>
- <a href="../modules/nixio.README.html">nixio.README</a>
- </li>
- <li>
- <a href="../modules/nixio.Socket.html">nixio.Socket</a>
- </li>
- <li>
- <a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
- </li>
- <li>
- <a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
- </li>
- <li>
- <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
- </li>
- <li>
- <a href="../modules/nixio.bin.html">nixio.bin</a>
- </li>
- <li>
- <a href="../modules/nixio.bit.html">nixio.bit</a>
- </li>
- <li>
- <a href="../modules/nixio.crypto.html">nixio.crypto</a>
- </li>
- <li>
- <a href="../modules/nixio.fs.html">nixio.fs</a>
- </li>
- </ul>
- <!-- File list -->
- </div><!-- id="navigation" -->
- <div id="content">
- <h1>Object Instance <code>luci.model.uci</code></h1>
- <p></p>
- <h2>Functions</h2>
- <table class="function_list">
- <tr>
- <td class="name" nowrap><a href="#Cursor.add">Cursor:add</a> (config, type)</td>
- <td class="summary">
-
- Add an anonymous section.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#Cursor.apply">Cursor:apply</a> (configlist, command)</td>
- <td class="summary">
-
- Applies UCI configuration changes
- </td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#Cursor.changes">Cursor:changes</a> (config)</td>
- <td class="summary">
-
- Get a table of saved but uncommitted changes.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#Cursor.commit">Cursor:commit</a> (config)</td>
- <td class="summary">
-
- Commit saved changes.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#Cursor.delete">Cursor:delete</a> (config, section, option)</td>
- <td class="summary">
-
- Deletes a section or an option.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#Cursor.delete_all">Cursor:delete_all</a> (config, type, comparator)</td>
- <td class="summary">
-
- Delete all sections of a given type that match certain criteria.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#Cursor.foreach">Cursor:foreach</a> (config, type, callback)</td>
- <td class="summary">
-
- Call a function for every section of a certain type.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#Cursor.get">Cursor:get</a> (config, section, option)</td>
- <td class="summary">
-
- Get a section type or an option
- </td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#Cursor.get_all">Cursor:get_all</a> (config, section)</td>
- <td class="summary">
-
- Get all sections of a config or all values of a section.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#Cursor.get_bool">Cursor:get_bool</a> (config, section, option)</td>
- <td class="summary">
-
- Get a boolean option and return it's value as true or false.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#Cursor.get_confdir">Cursor:get_confdir</a> ()</td>
- <td class="summary">
-
- Get the configuration directory.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#Cursor.get_first">Cursor:get_first</a> (config, type, option, default)</td>
- <td class="summary">
-
- Get the given option from the first section with the given type.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#Cursor.get_list">Cursor:get_list</a> (config, section, option)</td>
- <td class="summary">
-
- Get an option or list and return values as table.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#Cursor.get_savedir">Cursor:get_savedir</a> ()</td>
- <td class="summary">
-
- Get the directory for uncomitted changes.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#Cursor.get_session_id">Cursor:get_session_id</a> ()</td>
- <td class="summary">
-
- Get the effective session ID.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#Cursor.load">Cursor:load</a> (config)</td>
- <td class="summary">
-
- Manually load a config.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#Cursor.revert">Cursor:revert</a> (config)</td>
- <td class="summary">
-
- Revert saved but uncommitted changes.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#Cursor.save">Cursor:save</a> (config)</td>
- <td class="summary">
-
- Saves changes made to a config to make them committable.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#Cursor.section">Cursor:section</a> (config, type, name, values)</td>
- <td class="summary">
-
- Create a new section and initialize it with data.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#Cursor.set">Cursor:set</a> (config, section, option, value)</td>
- <td class="summary">
-
- Set a value or create a named section.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#Cursor.set_confdir">Cursor:set_confdir</a> (directory)</td>
- <td class="summary">
-
- Set the configuration directory.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#Cursor.set_list">Cursor:set_list</a> (config, section, option, value)</td>
- <td class="summary">
-
- Set given values as list.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#Cursor.set_savedir">Cursor:set_savedir</a> (directory)</td>
- <td class="summary">
-
- Set the directory for uncommited changes.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#Cursor.set_session_id">Cursor:set_session_id</a> (id)</td>
- <td class="summary">
-
- Set the effective session ID.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#Cursor.substate">Cursor:substate</a> ()</td>
- <td class="summary">
-
- Create a sub-state of this cursor.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#Cursor.tset">Cursor:tset</a> (config, section, values)</td>
- <td class="summary">
-
- Updated the data of a section using data from a table.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#Cursor.unload">Cursor:unload</a> (config)</td>
- <td class="summary">
-
- Discard changes made to a config.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#cursor">cursor</a> ()</td>
- <td class="summary">
-
- Create a new UCI-Cursor.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#cursor_state">cursor_state</a> ()</td>
- <td class="summary">
-
- Create a new Cursor initialized to the state directory.</td>
- </tr>
- </table>
- <br/>
- <br/>
- <h2><a name="functions"></a>Functions</h2>
- <dl class="function">
- <dt><a name="Cursor.add"></a><strong>Cursor:add</strong> (config, type)</dt>
- <dd>
-
- Add an anonymous section.
- <h3>Parameters</h3>
- <ul>
-
- <li>
- config: UCI config
- </li>
-
- <li>
- type: UCI section type
- </li>
-
- </ul>
- <h3>Return value:</h3>
- Name of created section
- </dd>
- <dt><a name="Cursor.apply"></a><strong>Cursor:apply</strong> (configlist, command)</dt>
- <dd>
-
- Applies UCI configuration changes
- <h3>Parameters</h3>
- <ul>
-
- <li>
- configlist: List of UCI configurations
- </li>
-
- <li>
- command: Don't apply only return the command
- </li>
-
- </ul>
- </dd>
- <dt><a name="Cursor.changes"></a><strong>Cursor:changes</strong> (config)</dt>
- <dd>
-
- Get a table of saved but uncommitted changes.
- <h3>Parameters</h3>
- <ul>
-
- <li>
- config: UCI config
- </li>
-
- </ul>
- <h3>Return value:</h3>
- Table of changes
- <h3>See also:</h3>
- <ul>
-
- <li><a href="#Cursor.save">
- Cursor:save
- </a>
-
- </ul>
- </dd>
- <dt><a name="Cursor.commit"></a><strong>Cursor:commit</strong> (config)</dt>
- <dd>
-
- Commit saved changes.
- <h3>Parameters</h3>
- <ul>
-
- <li>
- config: UCI config
- </li>
-
- </ul>
- <h3>Return value:</h3>
- Boolean whether operation succeeded
- <h3>See also:</h3>
- <ul>
-
- <li><a href="#Cursor.revert">
- Cursor:revert
- </a>
-
- <li><a href="#Cursor.save">
- Cursor:save
- </a>
-
- </ul>
- </dd>
- <dt><a name="Cursor.delete"></a><strong>Cursor:delete</strong> (config, section, option)</dt>
- <dd>
-
- Deletes a section or an option.
- <h3>Parameters</h3>
- <ul>
-
- <li>
- config: UCI config
- </li>
-
- <li>
- section: UCI section name
- </li>
-
- <li>
- option: UCI option (optional)
- </li>
-
- </ul>
- <h3>Return value:</h3>
- Boolean whether operation succeeded
- </dd>
- <dt><a name="Cursor.delete_all"></a><strong>Cursor:delete_all</strong> (config, type, comparator)</dt>
- <dd>
-
- Delete all sections of a given type that match certain criteria.
- <h3>Parameters</h3>
- <ul>
-
- <li>
- config: UCI config
- </li>
-
- <li>
- type: UCI section type
- </li>
-
- <li>
- comparator: Function that will be called for each section and returns
- a boolean whether to delete the current section (optional)
- </li>
-
- </ul>
- </dd>
- <dt><a name="Cursor.foreach"></a><strong>Cursor:foreach</strong> (config, type, callback)</dt>
- <dd>
-
- Call a function for every section of a certain type.
- <h3>Parameters</h3>
- <ul>
-
- <li>
- config: UCI config
- </li>
-
- <li>
- type: UCI section type
- </li>
-
- <li>
- callback: Function to be called
- </li>
-
- </ul>
- <h3>Return value:</h3>
- Boolean whether operation succeeded
- </dd>
- <dt><a name="Cursor.get"></a><strong>Cursor:get</strong> (config, section, option)</dt>
- <dd>
-
- Get a section type or an option
- <h3>Parameters</h3>
- <ul>
-
- <li>
- config: UCI config
- </li>
-
- <li>
- section: UCI section name
- </li>
-
- <li>
- option: UCI option (optional)
- </li>
-
- </ul>
- <h3>Return value:</h3>
- UCI value
- </dd>
- <dt><a name="Cursor.get_all"></a><strong>Cursor:get_all</strong> (config, section)</dt>
- <dd>
-
- Get all sections of a config or all values of a section.
- <h3>Parameters</h3>
- <ul>
-
- <li>
- config: UCI config
- </li>
-
- <li>
- section: UCI section name (optional)
- </li>
-
- </ul>
- <h3>Return value:</h3>
- Table of UCI sections or table of UCI values
- </dd>
- <dt><a name="Cursor.get_bool"></a><strong>Cursor:get_bool</strong> (config, section, option)</dt>
- <dd>
-
- Get a boolean option and return it's value as true or false.
- <h3>Parameters</h3>
- <ul>
-
- <li>
- config: UCI config
- </li>
-
- <li>
- section: UCI section name
- </li>
-
- <li>
- option: UCI option
- </li>
-
- </ul>
- <h3>Return value:</h3>
- Boolean
- </dd>
- <dt><a name="Cursor.get_confdir"></a><strong>Cursor:get_confdir</strong> ()</dt>
- <dd>
-
- Get the configuration directory.
- <h3>Return value:</h3>
- Configuration directory
- </dd>
- <dt><a name="Cursor.get_first"></a><strong>Cursor:get_first</strong> (config, type, option, default)</dt>
- <dd>
-
- Get the given option from the first section with the given type.
- <h3>Parameters</h3>
- <ul>
-
- <li>
- config: UCI config
- </li>
-
- <li>
- type: UCI section type
- </li>
-
- <li>
- option: UCI option (optional)
- </li>
-
- <li>
- default: Default value (optional)
- </li>
-
- </ul>
- <h3>Return value:</h3>
- UCI value
- </dd>
- <dt><a name="Cursor.get_list"></a><strong>Cursor:get_list</strong> (config, section, option)</dt>
- <dd>
-
- Get an option or list and return values as table.
- <h3>Parameters</h3>
- <ul>
-
- <li>
- config: UCI config
- </li>
-
- <li>
- section: UCI section name
- </li>
-
- <li>
- option: UCI option
- </li>
-
- </ul>
- <h3>Return value:</h3>
- table. If the option was not found, you will simply get an empty
- table.
- </dd>
- <dt><a name="Cursor.get_savedir"></a><strong>Cursor:get_savedir</strong> ()</dt>
- <dd>
-
- Get the directory for uncomitted changes.
- <h3>Return value:</h3>
- Save directory
- </dd>
- <dt><a name="Cursor.get_session_id"></a><strong>Cursor:get_session_id</strong> ()</dt>
- <dd>
-
- Get the effective session ID.
- <h3>Return value:</h3>
- String containing the session ID
- </dd>
- <dt><a name="Cursor.load"></a><strong>Cursor:load</strong> (config)</dt>
- <dd>
-
- Manually load a config.
- <h3>Parameters</h3>
- <ul>
-
- <li>
- config: UCI config
- </li>
-
- </ul>
- <h3>Return value:</h3>
- Boolean whether operation succeeded
- <h3>See also:</h3>
- <ul>
-
- <li><a href="#Cursor.save">
- Cursor:save
- </a>
-
- <li><a href="#Cursor.unload">
- Cursor:unload
- </a>
-
- </ul>
- </dd>
- <dt><a name="Cursor.revert"></a><strong>Cursor:revert</strong> (config)</dt>
- <dd>
-
- Revert saved but uncommitted changes.
- <h3>Parameters</h3>
- <ul>
-
- <li>
- config: UCI config
- </li>
-
- </ul>
- <h3>Return value:</h3>
- Boolean whether operation succeeded
- <h3>See also:</h3>
- <ul>
-
- <li><a href="#Cursor.commit">
- Cursor:commit
- </a>
-
- <li><a href="#Cursor.save">
- Cursor:save
- </a>
-
- </ul>
- </dd>
- <dt><a name="Cursor.save"></a><strong>Cursor:save</strong> (config)</dt>
- <dd>
-
- Saves changes made to a config to make them committable.
- <h3>Parameters</h3>
- <ul>
-
- <li>
- config: UCI config
- </li>
-
- </ul>
- <h3>Return value:</h3>
- Boolean whether operation succeeded
- <h3>See also:</h3>
- <ul>
-
- <li><a href="#Cursor.load">
- Cursor:load
- </a>
-
- <li><a href="#Cursor.unload">
- Cursor:unload
- </a>
-
- </ul>
- </dd>
- <dt><a name="Cursor.section"></a><strong>Cursor:section</strong> (config, type, name, values)</dt>
- <dd>
-
- Create a new section and initialize it with data.
- <h3>Parameters</h3>
- <ul>
-
- <li>
- config: UCI config
- </li>
-
- <li>
- type: UCI section type
- </li>
-
- <li>
- name: UCI section name (optional)
- </li>
-
- <li>
- values: Table of key - value pairs to initialize the section with
- </li>
-
- </ul>
- <h3>Return value:</h3>
- Name of created section
- </dd>
- <dt><a name="Cursor.set"></a><strong>Cursor:set</strong> (config, section, option, value)</dt>
- <dd>
-
- Set a value or create a named section.
-
- When invoked with three arguments <code>config</code>, <code>sectionname</code>, <code>sectiontype</code>,
- then a named section of the given type is created.
-
- When invoked with four arguments <code>config</code>, <code>sectionname</code>, <code>optionname</code> and
- <code>optionvalue</code> then the value of the specified option is set to the given value.
- <h3>Parameters</h3>
- <ul>
-
- <li>
- config: UCI config
- </li>
-
- <li>
- section: UCI section name
- </li>
-
- <li>
- option: UCI option or UCI section type
- </li>
-
- <li>
- value: UCI value or nothing if you want to create a section
- </li>
-
- </ul>
- <h3>Return value:</h3>
- Boolean whether operation succeeded
- </dd>
- <dt><a name="Cursor.set_confdir"></a><strong>Cursor:set_confdir</strong> (directory)</dt>
- <dd>
-
- Set the configuration directory.
- <h3>Parameters</h3>
- <ul>
-
- <li>
- directory: UCI configuration directory
- </li>
-
- </ul>
- <h3>Return value:</h3>
- Boolean whether operation succeeded
- </dd>
- <dt><a name="Cursor.set_list"></a><strong>Cursor:set_list</strong> (config, section, option, value)</dt>
- <dd>
-
- Set given values as list. Setting a list option to an empty list
- has the same effect as deleting the option.
- <h3>Parameters</h3>
- <ul>
-
- <li>
- config: UCI config
- </li>
-
- <li>
- section: UCI section name
- </li>
-
- <li>
- option: UCI option
- </li>
-
- <li>
- value: Value or table. Non-table values will be set as single
- item UCI list.
- </li>
-
- </ul>
- <h3>Return value:</h3>
- Boolean whether operation succeeded
- </dd>
- <dt><a name="Cursor.set_savedir"></a><strong>Cursor:set_savedir</strong> (directory)</dt>
- <dd>
-
- Set the directory for uncommited changes.
- <h3>Parameters</h3>
- <ul>
-
- <li>
- directory: UCI changes directory
- </li>
-
- </ul>
- <h3>Return value:</h3>
- Boolean whether operation succeeded
- </dd>
- <dt><a name="Cursor.set_session_id"></a><strong>Cursor:set_session_id</strong> (id)</dt>
- <dd>
-
- Set the effective session ID.
- <h3>Parameters</h3>
- <ul>
-
- <li>
- id: String containing the session ID to set
- </li>
-
- </ul>
- <h3>Return value:</h3>
- Boolean whether operation succeeded
- </dd>
- <dt><a name="Cursor.substate"></a><strong>Cursor:substate</strong> ()</dt>
- <dd>
-
- Create a sub-state of this cursor.
-
- The sub-state is tied to the parent curser, means it the parent unloads or
- loads configs, the sub state will do so as well.
- <h3>Return value:</h3>
- UCI state cursor tied to the parent cursor
- </dd>
- <dt><a name="Cursor.tset"></a><strong>Cursor:tset</strong> (config, section, values)</dt>
- <dd>
-
- Updated the data of a section using data from a table.
- <h3>Parameters</h3>
- <ul>
-
- <li>
- config: UCI config
- </li>
-
- <li>
- section: UCI section name (optional)
- </li>
-
- <li>
- values: Table of key - value pairs to update the section with
- </li>
-
- </ul>
- </dd>
- <dt><a name="Cursor.unload"></a><strong>Cursor:unload</strong> (config)</dt>
- <dd>
-
- Discard changes made to a config.
- <h3>Parameters</h3>
- <ul>
-
- <li>
- config: UCI config
- </li>
-
- </ul>
- <h3>Return value:</h3>
- Boolean whether operation succeeded
- <h3>See also:</h3>
- <ul>
-
- <li><a href="#Cursor.load">
- Cursor:load
- </a>
-
- <li><a href="#Cursor.save">
- Cursor:save
- </a>
-
- </ul>
- </dd>
- <dt><a name="cursor"></a><strong>cursor</strong> ()</dt>
- <dd>
-
- Create a new UCI-Cursor.
- <h3>Return value:</h3>
- UCI-Cursor
- </dd>
- <dt><a name="cursor_state"></a><strong>cursor_state</strong> ()</dt>
- <dd>
-
- Create a new Cursor initialized to the state directory.
- <h3>Return value:</h3>
- UCI cursor
- </dd>
- </dl>
- </div> <!-- id="content" -->
- </div> <!-- id="main" -->
- <div id="about">
- <p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
- </div> <!-- id="about" -->
- </div> <!-- id="container" -->
- </body>
- </html>
|