Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > bac5fede712203208ef64743259eb319 > files > 33

embryo-devel-1.0.0-2.fc15.i686.rpm

<html>
<head>
    <title>Embryo: Public Variable Access Functions</title>
    <meta http-equiv="content-type" content="text/html;charset=UTF-8">
    <meta name="author" content="Andres Blanc" >
    
    <link rel="icon" href="img/favicon.png" type="image/x-icon">
    <link rel="shortcut icon" href="img/favicon.png" type="image/x-icon">
    <link rel="icon" href="img/favicon.png" type="image/ico">
    <link rel="shortcut icon" href="img/favicon.png" type="image/ico">

    <link rel="stylesheet" type="text/css" media="screen" href="e.css">
    <link rel="stylesheet" type="text/css" media="screen" href="edoxy.css">
</head>

<body>

<div id="container">

<div id="header">
<div class="layout">
    
    <h1><span>Enlightenment</span></h1>
    <h2><span>Beauty at your fingertips</span></h2>

    <div class="menu-container">
        <div class="menu">
            <ul>
	        <li class="current"><a href="http://web.enlightenment.org/p.php?p=docs">Docs</a></li>
                <li><a href="http://trac.enlightenment.org/e">Tracker</a></li>
                <li><a href="http://www.enlightenment.org/p.php?p=contact">Contact</a></li>
                <li><a href="http://www.enlightenment.org/p.php?p=contribute">Contribute</a></li>
                <li><a href="http://www.enlightenment.org/p.php?p=support">Support</a></li>
                <li><a href="http://www.enlightenment.org/p.php?p=download">Download</a></li>
                <li><a href="http://www.enlightenment.org/p.php?p=about">About</a></li>
                <li><a href="http://www.enlightenment.org/p.php?p=news">News</a></li>
                <li><a href="http://www.enlightenment.org/">Home</a></li>
            </ul>
        </div>
    </div>

    <div class="doxytitle">
        Embryo Documentation <small>at Tue Feb 8 2011</small>
    </div>

    <div class="menu-container">
        <div class="submenu">
            <ul class="current">
                <li><a href="todo.html">Todo</a></li>
                <li><a href="files.html">Files</a></li>
                <li><a href="annotated.html">Data Structures</a></li>
                <li><a href="globals.html">Globals</a></li>
                <li><a href="modules.html">Modules</a></li>
                <li><a href="pages.html">Related Pages</a></li>
	        <li class="current"><a href="index.html">Main Page</a></li>
            </ul>
        </div>
    </div>


    <div class="clear"></div>
</div>
</div>

<div id="content">
<div class="layout">
<!-- Generated by Doxygen 1.7.3 -->
</div>
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<h1>Public Variable Access Functions</h1>  </div>
</div>
<div class="contents">

<p>In an Embryo program, a global variable can be declared public, as described in <a class="el" href="Small_Page.html#Small_Scope_Subsection">Scope</a>.  
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI Embryo_Cell&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Embryo__Public__Variable__Group.html#ga9714d1cbd46b3b0315a71c23413ad921">embryo_program_variable_find</a> (Embryo_Program *ep, const char *name)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the location of the public variable in the given program with the given name.  <a href="#ga9714d1cbd46b3b0315a71c23413ad921"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Embryo__Public__Variable__Group.html#ga3515ce41a3a62d86b866f4cadd0c74cd">embryo_program_variable_count_get</a> (Embryo_Program *ep)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the number of public variables in the given program.  <a href="#ga3515ce41a3a62d86b866f4cadd0c74cd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI Embryo_Cell&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Embryo__Public__Variable__Group.html#ga9f9174d8fdde8fdca879f61df78744bb">embryo_program_variable_get</a> (Embryo_Program *ep, int num)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the location of the public variable in the given program with the given identifier.  <a href="#ga9f9174d8fdde8fdca879f61df78744bb"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>In an Embryo program, a global variable can be declared public, as described in <a class="el" href="Small_Page.html#Small_Scope_Subsection">Scope</a>. </p>
<p>The functions here allow the host program to access these public variables. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga3515ce41a3a62d86b866f4cadd0c74cd"></a><!-- doxytag: member="embryo_amx.c::embryo_program_variable_count_get" ref="ga3515ce41a3a62d86b866f4cadd0c74cd" args="(Embryo_Program *ep)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">EAPI int embryo_program_variable_count_get </td>
          <td>(</td>
          <td class="paramtype">Embryo_Program *&#160;</td>
          <td class="paramname"><em>ep</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Retrieves the number of public variables in the given program. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">ep</td><td>The given program. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of public variables. </dd></dl>

</div>
</div>
<a class="anchor" id="ga9714d1cbd46b3b0315a71c23413ad921"></a><!-- doxytag: member="embryo_amx.c::embryo_program_variable_find" ref="ga9714d1cbd46b3b0315a71c23413ad921" args="(Embryo_Program *ep, const char *name)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">EAPI Embryo_Cell embryo_program_variable_find </td>
          <td>(</td>
          <td class="paramtype">Embryo_Program *&#160;</td>
          <td class="paramname"><em>ep</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>name</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Retrieves the location of the public variable in the given program with the given name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">ep</td><td>The given program. </td></tr>
    <tr><td class="paramname">name</td><td>The given name. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The address of the variable if found. <code>EMBRYO_CELL_NONE</code> otherwise. </dd></dl>

<p>References <a class="el" href="Embryo_8h.html#a570d5164a5f3d5d05f63e2e60c6ba7ad">EMBRYO_CELL_NONE</a>.</p>

</div>
</div>
<a class="anchor" id="ga9f9174d8fdde8fdca879f61df78744bb"></a><!-- doxytag: member="embryo_amx.c::embryo_program_variable_get" ref="ga9f9174d8fdde8fdca879f61df78744bb" args="(Embryo_Program *ep, int num)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">EAPI Embryo_Cell embryo_program_variable_get </td>
          <td>(</td>
          <td class="paramtype">Embryo_Program *&#160;</td>
          <td class="paramname"><em>ep</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>num</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Retrieves the location of the public variable in the given program with the given identifier. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">ep</td><td>The given program. </td></tr>
    <tr><td class="paramname">num</td><td>The identifier of the public variable. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The virtual machine address of the variable if found. <code>EMBRYO_CELL_NONE</code> otherwise. </dd></dl>

<p>References <a class="el" href="Embryo_8h.html#a570d5164a5f3d5d05f63e2e60c6ba7ad">EMBRYO_CELL_NONE</a>.</p>

</div>
</div>
</div>
 
 <div id="push"></div>
 </div> <!-- #content -->
  </div> <!-- .layout -->
 
 </div> <!-- #container -->
 
 
  <div id="footer">
    <table><tr>
      <td class="poweredby"><img src="doxygen.png"></td>
      <td class="copyright">Copyright &copy;2011 Enlightenment</td>
      <td class="generated">Docs generated Tue Feb 8 2011 18:11:42</td>
    </tr></table>
  </div>


</body>
</html>