EVOLUTION-MANAGER
Edit File: group___s_control.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.5"/> <title>ALSA project - the C library reference: Setup Control Interface</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> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </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 style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">ALSA project - the C library reference </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="examples.html"><span>Examples</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> </div><!-- top --> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div class="header"> <div class="summary"> <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">Setup Control Interface<div class="ingroups"><a class="el" href="group___control.html">Control Interface</a></div></div> </div> </div><!--header--> <div class="contents"> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:ga4bb43af9b662b97c70322fb2d9d8ff9d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_control.html#ga4bb43af9b662b97c70322fb2d9d8ff9d">snd_sctl_build</a> (<a class="el" href="group___control.html#ga89e065287b9deb65125cc5f1cfb48e07">snd_sctl_t</a> **ctl, <a class="el" href="group___control.html#ga06628f38def84a0fe3da74041db9d51f">snd_ctl_t</a> *handle, <a class="el" href="group___config.html#ga1c20905af775ae77d04d1a5696f67985">snd_config_t</a> *config, <a class="el" href="group___config.html#ga1c20905af775ae77d04d1a5696f67985">snd_config_t</a> *private_data, int mode)</td></tr> <tr class="memdesc:ga4bb43af9b662b97c70322fb2d9d8ff9d"><td class="mdescLeft"> </td><td class="mdescRight">Build setup control handle. <a href="#ga4bb43af9b662b97c70322fb2d9d8ff9d">More...</a><br/></td></tr> <tr class="separator:ga4bb43af9b662b97c70322fb2d9d8ff9d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gad8e6a8c5d08fd8a7ddfcd55144dbd9ce"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_control.html#gad8e6a8c5d08fd8a7ddfcd55144dbd9ce">snd_sctl_free</a> (<a class="el" href="group___control.html#ga89e065287b9deb65125cc5f1cfb48e07">snd_sctl_t</a> *handle)</td></tr> <tr class="memdesc:gad8e6a8c5d08fd8a7ddfcd55144dbd9ce"><td class="mdescLeft"> </td><td class="mdescRight">Free setup control handle. <a href="#gad8e6a8c5d08fd8a7ddfcd55144dbd9ce">More...</a><br/></td></tr> <tr class="separator:gad8e6a8c5d08fd8a7ddfcd55144dbd9ce"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga869e7add884017e9b18cebb9b9eb897a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_control.html#ga869e7add884017e9b18cebb9b9eb897a">snd_sctl_install</a> (<a class="el" href="group___control.html#ga89e065287b9deb65125cc5f1cfb48e07">snd_sctl_t</a> *handle)</td></tr> <tr class="memdesc:ga869e7add884017e9b18cebb9b9eb897a"><td class="mdescLeft"> </td><td class="mdescRight">Install given values to control elements. <a href="#ga869e7add884017e9b18cebb9b9eb897a">More...</a><br/></td></tr> <tr class="separator:ga869e7add884017e9b18cebb9b9eb897a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga11ed2053b547dc1f86bbd4f526e4ba30"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_control.html#ga11ed2053b547dc1f86bbd4f526e4ba30">snd_sctl_remove</a> (<a class="el" href="group___control.html#ga89e065287b9deb65125cc5f1cfb48e07">snd_sctl_t</a> *handle)</td></tr> <tr class="memdesc:ga11ed2053b547dc1f86bbd4f526e4ba30"><td class="mdescLeft"> </td><td class="mdescRight">Remove (restore) previous values from control elements. <a href="#ga11ed2053b547dc1f86bbd4f526e4ba30">More...</a><br/></td></tr> <tr class="separator:ga11ed2053b547dc1f86bbd4f526e4ba30"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <p>The setup control interface - set or modify control elements from a configuration file. </p> <h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="ga4bb43af9b662b97c70322fb2d9d8ff9d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int snd_sctl_build </td> <td>(</td> <td class="paramtype"><a class="el" href="group___control.html#ga89e065287b9deb65125cc5f1cfb48e07">snd_sctl_t</a> ** </td> <td class="paramname"><em>sctl</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group___control.html#ga06628f38def84a0fe3da74041db9d51f">snd_ctl_t</a> * </td> <td class="paramname"><em>handle</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group___config.html#ga1c20905af775ae77d04d1a5696f67985">snd_config_t</a> * </td> <td class="paramname"><em>conf</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group___config.html#ga1c20905af775ae77d04d1a5696f67985">snd_config_t</a> * </td> <td class="paramname"><em>private_data</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>mode</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Build setup control handle. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">sctl</td><td>Result - setup control handle </td></tr> <tr><td class="paramname">handle</td><td>Master control handle </td></tr> <tr><td class="paramname">conf</td><td>Setup configuration </td></tr> <tr><td class="paramname">private_data</td><td>Private data for runtime evaluation </td></tr> <tr><td class="paramname">mode</td><td>Build mode - SND_SCTL_xxxx </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>zero if success, otherwise a negative error code </dd></dl> </div> </div> <a class="anchor" id="gad8e6a8c5d08fd8a7ddfcd55144dbd9ce"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int snd_sctl_free </td> <td>(</td> <td class="paramtype"><a class="el" href="group___control.html#ga89e065287b9deb65125cc5f1cfb48e07">snd_sctl_t</a> * </td> <td class="paramname"><em>sctl</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Free setup control handle. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">sctl</td><td>Setup control handle </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>zero if success, otherwise a negative error code </dd></dl> </div> </div> <a class="anchor" id="ga869e7add884017e9b18cebb9b9eb897a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int snd_sctl_install </td> <td>(</td> <td class="paramtype"><a class="el" href="group___control.html#ga89e065287b9deb65125cc5f1cfb48e07">snd_sctl_t</a> * </td> <td class="paramname"><em>h</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Install given values to control elements. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">h</td><td>Setup control handle </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>zero if success, otherwise a negative error code </dd></dl> </div> </div> <a class="anchor" id="ga11ed2053b547dc1f86bbd4f526e4ba30"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int snd_sctl_remove </td> <td>(</td> <td class="paramtype"><a class="el" href="group___control.html#ga89e065287b9deb65125cc5f1cfb48e07">snd_sctl_t</a> * </td> <td class="paramname"><em>h</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Remove (restore) previous values from control elements. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">h</td><td>Setup control handle </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>zero if success, otherwise a negative error code </dd></dl> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.5 </small></address> </body> </html>