<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!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"/>
<title>ALSA project - the C library reference: Setup Control Interface</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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">
<img id="MSearchSelect" src="search/search.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)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
</div>
<div class="contents">
<h1>Setup Control Interface<br/>
<small>
[<a class="el" href="group___control.html">Control Interface</a>]</small>
</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Build setup control handle. <a href="#ga4bb43af9b662b97c70322fb2d9d8ff9d"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Free setup control handle. <a href="#gad8e6a8c5d08fd8a7ddfcd55144dbd9ce"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Install given values to control elements. <a href="#ga869e7add884017e9b18cebb9b9eb897a"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Remove (restore) previous values from control elements. <a href="#ga11ed2053b547dc1f86bbd4f526e4ba30"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The setup control interface - set or modify control elements from a configuration file. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga4bb43af9b662b97c70322fb2d9d8ff9d"></a><!-- doxytag: member="control.h::snd_sctl_build" ref="ga4bb43af9b662b97c70322fb2d9d8ff9d" args="(snd_sctl_t **ctl, snd_ctl_t *handle, snd_config_t *config, snd_config_t *private_data, int mode)" -->
<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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Build setup control handle. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sctl</em> </td><td>Result - setup control handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>Master control handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>conf</em> </td><td>Setup configuration </td></tr>
<tr><td valign="top"></td><td valign="top"><em>private_data</em> </td><td>Private data for runtime evaluation </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>Build mode - SND_SCTL_xxxx </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>zero if success, otherwise a negative error code </dd></dl>
</div>
</div>
<a class="anchor" id="gad8e6a8c5d08fd8a7ddfcd55144dbd9ce"></a><!-- doxytag: member="control.h::snd_sctl_free" ref="gad8e6a8c5d08fd8a7ddfcd55144dbd9ce" args="(snd_sctl_t *handle)" -->
<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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sctl</em> </td><td>Setup control handle </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>zero if success, otherwise a negative error code </dd></dl>
</div>
</div>
<a class="anchor" id="ga869e7add884017e9b18cebb9b9eb897a"></a><!-- doxytag: member="control.h::snd_sctl_install" ref="ga869e7add884017e9b18cebb9b9eb897a" args="(snd_sctl_t *handle)" -->
<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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>h</em> </td><td>Setup control handle </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>zero if success, otherwise a negative error code </dd></dl>
</div>
</div>
<a class="anchor" id="ga11ed2053b547dc1f86bbd4f526e4ba30"></a><!-- doxytag: member="control.h::snd_sctl_remove" ref="ga11ed2053b547dc1f86bbd4f526e4ba30" args="(snd_sctl_t *handle)" -->
<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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>h</em> </td><td>Setup control handle </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>zero if success, otherwise a negative error code </dd></dl>
</div>
</div>
</div>
<!--- 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>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Apr 27 13:29:07 2010 for ALSA project - the C library reference by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
eebe3e0b47589a6371b9bc07addc51ff
>
files
>
99
