mirror
/
libx52
mirror of https://github.com/nirenjan/libx52.git
1
0
Fork 0
Code Releases Wiki Activity
libx52/group__libx52str.html

271 lines
14 KiB
HTML
Raw Blame History

<!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">
<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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libx52: Stringification</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/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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libx52
&#160;<span id="projectnumber">0.2.3</span>
</div>
<div id="projectbrief">Saitek X52/X52Pro drivers for Linux/Unix</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- 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">
<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">Stringification</div> </div>
</div><!--header-->
<div class="contents">
<p>Translation APIs from enumerations to string, primarily for logging.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaa29a1022b0c3eb4894ddfd4934c3cf0e"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__libx52str.html#gaa29a1022b0c3eb4894ddfd4934c3cf0e">libx52_strerror</a> (<a class="el" href="group__libx52misc.html#ga93b777d9cea6e733b63c222e6115ccb7">libx52_error_code</a> error)</td></tr>
<tr class="memdesc:gaa29a1022b0c3eb4894ddfd4934c3cf0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a string representation of the error code. <a href="group__libx52str.html#gaa29a1022b0c3eb4894ddfd4934c3cf0e">More...</a><br /></td></tr>
<tr class="separator:gaa29a1022b0c3eb4894ddfd4934c3cf0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaada86ed0259637a06789becb2ca96d7f"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__libx52str.html#gaada86ed0259637a06789becb2ca96d7f">libx52_clock_id_to_str</a> (<a class="el" href="group__libx52clock.html#ga08c48a43f70bebb61b553e0ec12d917c">libx52_clock_id</a> id)</td></tr>
<tr class="memdesc:gaada86ed0259637a06789becb2ca96d7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a string representation of the clock ID. <a href="group__libx52str.html#gaada86ed0259637a06789becb2ca96d7f">More...</a><br /></td></tr>
<tr class="separator:gaada86ed0259637a06789becb2ca96d7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga957125f1bdf2cfe58c7d2a49cc48126f"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__libx52str.html#ga957125f1bdf2cfe58c7d2a49cc48126f">libx52_clock_format_to_str</a> (<a class="el" href="group__libx52clock.html#ga0c9c90bdba150b6e48ddab30aea45268">libx52_clock_format</a> format)</td></tr>
<tr class="memdesc:ga957125f1bdf2cfe58c7d2a49cc48126f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a string representation of the clock format. <a href="group__libx52str.html#ga957125f1bdf2cfe58c7d2a49cc48126f">More...</a><br /></td></tr>
<tr class="separator:ga957125f1bdf2cfe58c7d2a49cc48126f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacaa76286205036b0a8ce43ad9245552f"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__libx52str.html#gacaa76286205036b0a8ce43ad9245552f">libx52_date_format_to_str</a> (<a class="el" href="group__libx52clock.html#ga0da0bde31d817eaa42465b0dea2ccf5a">libx52_date_format</a> format)</td></tr>
<tr class="memdesc:gacaa76286205036b0a8ce43ad9245552f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a string representation of the date format. <a href="group__libx52str.html#gacaa76286205036b0a8ce43ad9245552f">More...</a><br /></td></tr>
<tr class="separator:gacaa76286205036b0a8ce43ad9245552f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga60e5bb35a40a1486a4dd4862c8b177ce"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__libx52str.html#ga60e5bb35a40a1486a4dd4862c8b177ce">libx52_led_id_to_str</a> (<a class="el" href="group__libx52mfdled.html#gae97e6cb1be0d79960018f2a12ba7047f">libx52_led_id</a> id)</td></tr>
<tr class="memdesc:ga60e5bb35a40a1486a4dd4862c8b177ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a string representation of the LED. <a href="group__libx52str.html#ga60e5bb35a40a1486a4dd4862c8b177ce">More...</a><br /></td></tr>
<tr class="separator:ga60e5bb35a40a1486a4dd4862c8b177ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga76afc14d71ef512ca0c0795f8f26cc71"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__libx52str.html#ga76afc14d71ef512ca0c0795f8f26cc71">libx52_led_state_to_str</a> (<a class="el" href="group__libx52mfdled.html#gab1a633a40dcdcfc5cf6fc13a3ed8b68c">libx52_led_state</a> state)</td></tr>
<tr class="memdesc:ga76afc14d71ef512ca0c0795f8f26cc71"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a string representation of the LED state. <a href="group__libx52str.html#ga76afc14d71ef512ca0c0795f8f26cc71">More...</a><br /></td></tr>
<tr class="separator:ga76afc14d71ef512ca0c0795f8f26cc71"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Translation APIs from enumerations to string, primarily for logging. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga957125f1bdf2cfe58c7d2a49cc48126f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga957125f1bdf2cfe58c7d2a49cc48126f">&#9670;&nbsp;</a></span>libx52_clock_format_to_str()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* libx52_clock_format_to_str </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__libx52clock.html#ga0c9c90bdba150b6e48ddab30aea45268">libx52_clock_format</a>&#160;</td>
<td class="paramname"><em>format</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a string representation of the clock format. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>Clock format</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to a NULL terminated string describing the clock format. Returned pointer must not be freed. </dd></dl>
</div>
</div>
<a id="gaada86ed0259637a06789becb2ca96d7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaada86ed0259637a06789becb2ca96d7f">&#9670;&nbsp;</a></span>libx52_clock_id_to_str()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* libx52_clock_id_to_str </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__libx52clock.html#ga08c48a43f70bebb61b553e0ec12d917c">libx52_clock_id</a>&#160;</td>
<td class="paramname"><em>id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a string representation of the clock ID. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">id</td><td>Clock ID</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to a NULL terminated string describing the clock ID. Returned pointer must not be freed. </dd></dl>
</div>
</div>
<a id="gacaa76286205036b0a8ce43ad9245552f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacaa76286205036b0a8ce43ad9245552f">&#9670;&nbsp;</a></span>libx52_date_format_to_str()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* libx52_date_format_to_str </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__libx52clock.html#ga0da0bde31d817eaa42465b0dea2ccf5a">libx52_date_format</a>&#160;</td>
<td class="paramname"><em>format</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a string representation of the date format. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>Date format</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to a NULL terminated string describing the date format. Returned pointer must not be freed. </dd></dl>
</div>
</div>
<a id="ga60e5bb35a40a1486a4dd4862c8b177ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga60e5bb35a40a1486a4dd4862c8b177ce">&#9670;&nbsp;</a></span>libx52_led_id_to_str()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* libx52_led_id_to_str </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__libx52mfdled.html#gae97e6cb1be0d79960018f2a12ba7047f">libx52_led_id</a>&#160;</td>
<td class="paramname"><em>id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a string representation of the LED. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">id</td><td>LED ID</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to a NULL terminated string describing the LED. Returned pointer must not be freed. </dd></dl>
</div>
</div>
<a id="ga76afc14d71ef512ca0c0795f8f26cc71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga76afc14d71ef512ca0c0795f8f26cc71">&#9670;&nbsp;</a></span>libx52_led_state_to_str()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* libx52_led_state_to_str </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__libx52mfdled.html#gab1a633a40dcdcfc5cf6fc13a3ed8b68c">libx52_led_state</a>&#160;</td>
<td class="paramname"><em>state</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a string representation of the LED state. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>LED state</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to a NULL terminated string describing the LED state. Returned pointer must not be freed. </dd></dl>
</div>
</div>
<a id="gaa29a1022b0c3eb4894ddfd4934c3cf0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa29a1022b0c3eb4894ddfd4934c3cf0e">&#9670;&nbsp;</a></span>libx52_strerror()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* libx52_strerror </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__libx52misc.html#ga93b777d9cea6e733b63c222e6115ccb7">libx52_error_code</a>&#160;</td>
<td class="paramname"><em>error</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a string representation of the error code. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">error</td><td>Error code returned by libx52 function</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to a NULL terminated string describing the error. Returned pointer must not be freed. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
View Git Blame Copy Permalink