mirror of https://github.com/ArduPilot/ardupilot
105 lines
5.4 KiB
HTML
105 lines
5.4 KiB
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"/>
|
|
<title>ArduPilot Libraries: Menu::command Struct Reference</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.7.1 -->
|
|
<div class="navigation" id="top">
|
|
<div class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="main.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="navpath">
|
|
<ul>
|
|
<li><a class="el" href="class_menu.html">Menu</a> </li>
|
|
<li><a class="el" href="struct_menu_1_1command.html">Menu::command</a> </li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-attribs">Public Attributes</a> </div>
|
|
<div class="headertitle">
|
|
<h1>Menu::command Struct Reference</h1> </div>
|
|
</div>
|
|
<div class="contents">
|
|
<!-- doxytag: class="Menu::command" -->
|
|
<p><code>#include <<a class="el" href="menu_8h_source.html">menu.h</a>></code></p>
|
|
|
|
<p><a href="struct_menu_1_1command-members.html">List of all members.</a></p>
|
|
<table class="memberdecls">
|
|
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">const char </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_menu_1_1command.html#a89d8d8dd0d80e71f396fbc3862cec49d">command</a> [MENU_COMMAND_MAX]</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int8_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_menu_1_1command.html#a5177fbbe6d2f048c136c687fda235ef9">func</a> )(uint8_t argc, const struct <a class="el" href="struct_menu_1_1arg.html">arg</a> *argv)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">callback function <a href="#a5177fbbe6d2f048c136c687fda235ef9"></a><br/></td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>menu command description </p>
|
|
|
|
<p>Definition at line <a class="el" href="menu_8h_source.html#l00068">68</a> of file <a class="el" href="menu_8h_source.html">menu.h</a>.</p>
|
|
<hr/><h2>Member Data Documentation</h2>
|
|
<a class="anchor" id="a89d8d8dd0d80e71f396fbc3862cec49d"></a><!-- doxytag: member="Menu::command::command" ref="a89d8d8dd0d80e71f396fbc3862cec49d" args="[MENU_COMMAND_MAX]" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const char <a class="el" href="struct_menu_1_1command.html#a89d8d8dd0d80e71f396fbc3862cec49d">Menu::command::command</a>[MENU_COMMAND_MAX]</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Name of the command, as typed or received. Command names are limited in size to keep this structure compact. </p>
|
|
|
|
<p>Definition at line <a class="el" href="menu_8h_source.html#l00072">72</a> of file <a class="el" href="menu_8h_source.html">menu.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5177fbbe6d2f048c136c687fda235ef9"></a><!-- doxytag: member="Menu::command::func" ref="a5177fbbe6d2f048c136c687fda235ef9" args=")(uint8_t argc, const struct arg *argv)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int8_t(* <a class="el" href="struct_menu_1_1command.html#a5177fbbe6d2f048c136c687fda235ef9">Menu::command::func</a>)(uint8_t argc, const struct <a class="el" href="struct_menu_1_1arg.html">arg</a> *argv)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>callback function </p>
|
|
<p>The function to call when the command is received.</p>
|
|
<p>The argc argument will be at least 1, and no more than MENU_ARGS_MAX. The argv array will be populated with arguments typed/received up to MENU_ARGS_MAX. The command name will always be in argv[0].</p>
|
|
<p>Commands may return -2 to cause the menu itself to exit. The "?", "help" and "exit" commands are always defined, but can be overridden by explicit entries in the command array. </p>
|
|
|
|
<p>Definition at line <a class="el" href="menu_8h_source.html#l00085">85</a> of file <a class="el" href="menu_8h_source.html">menu.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li><a class="el" href="menu_8h_source.html">menu.h</a></li>
|
|
</ul>
|
|
</div>
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated for ArduPilot Libraries by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.png" alt="doxygen"/></a></small></address>
|
|
</body>
|
|
</html>
|