update master docs
[m6w6/ext-raphf] / master / php__raphf_8h.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.10"/>
7 <title>Resource and persistent handle factory API: php_raphf.h File Reference</title>
8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
9 <script type="text/javascript" src="jquery.js"></script>
10 <script type="text/javascript" src="dynsections.js"></script>
11 <link href="navtree.css" rel="stylesheet" type="text/css"/>
12 <script type="text/javascript" src="resize.js"></script>
13 <script type="text/javascript" src="navtreedata.js"></script>
14 <script type="text/javascript" src="navtree.js"></script>
15 <script type="text/javascript">
16 $(document).ready(initResizable);
17 $(window).load(resizeHeight);
18 </script>
19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
20 <script type="text/javascript" src="search/searchdata.js"></script>
21 <script type="text/javascript" src="search/search.js"></script>
22 <script type="text/javascript">
23 $(document).ready(function() { init_search(); });
24 </script>
25 <link href="doxygen.css" rel="stylesheet" type="text/css" />
26 </head>
27 <body>
28 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
29 <div id="titlearea">
30 <table cellspacing="0" cellpadding="0">
31 <tbody>
32 <tr style="height: 56px;">
33 <td id="projectlogo"><img alt="Logo" src="raphf.png"/></td>
34 <td id="projectalign" style="padding-left: 0.5em;">
35 <div id="projectname">Resource and persistent handle factory API
36 </div>
37 <div id="projectbrief">A facility to manage possibly persistent resources with a comprehensible API. Provides simliar functionality like the zend_list API, but with more flexiblity and freedom.</div>
38 </td>
39 </tr>
40 </tbody>
41 </table>
42 </div>
43 <!-- end header part -->
44 <!-- Generated by Doxygen 1.8.10 -->
45 <script type="text/javascript">
46 var searchBox = new SearchBox("searchBox", "search",false,'Search');
47 </script>
48 <div id="navrow1" class="tabs">
49 <ul class="tablist">
50 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
51 <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
52 <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
53 <li class="current"><a href="files.html"><span>Files</span></a></li>
54 <li>
55 <div id="MSearchBox" class="MSearchBoxInactive">
56 <span class="left">
57 <img id="MSearchSelect" src="search/mag_sel.png"
58 onmouseover="return searchBox.OnSearchSelectShow()"
59 onmouseout="return searchBox.OnSearchSelectHide()"
60 alt=""/>
61 <input type="text" id="MSearchField" value="Search" accesskey="S"
62 onfocus="searchBox.OnSearchFieldFocus(true)"
63 onblur="searchBox.OnSearchFieldFocus(false)"
64 onkeyup="searchBox.OnSearchFieldChange(event)"/>
65 </span><span class="right">
66 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
67 </span>
68 </div>
69 </li>
70 </ul>
71 </div>
72 <div id="navrow2" class="tabs2">
73 <ul class="tablist">
74 <li><a href="files.html"><span>File&#160;List</span></a></li>
75 <li><a href="globals.html"><span>Globals</span></a></li>
76 </ul>
77 </div>
78 </div><!-- top -->
79 <div id="side-nav" class="ui-resizable side-nav-resizable">
80 <div id="nav-tree">
81 <div id="nav-tree-contents">
82 <div id="nav-sync" class="sync"></div>
83 </div>
84 </div>
85 <div id="splitbar" style="-moz-user-select:none;"
86 class="ui-resizable-handle">
87 </div>
88 </div>
89 <script type="text/javascript">
90 $(document).ready(function(){initNavTree('php__raphf_8h.html','');});
91 </script>
92 <div id="doc-content">
93 <!-- window showing the filter options -->
94 <div id="MSearchSelectWindow"
95 onmouseover="return searchBox.OnSearchSelectShow()"
96 onmouseout="return searchBox.OnSearchSelectHide()"
97 onkeydown="return searchBox.OnSearchSelectKey(event)">
98 </div>
99
100 <!-- iframe showing the search results (closed by default) -->
101 <div id="MSearchResultsWindow">
102 <iframe src="javascript:void(0)" frameborder="0"
103 name="MSearchResults" id="MSearchResults">
104 </iframe>
105 </div>
106
107 <div class="header">
108 <div class="summary">
109 <a href="#define-members">Macros</a> &#124;
110 <a href="#var-members">Variables</a> </div>
111 <div class="headertitle">
112 <div class="title">php_raphf.h File Reference</div> </div>
113 </div><!--header-->
114 <div class="contents">
115 <div class="textblock"><code>#include &quot;<a class="el" href="php__raphf__api_8h_source.html">php_raphf_api.h</a>&quot;</code><br />
116 </div><div class="textblock"><div class="dynheader">
117 Include dependency graph for php_raphf.h:</div>
118 <div class="dyncontent">
119 <div class="center"><img src="php__raphf_8h__incl.png" border="0" usemap="#php__raphf_8h" alt=""/></div>
120 <map name="php__raphf_8h" id="php__raphf_8h">
121 <area shape="rect" id="node2" href="php__raphf__api_8h.html" title="php_raphf_api.h" alt="" coords="5,80,120,107"/>
122 </map>
123 </div>
124 </div><div class="textblock"><div class="dynheader">
125 This graph shows which files directly or indirectly include this file:</div>
126 <div class="dyncontent">
127 <div class="center"><img src="php__raphf_8h__dep__incl.png" border="0" usemap="#php__raphf_8hdep" alt=""/></div>
128 <map name="php__raphf_8hdep" id="php__raphf_8hdep">
129 <area shape="rect" id="node2" href="php__raphf__api_8c.html" title="src/php_raphf_api.c" alt="" coords="5,80,141,107"/>
130 <area shape="rect" id="node3" href="php__raphf__api_8h.html" title="src/php_raphf_api.h" alt="" coords="165,80,301,107"/>
131 </map>
132 </div>
133 </div>
134 <p><a href="php__raphf_8h_source.html">Go to the source code of this file.</a></p>
135 <table class="memberdecls">
136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
137 Macros</h2></td></tr>
138 <tr class="memitem:a41a94f99848b07699e3fde33180208c1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf_8h.html#a41a94f99848b07699e3fde33180208c1">phpext_raphf_ptr</a>&#160;&#160;&#160;&amp;<a class="el" href="php__raphf__api_8c.html#a42f904573a2c5b1eba6ccd6604269f99">raphf_module_entry</a></td></tr>
139 <tr class="separator:a41a94f99848b07699e3fde33180208c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
140 <tr class="memitem:ad71962d03ef6d7009f69765ad54f8857"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf_8h.html#ad71962d03ef6d7009f69765ad54f8857">PHP_RAPHF_VERSION</a>&#160;&#160;&#160;&quot;2.0.0dev&quot;</td></tr>
141 <tr class="separator:ad71962d03ef6d7009f69765ad54f8857"><td class="memSeparator" colspan="2">&#160;</td></tr>
142 <tr class="memitem:a379b9663dc302070f84fafdc4c48d7eb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf_8h.html#a379b9663dc302070f84fafdc4c48d7eb">PHP_RAPHF_API</a>&#160;&#160;&#160;extern</td></tr>
143 <tr class="separator:a379b9663dc302070f84fafdc4c48d7eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 </table><table class="memberdecls">
145 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
146 Variables</h2></td></tr>
147 <tr class="memitem:a42f904573a2c5b1eba6ccd6604269f99"><td class="memItemLeft" align="right" valign="top">zend_module_entry&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf_8h.html#a42f904573a2c5b1eba6ccd6604269f99">raphf_module_entry</a></td></tr>
148 <tr class="separator:a42f904573a2c5b1eba6ccd6604269f99"><td class="memSeparator" colspan="2">&#160;</td></tr>
149 </table>
150 <h2 class="groupheader">Macro Definition Documentation</h2>
151 <a class="anchor" id="a379b9663dc302070f84fafdc4c48d7eb"></a>
152 <div class="memitem">
153 <div class="memproto">
154 <table class="memname">
155 <tr>
156 <td class="memname">#define PHP_RAPHF_API&#160;&#160;&#160;extern</td>
157 </tr>
158 </table>
159 </div><div class="memdoc">
160
161 </div>
162 </div>
163 <a class="anchor" id="ad71962d03ef6d7009f69765ad54f8857"></a>
164 <div class="memitem">
165 <div class="memproto">
166 <table class="memname">
167 <tr>
168 <td class="memname">#define PHP_RAPHF_VERSION&#160;&#160;&#160;&quot;2.0.0dev&quot;</td>
169 </tr>
170 </table>
171 </div><div class="memdoc">
172
173 <p>Referenced by <a class="el" href="php__raphf__api_8c.html#afe0b826f07940e0297395eb758b6dc63">PHP_MINFO_FUNCTION()</a>.</p>
174
175 </div>
176 </div>
177 <a class="anchor" id="a41a94f99848b07699e3fde33180208c1"></a>
178 <div class="memitem">
179 <div class="memproto">
180 <table class="memname">
181 <tr>
182 <td class="memname">#define phpext_raphf_ptr&#160;&#160;&#160;&amp;<a class="el" href="php__raphf__api_8c.html#a42f904573a2c5b1eba6ccd6604269f99">raphf_module_entry</a></td>
183 </tr>
184 </table>
185 </div><div class="memdoc">
186
187 </div>
188 </div>
189 <h2 class="groupheader">Variable Documentation</h2>
190 <a class="anchor" id="a42f904573a2c5b1eba6ccd6604269f99"></a>
191 <div class="memitem">
192 <div class="memproto">
193 <table class="memname">
194 <tr>
195 <td class="memname">zend_module_entry raphf_module_entry</td>
196 </tr>
197 </table>
198 </div><div class="memdoc">
199
200 </div>
201 </div>
202 </div><!-- contents -->
203 </div><!-- doc-content -->
204 <!-- start footer part -->
205 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
206 <ul>
207 <li class="navelem"><a class="el" href="php__raphf_8h.html">php_raphf.h</a></li>
208 <li class="footer">Generated by
209 <a href="http://www.doxygen.org/index.html">
210 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.10 </li>
211 </ul>
212 </div>
213 </body>
214 </html>