<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.13"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>EditorConfig: editorconfig_handle.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtreedata.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectlogo"><img alt="Logo" src="logo.png"/></td> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">EditorConfig </div> <div id="projectbrief">Configuration file format for defining coding styles in shared projects.</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.13 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); </script> <div id="main-nav"></div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('editorconfig__handle_8h_source.html','');}); </script> <div id="doc-content"> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div class="header"> <div class="headertitle"> <div class="title">editorconfig_handle.h</div> </div> </div><!--header--> <div class="contents"> <a href="editorconfig__handle_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (c) 2011-2012 EditorConfig Team</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * All rights reserved.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * </span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Redistribution and use in source and binary forms, with or without</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * modification, are permitted provided that the following conditions are met:</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * </span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * 1. Redistributions of source code must retain the above copyright notice,</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * this list of conditions and the following disclaimer.</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright notice,</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * this list of conditions and the following disclaimer in the documentation</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * and/or other materials provided with the distribution.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * </span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * POSSIBILITY OF SUCH DAMAGE.</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> */</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#ifndef __EDITORCONFIG_EDITORCONFIG_HANDLE_H__</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#define __EDITORCONFIG_EDITORCONFIG_HANDLE_H__</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">/* When included from a user program, EDITORCONFIG_EXPORT may not be defined,</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * and we define it here*/</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#ifndef EDITORCONFIG_EXPORT</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor"># define EDITORCONFIG_EXPORT</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="editorconfig__handle_8h.html#a0c51d798e0e22051d0057a567245010c"> 50</a></span> <span class="keyword">typedef</span> <span class="keywordtype">void</span>* <a class="code" href="editorconfig__handle_8h.html#a0c51d798e0e22051d0057a567245010c">editorconfig_handle</a>;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> EDITORCONFIG_EXPORT</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> editorconfig_handle <a class="code" href="editorconfig__handle_8h.html#a8e3f1681e835a2946ba93b341ebc3dca">editorconfig_handle_init</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> EDITORCONFIG_EXPORT</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="keywordtype">int</span> <a class="code" href="editorconfig__handle_8h.html#add8960b396594d796843df56a6fd0cfe">editorconfig_handle_destroy</a>(editorconfig_handle h);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> EDITORCONFIG_EXPORT</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="editorconfig__handle_8h.html#ae0c5207a1986dfea2f641008ddefdd93">editorconfig_handle_get_err_file</a>(editorconfig_handle h);</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> EDITORCONFIG_EXPORT</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="keywordtype">void</span> <a class="code" href="editorconfig__handle_8h.html#ab54f0467f75b91cd17e2569f11c38c74">editorconfig_handle_get_version</a>(<span class="keyword">const</span> editorconfig_handle h, <span class="keywordtype">int</span>* major,</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keywordtype">int</span>* minor, <span class="keywordtype">int</span>* patch);</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> EDITORCONFIG_EXPORT</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="keywordtype">void</span> <a class="code" href="editorconfig__handle_8h.html#a4f0ce0493d8ef361387109ff3539eb9d">editorconfig_handle_set_version</a>(<span class="keyword">const</span> editorconfig_handle h, <span class="keywordtype">int</span> major,</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keywordtype">int</span> minor, <span class="keywordtype">int</span> patch);</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> EDITORCONFIG_EXPORT</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="keywordtype">void</span> <a class="code" href="editorconfig__handle_8h.html#a345fc52f7cc06dc8d35685ef4904013b">editorconfig_handle_set_conf_file_name</a>(editorconfig_handle h,</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* conf_file_name);</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> EDITORCONFIG_EXPORT</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="editorconfig__handle_8h.html#a5d8fd295880d6512751a7f3c840e3ce0">editorconfig_handle_get_conf_file_name</a>(<span class="keyword">const</span> editorconfig_handle h);</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> </div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> EDITORCONFIG_EXPORT</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="keywordtype">void</span> <a class="code" href="editorconfig__handle_8h.html#ad8330caee21b6aaacfa9fc95792b0389">editorconfig_handle_get_name_value</a>(<span class="keyword">const</span> editorconfig_handle h, <span class="keywordtype">int</span> n,</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>** name, <span class="keyword">const</span> <span class="keywordtype">char</span>** value);</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> </div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> EDITORCONFIG_EXPORT</div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="keywordtype">int</span> <a class="code" href="editorconfig__handle_8h.html#a5a589c0471ca6651d09823595ddd3ea2">editorconfig_handle_get_name_value_count</a>(<span class="keyword">const</span> editorconfig_handle h);</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> </div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> }</div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> </div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="preprocessor">#endif </span><span class="comment">/* !__EDITORCONFIG_EDITORCONFIG_HANDLE_H__ */</span><span class="preprocessor"></span></div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> </div><div class="ttc" id="editorconfig__handle_8h_html_a5d8fd295880d6512751a7f3c840e3ce0"><div class="ttname"><a href="editorconfig__handle_8h.html#a5d8fd295880d6512751a7f3c840e3ce0">editorconfig_handle_get_conf_file_name</a></div><div class="ttdeci">const char * editorconfig_handle_get_conf_file_name(const editorconfig_handle h)</div><div class="ttdoc">Get the conf_file_name field of an editorconfig_handle object. </div></div> <div class="ttc" id="editorconfig__handle_8h_html_add8960b396594d796843df56a6fd0cfe"><div class="ttname"><a href="editorconfig__handle_8h.html#add8960b396594d796843df56a6fd0cfe">editorconfig_handle_destroy</a></div><div class="ttdeci">int editorconfig_handle_destroy(editorconfig_handle h)</div><div class="ttdoc">Destroy an editorconfig_handle object. </div></div> <div class="ttc" id="editorconfig__handle_8h_html_a0c51d798e0e22051d0057a567245010c"><div class="ttname"><a href="editorconfig__handle_8h.html#a0c51d798e0e22051d0057a567245010c">editorconfig_handle</a></div><div class="ttdeci">void * editorconfig_handle</div><div class="ttdoc">The editorconfig handle object type. </div><div class="ttdef"><b>Definition:</b> editorconfig_handle.h:50</div></div> <div class="ttc" id="editorconfig__handle_8h_html_a345fc52f7cc06dc8d35685ef4904013b"><div class="ttname"><a href="editorconfig__handle_8h.html#a345fc52f7cc06dc8d35685ef4904013b">editorconfig_handle_set_conf_file_name</a></div><div class="ttdeci">void editorconfig_handle_set_conf_file_name(editorconfig_handle h, const char *conf_file_name)</div><div class="ttdoc">Set the conf_file_name field of an editorconfig_handle object. </div></div> <div class="ttc" id="editorconfig__handle_8h_html_a4f0ce0493d8ef361387109ff3539eb9d"><div class="ttname"><a href="editorconfig__handle_8h.html#a4f0ce0493d8ef361387109ff3539eb9d">editorconfig_handle_set_version</a></div><div class="ttdeci">void editorconfig_handle_set_version(const editorconfig_handle h, int major, int minor, int patch)</div><div class="ttdoc">Set the version fields of an editorconfig_handle object. </div></div> <div class="ttc" id="editorconfig__handle_8h_html_a5a589c0471ca6651d09823595ddd3ea2"><div class="ttname"><a href="editorconfig__handle_8h.html#a5a589c0471ca6651d09823595ddd3ea2">editorconfig_handle_get_name_value_count</a></div><div class="ttdeci">int editorconfig_handle_get_name_value_count(const editorconfig_handle h)</div><div class="ttdoc">Get the count of name and value fields of an editorconfig_handle object. </div></div> <div class="ttc" id="editorconfig__handle_8h_html_ae0c5207a1986dfea2f641008ddefdd93"><div class="ttname"><a href="editorconfig__handle_8h.html#ae0c5207a1986dfea2f641008ddefdd93">editorconfig_handle_get_err_file</a></div><div class="ttdeci">const char * editorconfig_handle_get_err_file(editorconfig_handle h)</div><div class="ttdoc">Get the err_file field of an editorconfig_handle object. </div></div> <div class="ttc" id="editorconfig__handle_8h_html_a8e3f1681e835a2946ba93b341ebc3dca"><div class="ttname"><a href="editorconfig__handle_8h.html#a8e3f1681e835a2946ba93b341ebc3dca">editorconfig_handle_init</a></div><div class="ttdeci">editorconfig_handle editorconfig_handle_init(void)</div><div class="ttdoc">Create and intialize a default editorconfig_handle object. </div></div> <div class="ttc" id="editorconfig__handle_8h_html_ab54f0467f75b91cd17e2569f11c38c74"><div class="ttname"><a href="editorconfig__handle_8h.html#ab54f0467f75b91cd17e2569f11c38c74">editorconfig_handle_get_version</a></div><div class="ttdeci">void editorconfig_handle_get_version(const editorconfig_handle h, int *major, int *minor, int *patch)</div><div class="ttdoc">Get the version fields of an editorconfig_handle object. </div></div> <div class="ttc" id="editorconfig__handle_8h_html_ad8330caee21b6aaacfa9fc95792b0389"><div class="ttname"><a href="editorconfig__handle_8h.html#ad8330caee21b6aaacfa9fc95792b0389">editorconfig_handle_get_name_value</a></div><div class="ttdeci">void editorconfig_handle_get_name_value(const editorconfig_handle h, int n, const char **name, const char **value)</div><div class="ttdoc">Get the nth name and value fields of an editorconfig_handle object. </div></div> </div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_97a02d125655f590b2920fe29957f8f2.html">editorconfig</a></li><li class="navelem"><a class="el" href="editorconfig__handle_8h.html">editorconfig_handle.h</a></li> <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> </ul> </div> </body> </html>