blob: 69ec8bda1287c19f71c73502c527cda947784b1c [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MyApp 1.0 Reference Manual: MyApp</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<div class="refentry">
<a name="myApp"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="myApp-myapp.top_of_page"></a>MyApp</span></h2>
<p>MyApp — My App - devhelp test.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="myapp-myapp.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="myapp.html#myapp-init" title="myapp_init ()">myapp_init</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="myapp-functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="myapp-init"></a><h3>myapp_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
myapp_init (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
<em class="parameter"><code><span class="type">char</span> **argv[]</code></em>);</pre>
<p>Initializes the MyApp application, setting up internal path lists,
registering built-in elements, and loading standard plugins.</p>
<p>Unless the plugin registry is disabled at compile time, the registry will be
loaded. By default this will also check if the registry cache needs to be
updated and rescan all plugins if needed.
</p>
See "Running MyApp Applications</a><p>for how to disable automatic updates.</p>
<div class="note"><p>
This function will terminate your program if it was unable to initialize
myApp for some reason. If you want your program to fall back,
use <code class="function">myapp_init_check()</code> instead.
</p></div>
<p>WARNING: This function does not work in the same way as corresponding
functions in other libraries, such as <code class="function">otherapp_init()</code></a>. In
particular, unknown command line options cause this function to
abort program execution.</p>
<div class="refsect3">
<a name="id-1.3.3.7.2.10"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>argc</p></td>
<td class="parameter_description"><p> pointer to application's argc. </p></td>
</tr>
<tr>
<td class="parameter_name"><p>argv</p></td>
<td class="parameter_description"><p> pointer to application's argv. </p></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="myapp-init-check"></a><h3>myapp_init_check ()</h3>
<pre class="programlisting"><a href="myapp2.html#mboolean"><span class="returnvalue">mboolean</span></a>
myapp_init_check (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
<em class="parameter"><code><span class="type">char</span> **argv[]</code></em>,
<em class="parameter"><code><a href="myapp2.html#MError"><span class="type">MError</span></a> **err</code></em>);</pre>
<p>Initializes the MyApp application and performs a check.
<p>This function will return <a href="myapp2.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if MyApp could not be initialized
for some reason. If you want your program to fail fatally,
use <a class="link" href="myapp.html#myapp-init" title="myapp_init ()"><code class="function">myapp_init()</code></a> instead.</p>
<div class="refsect3">
<a name="id-1.3.3.7.3.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>argc</p></td>
<td class="parameter_description"><p> pointer to application's argc. </p></td>
</tr>
<tr>
<td class="parameter_name"><p>argv</p></td>
<td class="parameter_description"><p> pointer to application's argv. </p></td>
</tr>
<tr>
<td class="parameter_name"><p>err</p></td>
<td class="parameter_description"><p>pointer to a <a href="myapp2.html#MError"><span class="type">MError</span></a> to which a message will be posted on error</p></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.3.7.3.7"></a><h4>Returns</h4>
<p> <a href="myapp2.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if MyApp could be initialized.</p>
<p></p>
</div>
</div>
<div class="refsect2">
<a name="Flags"></a><h3>enum MyAppEnum</h3>
<p>Flags for myapp.</p>
<div class="refsect3">
<a name="id-1.3.4.9.3.4"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="MY_APP_MACRO:CAPS"></a>MY_APP_MACRO</p></td>
<td class="enum_member_description">
<p>Special flag.</p>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="footer">
<hr>
Modified for libhover devhelp testing</div>
</body>
</html>