update master docs
[m6w6/ext-propro] / master / php__propro_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>Property proxy API: php_propro.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="projectalign" style="padding-left: 0.5em;">
34 <div id="projectname">Property proxy API
35 </div>
36 <div id="projectbrief">A facility to manage extension object properties tied to C-struct members</div>
37 </td>
38 </tr>
39 </tbody>
40 </table>
41 </div>
42 <!-- end header part -->
43 <!-- Generated by Doxygen 1.8.10 -->
44 <script type="text/javascript">
45 var searchBox = new SearchBox("searchBox", "search",false,'Search');
46 </script>
47 <div id="navrow1" class="tabs">
48 <ul class="tablist">
49 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
50 <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
51 <li class="current"><a href="files.html"><span>Files</span></a></li>
52 <li>
53 <div id="MSearchBox" class="MSearchBoxInactive">
54 <span class="left">
55 <img id="MSearchSelect" src="search/mag_sel.png"
56 onmouseover="return searchBox.OnSearchSelectShow()"
57 onmouseout="return searchBox.OnSearchSelectHide()"
58 alt=""/>
59 <input type="text" id="MSearchField" value="Search" accesskey="S"
60 onfocus="searchBox.OnSearchFieldFocus(true)"
61 onblur="searchBox.OnSearchFieldFocus(false)"
62 onkeyup="searchBox.OnSearchFieldChange(event)"/>
63 </span><span class="right">
64 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
65 </span>
66 </div>
67 </li>
68 </ul>
69 </div>
70 <div id="navrow2" class="tabs2">
71 <ul class="tablist">
72 <li><a href="files.html"><span>File&#160;List</span></a></li>
73 <li><a href="globals.html"><span>Globals</span></a></li>
74 </ul>
75 </div>
76 </div><!-- top -->
77 <div id="side-nav" class="ui-resizable side-nav-resizable">
78 <div id="nav-tree">
79 <div id="nav-tree-contents">
80 <div id="nav-sync" class="sync"></div>
81 </div>
82 </div>
83 <div id="splitbar" style="-moz-user-select:none;"
84 class="ui-resizable-handle">
85 </div>
86 </div>
87 <script type="text/javascript">
88 $(document).ready(function(){initNavTree('php__propro_8h.html','');});
89 </script>
90 <div id="doc-content">
91 <!-- window showing the filter options -->
92 <div id="MSearchSelectWindow"
93 onmouseover="return searchBox.OnSearchSelectShow()"
94 onmouseout="return searchBox.OnSearchSelectHide()"
95 onkeydown="return searchBox.OnSearchSelectKey(event)">
96 </div>
97
98 <!-- iframe showing the search results (closed by default) -->
99 <div id="MSearchResultsWindow">
100 <iframe src="javascript:void(0)" frameborder="0"
101 name="MSearchResults" id="MSearchResults">
102 </iframe>
103 </div>
104
105 <div class="header">
106 <div class="summary">
107 <a href="#define-members">Macros</a> &#124;
108 <a href="#var-members">Variables</a> </div>
109 <div class="headertitle">
110 <div class="title">php_propro.h File Reference</div> </div>
111 </div><!--header-->
112 <div class="contents">
113 <div class="textblock"><div class="dynheader">
114 This graph shows which files directly or indirectly include this file:</div>
115 <div class="dyncontent">
116 <div class="center"><img src="php__propro_8h__dep__incl.png" border="0" usemap="#php__propro_8hdep" alt=""/></div>
117 <map name="php__propro_8hdep" id="php__propro_8hdep">
118 <area shape="rect" id="node2" href="php__propro__api_8h.html" title="src/php_propro_api.h" alt="" coords="5,80,148,107"/>
119 <area shape="rect" id="node3" href="php__propro__api_8c.html" title="src/php_propro_api.c" alt="" coords="5,155,148,181"/>
120 </map>
121 </div>
122 </div>
123 <p><a href="php__propro_8h_source.html">Go to the source code of this file.</a></p>
124 <table class="memberdecls">
125 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
126 Macros</h2></td></tr>
127 <tr class="memitem:a527bb084ce530a3b41b98f4258c331fb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__propro_8h.html#a527bb084ce530a3b41b98f4258c331fb">phpext_propro_ptr</a>&#160;&#160;&#160;&amp;<a class="el" href="php__propro__api_8c.html#a6f4859e8fe95ac4b9f3aac838590b32b">propro_module_entry</a></td></tr>
128 <tr class="separator:a527bb084ce530a3b41b98f4258c331fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
129 <tr class="memitem:adcf6a4b073e6a50ac89dda4c0e00de6f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__propro_8h.html#adcf6a4b073e6a50ac89dda4c0e00de6f">PHP_PROPRO_VERSION</a>&#160;&#160;&#160;&quot;2.0.0dev&quot;</td></tr>
130 <tr class="separator:adcf6a4b073e6a50ac89dda4c0e00de6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
131 <tr class="memitem:a2f9402fc8e099586c92779877100bcf5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__propro_8h.html#a2f9402fc8e099586c92779877100bcf5">PHP_PROPRO_API</a>&#160;&#160;&#160;extern</td></tr>
132 <tr class="separator:a2f9402fc8e099586c92779877100bcf5"><td class="memSeparator" colspan="2">&#160;</td></tr>
133 <tr class="memitem:ac8d6cffe226ac1780ce3f8eb68c0f08c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__propro_8h.html#ac8d6cffe226ac1780ce3f8eb68c0f08c">PHP_PROPRO_PTR</a>(zo)&#160;&#160;&#160;(void*)(((char*)(zo))-(zo)-&gt;handlers-&gt;offset)</td></tr>
134 <tr class="separator:ac8d6cffe226ac1780ce3f8eb68c0f08c"><td class="memSeparator" colspan="2">&#160;</td></tr>
135 </table><table class="memberdecls">
136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
137 Variables</h2></td></tr>
138 <tr class="memitem:a6f4859e8fe95ac4b9f3aac838590b32b"><td class="memItemLeft" align="right" valign="top">zend_module_entry&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__propro_8h.html#a6f4859e8fe95ac4b9f3aac838590b32b">propro_module_entry</a></td></tr>
139 <tr class="separator:a6f4859e8fe95ac4b9f3aac838590b32b"><td class="memSeparator" colspan="2">&#160;</td></tr>
140 </table>
141 <h2 class="groupheader">Macro Definition Documentation</h2>
142 <a class="anchor" id="a2f9402fc8e099586c92779877100bcf5"></a>
143 <div class="memitem">
144 <div class="memproto">
145 <table class="memname">
146 <tr>
147 <td class="memname">#define PHP_PROPRO_API&#160;&#160;&#160;extern</td>
148 </tr>
149 </table>
150 </div><div class="memdoc">
151
152 </div>
153 </div>
154 <a class="anchor" id="ac8d6cffe226ac1780ce3f8eb68c0f08c"></a>
155 <div class="memitem">
156 <div class="memproto">
157 <table class="memname">
158 <tr>
159 <td class="memname">#define PHP_PROPRO_PTR</td>
160 <td>(</td>
161 <td class="paramtype">&#160;</td>
162 <td class="paramname">zo</td><td>)</td>
163 <td>&#160;&#160;&#160;(void*)(((char*)(zo))-(zo)-&gt;handlers-&gt;offset)</td>
164 </tr>
165 </table>
166 </div><div class="memdoc">
167
168 </div>
169 </div>
170 <a class="anchor" id="adcf6a4b073e6a50ac89dda4c0e00de6f"></a>
171 <div class="memitem">
172 <div class="memproto">
173 <table class="memname">
174 <tr>
175 <td class="memname">#define PHP_PROPRO_VERSION&#160;&#160;&#160;&quot;2.0.0dev&quot;</td>
176 </tr>
177 </table>
178 </div><div class="memdoc">
179
180 <p>Referenced by <a class="el" href="php__propro__api_8c.html#accfdfddde541c2a3f9f670b1f6b2f88e">PHP_MINFO_FUNCTION()</a>.</p>
181
182 </div>
183 </div>
184 <a class="anchor" id="a527bb084ce530a3b41b98f4258c331fb"></a>
185 <div class="memitem">
186 <div class="memproto">
187 <table class="memname">
188 <tr>
189 <td class="memname">#define phpext_propro_ptr&#160;&#160;&#160;&amp;<a class="el" href="php__propro__api_8c.html#a6f4859e8fe95ac4b9f3aac838590b32b">propro_module_entry</a></td>
190 </tr>
191 </table>
192 </div><div class="memdoc">
193
194 </div>
195 </div>
196 <h2 class="groupheader">Variable Documentation</h2>
197 <a class="anchor" id="a6f4859e8fe95ac4b9f3aac838590b32b"></a>
198 <div class="memitem">
199 <div class="memproto">
200 <table class="memname">
201 <tr>
202 <td class="memname">zend_module_entry propro_module_entry</td>
203 </tr>
204 </table>
205 </div><div class="memdoc">
206
207 </div>
208 </div>
209 </div><!-- contents -->
210 </div><!-- doc-content -->
211 <!-- start footer part -->
212 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
213 <ul>
214 <li class="navelem"><a class="el" href="php__propro_8h.html">php_propro.h</a></li>
215 <li class="footer">Generated by
216 <a href="http://www.doxygen.org/index.html">
217 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.10 </li>
218 </ul>
219 </div>
220 </body>
221 </html>